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 lib/trackdb.c
21 * @brief Track database
23 * This file is getting in desparate need of splitting up...
32 #include <sys/socket.h>
39 #include <sys/resource.h>
41 #include <arpa/inet.h>
54 #include "configuration.h"
59 #include "trackname.h"
60 #include "trackdb-int.h"
69 #define RESCAN "disorder-rescan"
70 #define DEADLOCK "disorder-deadlock"
72 static const char *getpart(const char *track
,
77 static char **trackdb_new_tid(int *ntracksp
,
80 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
81 static char *normalize_tag(const char *s
, size_t ns
);
83 const struct cache_type cache_files_type
= { 86400 };
84 unsigned long cache_files_hits
, cache_files_misses
;
86 /** @brief Set by trackdb_open() */
87 int trackdb_existing_database
;
89 /* setup and teardown ********************************************************/
91 static const char *home
; /* home had better not change */
92 DB_ENV
*trackdb_env
; /* db environment */
94 /** @brief The tracks database
95 * - Keys are UTF-8(NFC(unicode(path name)))
96 * - Values are encoded key-value pairs
97 * - Data is reconstructable data about tracks that currently exist
101 /** @brief The preferences database
103 * - Keys are UTF-8(NFC(unicode(path name)))
104 * - Values are encoded key-value pairs
105 * - Data is user data about tracks (that might not exist any more)
106 * and cannot be reconstructed
110 /** @brief The search database
112 * - Keys are UTF-8(NFKC(casefold(search term)))
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 search terms
116 * - Only tracks fond in @ref trackdb_tracksdb are represented here
117 * - This database can be reconstructed, it contains no user data
119 DB
*trackdb_searchdb
;
121 /** @brief The tags database
123 * - Keys are UTF-8(NFKC(casefold(tag)))
124 * - Values are UTF-8(NFC(unicode(path name)))
125 * - There can be more than one value per key
126 * - Presence of key,value means that path matches the tag
127 * - This is always in sync with the tags preference
128 * - This database can be reconstructed, it contains no user data
130 DB
*trackdb_tagsdb
; /* the tags database */
132 /** @brief The global preferences database
133 * - Keys are UTF-8(NFC(preference))
134 * - Values are global preference values
135 * - Data is user data and cannot be reconstructed
137 DB
*trackdb_globaldb
; /* global preferences */
139 /** @brief The noticed database
140 * - Keys are 64-bit big-endian timestamps
141 * - Values are UTF-8(NFC(unicode(path name)))
142 * - There can be more than one value per key
143 * - Presence of key,value means that path was added at the given time
144 * - Data cannot be reconstructed (but isn't THAT important)
146 DB
*trackdb_noticeddb
; /* when track noticed */
148 /** @brief The user database
149 * - Keys are usernames
150 * - Values are encoded key-value pairs
151 * - Data is user data and cannot be reconstructed
155 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
156 static pid_t rescan_pid
= -1; /* rescanner PID */
157 static int initialized
, opened
; /* state */
159 /* tracks matched by required_tags */
160 static char **reqtracks
;
161 static size_t nreqtracks
;
163 /* comparison function for keys */
164 static int compare(DB
attribute((unused
)) *db_
,
165 const DBT
*a
, const DBT
*b
) {
166 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
169 /** @brief Open database environment
170 * @param flags Flags word
172 * Flags should be one of:
173 * - @ref TRACKDB_NO_RECOVER
174 * - @ref TRACKDB_NORMAL_RECOVER
175 * - @ref TRACKDB_FATAL_RECOVER
176 * - @ref TRACKDB_MAY_CREATE
178 void trackdb_init(int flags
) {
180 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
181 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
184 assert(initialized
== 0);
187 if(strcmp(home
, config
->home
))
188 fatal(0, "cannot change db home without server restart");
192 if(flags
& TRACKDB_MAY_CREATE
) {
198 /* Remove world/group permissions on any regular files already in the
199 * database directory. Actually we don't care about all of them but it's
200 * easier to just do the lot. This can be revisited if it's a serious
201 * practical inconvenience for anyone.
203 * The socket, not being a regular file, is excepted.
205 if(!(dp
= opendir(config
->home
)))
206 fatal(errno
, "error reading %s", config
->home
);
207 while((de
= readdir(dp
))) {
208 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
209 if(lstat(p
, &st
) == 0
210 && S_ISREG(st
.st_mode
)
211 && (st
.st_mode
& 077)) {
212 if(chmod(p
, st
.st_mode
& 07700) < 0)
213 fatal(errno
, "cannot chmod %s", p
);
220 /* create environment */
221 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
223 if((err
= trackdb_env
->set_alloc(trackdb_env
,
224 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
225 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
226 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
227 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
228 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
229 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
230 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
236 |recover_type
[recover
],
238 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
239 trackdb_env
->set_errpfx(trackdb_env
, "DB");
240 trackdb_env
->set_errfile(trackdb_env
, stderr
);
241 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
242 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
243 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
244 D(("initialized database environment"));
247 /* called when deadlock manager terminates */
248 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
249 pid_t
attribute((unused
)) pid
,
251 const struct rusage
attribute((unused
)) *rusage
,
252 void attribute((unused
)) *u
) {
253 db_deadlock_pid
= -1;
255 fatal(0, "deadlock manager unexpectedly terminated: %s",
258 D(("deadlock manager terminated: %s", wstat(status
)));
262 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
266 const char *args
[1024], **argp
, *a
;
270 *argp
++ = "--config";
271 *argp
++ = configfile
;
272 *argp
++ = debugging ?
"--debug" : "--no-debug";
273 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
275 while((a
= va_arg(ap
, const char *)))
279 /* If we're in the background then trap subprocess stdout/stderr */
280 if(!(pid
= xfork())) {
283 ev_signal_atfork(ev
);
284 signal(SIGPIPE
, SIG_DFL
);
289 /* ensure we don't leak privilege anywhere */
290 if(setuid(geteuid()) < 0)
291 fatal(errno
, "error calling setuid");
292 /* If we were negatively niced, undo it. We don't bother checking for
293 * error, it's not that important. */
294 setpriority(PRIO_PROCESS
, 0, 0);
295 execvp(prog
, (char **)args
);
296 fatal(errno
, "error invoking %s", prog
);
301 /* start deadlock manager */
302 void trackdb_master(ev_source
*ev
) {
303 assert(db_deadlock_pid
== -1);
304 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
305 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
306 D(("started deadlock manager"));
309 /* close environment */
310 void trackdb_deinit(void) {
314 assert(initialized
== 1);
317 /* close the environment */
318 if((err
= trackdb_env
->close(trackdb_env
, 0)))
319 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
321 if(rescan_pid
!= -1 && kill(rescan_pid
, SIGTERM
) < 0)
322 fatal(errno
, "error killing rescanner");
324 /* terminate the deadlock manager */
325 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
326 fatal(errno
, "error killing deadlock manager");
327 db_deadlock_pid
= -1;
329 D(("deinitialized database environment"));
332 /* open a specific database */
333 static DB
*open_db(const char *path
,
341 D(("open %s", path
));
342 path
= config_get_file(path
);
343 if((err
= db_create(&db
, trackdb_env
, 0)))
344 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
346 if((err
= db
->set_flags(db
, dbflags
)))
347 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
348 if(dbtype
== DB_BTREE
)
349 if((err
= db
->set_bt_compare(db
, compare
)))
350 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
351 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
352 openflags
| DB_AUTO_COMMIT
, mode
))) {
353 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
354 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
361 /** @brief Open track databases
362 * @param flags Flags flags word
364 * @p flags should have one of:
365 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
366 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
367 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
369 * - @p TRACKDB_READ_ONLY, read only access
371 void trackdb_open(int flags
) {
374 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
379 /* check the database version first */
380 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
381 if(trackdb_globaldb
) {
382 /* This is an existing database */
386 s
= trackdb_get_global("_dbversion");
387 /* Close the database again, we'll open it property below */
388 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
389 fatal(0, "error closing global.db: %s", db_strerror(err
));
390 trackdb_globaldb
= 0;
391 /* Convert version string to an integer */
392 oldversion
= s ?
atol(s
) : 1;
393 if(oldversion
> config
->dbversion
) {
394 /* Database is from the future; we never allow this. */
395 fatal(0, "this version of DisOrder is too old for database version %ld",
398 if(oldversion
< config
->dbversion
) {
399 /* Database version is out of date */
400 switch(flags
& TRACKDB_UPGRADE_MASK
) {
401 case TRACKDB_NO_UPGRADE
:
402 /* This database needs upgrading but this is not permitted */
403 fatal(0, "database needs upgrading from %ld to %ld",
404 oldversion
, config
->dbversion
);
405 case TRACKDB_CAN_UPGRADE
:
406 /* This database needs upgrading */
407 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
408 oldversion
, config
->dbversion
);
409 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
410 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
413 fatal(0, "disorder-dbupgrade %s", wstat(err
));
414 info("disorder-dbupgrade succeeded");
416 case TRACKDB_OPEN_FOR_UPGRADE
:
422 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
423 /* This doesn't make any sense */
424 fatal(0, "database is already at current version");
426 trackdb_existing_database
= 1;
428 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
429 /* Cannot upgrade a new database */
430 fatal(0, "cannot upgrade a database that does not exist");
432 /* This is a brand new database */
433 trackdb_existing_database
= 0;
435 /* open the databases */
436 trackdb_tracksdb
= open_db("tracks.db",
437 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
438 trackdb_searchdb
= open_db("search.db",
439 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
440 trackdb_tagsdb
= open_db("tags.db",
441 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
442 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
443 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
444 trackdb_noticeddb
= open_db("noticed.db",
445 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
446 trackdb_usersdb
= open_db("users.db",
447 0, DB_HASH
, dbflags
, 0600);
448 if(!trackdb_existing_database
) {
449 /* Stash the database version */
452 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
453 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
454 trackdb_set_global("_dbversion", buf
, 0);
456 D(("opened databases"));
459 /* close track databases */
460 void trackdb_close(void) {
466 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
467 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
468 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
469 fatal(0, "error closing search.db: %s", db_strerror(err
));
470 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
471 fatal(0, "error closing tags.db: %s", db_strerror(err
));
472 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
473 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
474 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
475 fatal(0, "error closing global.db: %s", db_strerror(err
));
476 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
477 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
478 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
479 fatal(0, "error closing users.db: %s", db_strerror(err
));
480 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
481 trackdb_tagsdb
= trackdb_globaldb
= 0;
482 D(("closed databases"));
485 /* generic db routines *******************************************************/
487 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
488 * DB_LOCK_DEADLOCK. */
489 int trackdb_getdata(DB
*db
,
496 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
497 prepare_data(&data
), 0)) {
499 *kp
= kvp_urldecode(data
.data
, data
.size
);
504 case DB_LOCK_DEADLOCK
:
505 error(0, "error querying database: %s", db_strerror(err
));
508 fatal(0, "error querying database: %s", db_strerror(err
));
512 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
513 * DB_LOCK_DEADLOCK. */
514 int trackdb_putdata(DB
*db
,
522 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
523 encode_data(&data
, k
), flags
)) {
527 case DB_LOCK_DEADLOCK
:
528 error(0, "error updating database: %s", db_strerror(err
));
531 fatal(0, "error updating database: %s", db_strerror(err
));
535 /** @brief Delete a database entry
537 * @param track Key to delete
538 * @param tid Transaction ID
539 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
541 int trackdb_delkey(DB
*db
,
547 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
551 case DB_LOCK_DEADLOCK
:
552 error(0, "error updating database: %s", db_strerror(err
));
555 fatal(0, "error updating database: %s", db_strerror(err
));
559 /* open a database cursor */
560 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
564 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
566 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
571 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
572 int trackdb_closecursor(DBC
*c
) {
576 switch(err
= c
->c_close(c
)) {
579 case DB_LOCK_DEADLOCK
:
580 error(0, "error closing cursor: %s", db_strerror(err
));
583 fatal(0, "error closing cursor: %s", db_strerror(err
));
587 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
588 int trackdb_delkeydata(DB
*db
,
596 c
= trackdb_opencursor(db
, tid
);
597 switch(err
= c
->c_get(c
, make_key(&key
, word
),
598 make_key(&data
, track
), DB_GET_BOTH
)) {
600 switch(err
= c
->c_del(c
, 0)) {
606 case DB_LOCK_DEADLOCK
:
607 error(0, "error updating database: %s", db_strerror(err
));
610 fatal(0, "c->c_del: %s", db_strerror(err
));
615 case DB_LOCK_DEADLOCK
:
616 error(0, "error updating database: %s", db_strerror(err
));
619 fatal(0, "c->c_get: %s", db_strerror(err
));
621 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
625 /* start a transaction */
626 DB_TXN
*trackdb_begin_transaction(void) {
630 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
631 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
635 /* abort transaction */
636 void trackdb_abort_transaction(DB_TXN
*tid
) {
640 if((err
= tid
->abort(tid
)))
641 fatal(0, "tid->abort: %s", db_strerror(err
));
644 /* commit transaction */
645 void trackdb_commit_transaction(DB_TXN
*tid
) {
648 if((err
= tid
->commit(tid
, 0)))
649 fatal(0, "tid->commit: %s", db_strerror(err
));
652 /* search/tags shared code ***************************************************/
654 /* comparison function used by dedupe() */
655 static int wordcmp(const void *a
, const void *b
) {
656 return strcmp(*(const char **)a
, *(const char **)b
);
659 /* sort and de-dupe VEC */
660 static char **dedupe(char **vec
, int nvec
) {
663 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
667 for(n
= 1; n
< nvec
; ++n
)
668 if(strcmp(vec
[n
], vec
[m
- 1]))
675 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
676 static int register_word(DB
*db
, const char *what
,
677 const char *track
, const char *word
,
682 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
683 make_key(&data
, track
), DB_NODUPDATA
)) {
687 case DB_LOCK_DEADLOCK
:
688 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
691 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
695 /* search primitives *********************************************************/
697 /* return true iff NAME is a trackname_display_ pref */
698 static int is_display_pref(const char *name
) {
699 static const char prefix
[] = "trackname_display_";
700 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
703 /** @brief Word_Break property tailor that treats underscores as spaces */
704 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
708 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
709 return unicode_Word_Break_Other
;
713 /** @brief Remove all combining characters in-place
714 * @param s Pointer to start of string
715 * @param ns Length of string
716 * @return New, possiblby reduced, length
718 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
719 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
722 const uint32_t c
= *s
++;
723 if(!utf32_combining_class(c
))
729 /** @brief Normalize and split a string using a given tailoring */
730 static void word_split(struct vector
*v
,
732 unicode_property_tailor
*pt
) {
734 uint32_t *t32
, **w32
;
736 /* Convert to UTF-32 */
737 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
739 /* Erase case distinctions */
740 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
742 /* Drop combining characters */
743 nt32
= remove_combining_chars(t32
, nt32
);
744 /* Split into words, treating _ as a space */
745 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
746 /* Convert words back to UTF-8 and append to result */
747 for(i
= 0; i
< nw
; ++i
)
748 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
751 /** @brief Normalize a tag
753 * @param ns Length of tag
754 * @return Normalized string or NULL on error
756 * The return value will be:
758 * - have no leading or trailing space
759 * - have no combining characters
760 * - all spacing between words will be a single U+0020 SPACE
762 static char *normalize_tag(const char *s
, size_t ns
) {
763 uint32_t *s32
, **w32
;
764 size_t ns32
, nw32
, i
;
767 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
769 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
771 ns32
= remove_combining_chars(s32
, ns32
);
772 /* Split into words, no Word_Break tailoring */
773 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
774 /* Compose back into a string */
776 for(i
= 0; i
< nw32
; ++i
) {
778 dynstr_append(d
, ' ');
779 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
785 /* compute the words of a track name */
786 static char **track_to_words(const char *track
,
787 const struct kvp
*p
) {
789 const char *rootless
= track_rootless(track
);
792 rootless
= track
; /* bodge */
794 rootless
= strip_extension(rootless
);
795 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
796 for(; p
; p
= p
->next
)
797 if(is_display_pref(p
->name
))
798 word_split(&v
, p
->value
, 0);
799 vector_terminate(&v
);
800 return dedupe(v
.vec
, v
.nvec
);
803 /* return nonzero iff WORD is a stopword */
804 static int stopword(const char *word
) {
807 for(n
= 0; n
< config
->stopword
.n
808 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
810 return n
< config
->stopword
.n
;
813 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
814 static int register_search_word(const char *track
, const char *word
,
816 if(stopword(word
)) return 0;
817 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
820 /* Tags **********************************************************************/
822 /* Return nonzero if C is a valid tag character */
823 static int tagchar(int c
) {
832 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
833 static char **parsetags(const char *s
) {
839 /* skip initial separators */
840 while(*s
&& (!tagchar(*s
) || *s
== ' '))
843 /* find the extent of the tag */
845 while(*s
&& tagchar(*s
))
847 /* strip trailing spaces */
848 while(s
> t
&& s
[-1] == ' ')
850 /* add tag to list */
851 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
852 /* skip intermediate and trailing separators */
853 while(*s
&& (!tagchar(*s
) || *s
== ' '))
857 vector_terminate(&v
);
858 return dedupe(v
.vec
, v
.nvec
);
861 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
862 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
863 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
866 /* aliases *******************************************************************/
868 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
869 * there is no alias sets *aliasp to 0. */
870 static int compute_alias(char **aliasp
,
875 const char *s
= config
->alias
, *t
, *expansion
, *part
;
876 int c
, used_db
= 0, slash_prefix
, err
;
878 const char *const root
= find_track_root(track
);
881 /* Bodge for tracks with no root */
886 dynstr_append_string(&d
, root
);
887 while((c
= (unsigned char)*s
++)) {
889 dynstr_append(&d
, c
);
892 if((slash_prefix
= (*s
== '/')))
895 assert(t
!= 0); /* validated at startup */
896 part
= xstrndup(s
, t
- s
);
897 expansion
= getpart(track
, "display", part
, p
, &used_db
);
899 if(slash_prefix
) dynstr_append(&d
, '/');
900 dynstr_append_string(&d
, expansion
);
902 s
= t
+ 1; /* skip {part} */
904 /* only admit to the alias if we used the db... */
909 dynstr_terminate(&d
);
910 /* ...and the answer differs from the original... */
911 if(!strcmp(track
, d
.vec
)) {
915 /* ...and there isn't already a different track with that name (including as
917 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
919 if((s
= kvp_get(at
, "_alias_for"))
920 && !strcmp(s
, track
)) {
932 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
933 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
934 * Always sets the return values, even if only to null pointers. */
935 static int gettrackdata(const char *track
,
938 const char **actualp
,
940 #define GTD_NOALIAS 0x0001
943 const char *actual
= track
;
944 struct kvp
*t
= 0, *p
= 0;
946 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
947 if((actual
= kvp_get(t
, "_alias_for"))) {
948 if(flags
& GTD_NOALIAS
) {
949 error(0, "alias passed to gettrackdata where real path required");
952 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
957 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
962 if(actualp
) *actualp
= actual
;
968 /* trackdb_notice() **********************************************************/
970 /** @brief notice a possibly new track
971 * @return @c DB_NOTFOUND if new, 0 if already known
973 int trackdb_notice(const char *track
,
979 tid
= trackdb_begin_transaction();
980 err
= trackdb_notice_tid(track
, path
, tid
);
981 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
984 trackdb_abort_transaction(tid
);
986 trackdb_commit_transaction(tid
);
990 /** @brief notice a possibly new track
991 * @param track NFC UTF-8 track name
992 * @param path Raw path name
993 * @param tid Transaction ID
994 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
996 int trackdb_notice_tid(const char *track
,
1000 struct kvp
*t
, *a
, *p
;
1004 /* notice whether the tracks.db entry changes */
1006 /* get any existing tracks entry */
1007 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1009 ret
= err
; /* 0 or DB_NOTFOUND */
1010 /* this is a real track */
1011 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1012 t_changed
+= kvp_set(&t
, "_path", path
);
1013 /* if we have an alias record it in the database */
1014 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1016 /* won't overwrite someone else's alias as compute_alias() checks */
1017 D(("%s: alias %s", track
, alias
));
1019 kvp_set(&a
, "_alias_for", track
);
1020 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1022 /* update search.db */
1023 w
= track_to_words(track
, p
);
1024 for(n
= 0; w
[n
]; ++n
)
1025 if((err
= register_search_word(track
, w
[n
], tid
)))
1027 /* update tags.db */
1028 w
= parsetags(kvp_get(p
, "tags"));
1029 for(n
= 0; w
[n
]; ++n
)
1030 if((err
= register_tag(track
, w
[n
], tid
)))
1033 /* only store the tracks.db entry if it has changed */
1034 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1036 if(ret
== DB_NOTFOUND
) {
1037 uint32_t timestamp
[2];
1042 timestamp
[0] = htonl((uint64_t)now
>> 32);
1043 timestamp
[1] = htonl((uint32_t)now
);
1044 memset(&key
, 0, sizeof key
);
1045 key
.data
= timestamp
;
1046 key
.size
= sizeof timestamp
;
1047 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1048 make_key(&data
, track
), 0)) {
1050 case DB_LOCK_DEADLOCK
: return err
;
1051 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1057 /* trackdb_obsolete() ********************************************************/
1059 /* obsolete a track */
1060 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1065 if((err
= gettrackdata(track
, 0, &p
, 0,
1066 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1068 else if(err
== DB_NOTFOUND
) return 0;
1069 /* compute the alias, if any, and delete it */
1070 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1072 /* if the alias points to some other track then compute_alias won't
1074 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1075 && err
!= DB_NOTFOUND
)
1078 /* update search.db */
1079 w
= track_to_words(track
, p
);
1080 for(n
= 0; w
[n
]; ++n
)
1081 if(trackdb_delkeydata(trackdb_searchdb
,
1082 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1084 /* update tags.db */
1085 w
= parsetags(kvp_get(p
, "tags"));
1086 for(n
= 0; w
[n
]; ++n
)
1087 if(trackdb_delkeydata(trackdb_tagsdb
,
1088 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1091 /* update tracks.db */
1092 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1094 /* We don't delete the prefs, so they survive temporary outages of the
1095 * (possibly virtual) track filesystem */
1099 /* trackdb_stats() ***********************************************************/
1101 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1102 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1104 static const struct statinfo
{
1107 } statinfo_hash
[] = {
1123 }, statinfo_btree
[] = {
1144 /* look up stats for DB */
1145 static int get_stats(struct vector
*v
,
1147 const struct statinfo
*si
,
1156 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1159 case DB_LOCK_DEADLOCK
:
1160 error(0, "error querying database: %s", db_strerror(err
));
1163 fatal(0, "error querying database: %s", db_strerror(err
));
1165 for(n
= 0; n
< nsi
; ++n
) {
1166 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1167 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1168 vector_append(v
, str
);
1174 /** @brief One entry in the search league */
1175 struct search_entry
{
1180 /** @brief Add a word to the search league
1181 * @param se Pointer to search league
1182 * @param count Maximum size for search league
1183 * @param nse Current size of search league
1184 * @param word New word, or NULL
1185 * @param n How often @p word appears
1186 * @return New size of search league
1188 static int register_search_entry(struct search_entry
*se
,
1195 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1196 /* Find the starting point */
1201 /* Find the insertion point */
1202 while(i
> 0 && n
> se
[i
- 1].n
)
1204 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1211 /* find the top COUNT words in the search database */
1212 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1213 struct search_entry
*se
;
1216 int err
, n
= 0, nse
= 0, i
;
1221 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1222 se
= xmalloc(count
* sizeof *se
);
1223 /* Walk across the whole database counting up the number of times each
1225 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1227 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1228 ++n
; /* same word again */
1230 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1231 word
= xstrndup(k
.data
, wl
= k
.size
);
1239 case DB_LOCK_DEADLOCK
:
1240 error(0, "error querying search database: %s", db_strerror(err
));
1243 fatal(0, "error querying search database: %s", db_strerror(err
));
1245 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1247 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1248 byte_xasprintf(&str
, "Top %d search words:", nse
);
1249 vector_append(v
, str
);
1250 for(i
= 0; i
< nse
; ++i
) {
1251 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1252 vector_append(v
, str
);
1257 #define SI(what) statinfo_##what, \
1258 sizeof statinfo_##what / sizeof (struct statinfo)
1260 /* return a list of database stats */
1261 char **trackdb_stats(int *nstatsp
) {
1267 tid
= trackdb_begin_transaction();
1269 vector_append(&v
, (char *)"Tracks database stats:");
1270 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1271 vector_append(&v
, (char *)"");
1272 vector_append(&v
, (char *)"Search database stats:");
1273 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1274 vector_append(&v
, (char *)"");
1275 vector_append(&v
, (char *)"Prefs database stats:");
1276 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1277 vector_append(&v
, (char *)"");
1278 if(search_league(&v
, 10, tid
)) goto fail
;
1279 vector_terminate(&v
);
1282 trackdb_abort_transaction(tid
);
1284 trackdb_commit_transaction(tid
);
1285 if(nstatsp
) *nstatsp
= v
.nvec
;
1289 struct stats_details
{
1290 void (*done
)(char *data
, void *u
);
1292 int exited
; /* subprocess exited */
1293 int closed
; /* pipe close */
1294 int wstat
; /* wait status from subprocess */
1295 struct dynstr data
[1]; /* data read from pipe */
1298 static void stats_complete(struct stats_details
*d
) {
1301 if(!(d
->exited
&& d
->closed
))
1303 byte_xasprintf(&s
, "\n"
1305 "track lookup cache hits: %lu\n"
1306 "track lookup cache misses: %lu\n",
1308 cache_files_misses
);
1309 dynstr_append_string(d
->data
, s
);
1310 dynstr_terminate(d
->data
);
1311 d
->done(d
->data
->vec
, d
->u
);
1314 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1315 pid_t
attribute((unused
)) pid
,
1317 const struct rusage
attribute((unused
)) *rusage
,
1319 struct stats_details
*const d
= u
;
1323 error(0, "disorder-stats %s", wstat(status
));
1328 static int stats_read(ev_source
attribute((unused
)) *ev
,
1334 struct stats_details
*const d
= u
;
1336 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1337 ev_reader_consume(reader
, bytes
);
1344 static int stats_error(ev_source
attribute((unused
)) *ev
,
1347 struct stats_details
*const d
= u
;
1349 error(errno_value
, "error reading from pipe to disorder-stats");
1355 void trackdb_stats_subprocess(ev_source
*ev
,
1356 void (*done
)(char *data
, void *u
),
1360 struct stats_details
*d
= xmalloc(sizeof *d
);
1362 dynstr_init(d
->data
);
1366 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1368 ev_child(ev
, pid
, 0, stats_finished
, d
);
1369 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1372 /* set a pref (remove if value=0) */
1373 int trackdb_set(const char *track
,
1375 const char *value
) {
1376 struct kvp
*t
, *p
, *a
;
1379 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1382 /* TODO: if value matches default then set value=0 */
1386 tid
= trackdb_begin_transaction();
1387 if((err
= gettrackdata(track
, &t
, &p
, 0,
1388 0, tid
)) == DB_LOCK_DEADLOCK
)
1390 if(err
== DB_NOTFOUND
) break;
1391 if(name
[0] == '_') {
1392 if(kvp_set(&t
, name
, value
))
1393 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1396 /* get the old alias name */
1397 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1398 /* get the old tags */
1399 if(!strcmp(name
, "tags"))
1400 oldtags
= parsetags(kvp_get(p
, "tags"));
1402 if(kvp_set(&p
, name
, value
))
1403 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1405 /* compute the new alias name */
1406 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1407 /* check whether alias has changed */
1408 if(!(oldalias
== newalias
1409 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1410 /* adjust alias records to fit change */
1412 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1416 kvp_set(&a
, "_alias_for", track
);
1417 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1420 /* check whether tags have changed */
1421 if(!strcmp(name
, "tags")) {
1422 newtags
= parsetags(value
);
1423 while(*oldtags
|| *newtags
) {
1424 if(*oldtags
&& *newtags
) {
1425 cmp
= strcmp(*oldtags
, *newtags
);
1427 /* keeping this tag */
1431 /* old tag fits into a gap in the new list, so delete old */
1434 /* new tag fits into a gap in the old list, so insert new */
1436 } else if(*oldtags
) {
1437 /* we've run out of new tags, so remaining old ones are to be
1440 if(trackdb_delkeydata(trackdb_tagsdb
,
1441 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1445 /* we've run out of old tags, so remainig new ones are to be
1448 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1458 trackdb_abort_transaction(tid
);
1460 trackdb_commit_transaction(tid
);
1461 return err
== 0 ?
0 : -1;
1465 const char *trackdb_get(const char *track
,
1467 return kvp_get(trackdb_get_all(track
), name
);
1470 /* get all prefs as a 0-terminated array */
1471 struct kvp
*trackdb_get_all(const char *track
) {
1472 struct kvp
*t
, *p
, **pp
;
1476 tid
= trackdb_begin_transaction();
1477 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1481 trackdb_abort_transaction(tid
);
1483 trackdb_commit_transaction(tid
);
1484 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1491 const char *trackdb_resolve(const char *track
) {
1496 tid
= trackdb_begin_transaction();
1497 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1501 trackdb_abort_transaction(tid
);
1503 trackdb_commit_transaction(tid
);
1507 int trackdb_isalias(const char *track
) {
1508 const char *actual
= trackdb_resolve(track
);
1510 return strcmp(actual
, track
);
1513 /* test whether a track exists (perhaps an alias) */
1514 int trackdb_exists(const char *track
) {
1519 tid
= trackdb_begin_transaction();
1520 /* unusually, here we want the return value */
1521 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1525 trackdb_abort_transaction(tid
);
1527 trackdb_commit_transaction(tid
);
1531 /* return the list of tags */
1532 char **trackdb_alltags(void) {
1537 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1541 /** @brief List all the keys in @p db
1542 * @param db Database
1543 * @param v Vector to store keys in
1544 * @param tid Transaction ID
1545 * @return 0 or DB_LOCK_DEADLOCK
1547 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1550 DBC
*const c
= trackdb_opencursor(db
, tid
);
1553 memset(&k
, 0, sizeof k
);
1554 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1555 vector_append(v
, xstrndup(k
.data
, k
.size
));
1559 case DB_LOCK_DEADLOCK
:
1562 fatal(0, "c->c_get: %s", db_strerror(e
));
1564 if((e
= trackdb_closecursor(c
)))
1566 vector_terminate(v
);
1570 /* return 1 iff sorted tag lists A and B have at least one member in common */
1571 static int tag_intersection(char **a
, char **b
) {
1574 /* Same sort of logic as trackdb_set() above */
1576 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1577 else if(cmp
< 0) ++a
;
1583 /* Check whether a track is suitable for random play. Returns 0 if it is,
1584 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1586 static int check_suitable(const char *track
,
1588 char **required_tags
,
1589 char **prohibited_tags
) {
1593 const char *pick_at_random
, *played_time
;
1595 /* don't pick tracks that aren't in any surviving collection (for instance
1596 * you've edited the config but the rescan hasn't done its job yet) */
1597 if(!find_track_root(track
)) {
1598 info("found track not in any collection: %s", track
);
1601 /* don't pick aliases - only pick the canonical form */
1602 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1603 return DB_LOCK_DEADLOCK
;
1604 if(kvp_get(t
, "_alias_for"))
1606 /* check that random play is not suppressed for this track */
1607 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1608 && !strcmp(pick_at_random
, "0"))
1610 /* don't pick a track that's been played in the last 8 hours */
1611 if((played_time
= kvp_get(p
, "played_time"))) {
1612 last
= atoll(played_time
);
1614 if(now
< last
+ 8 * 3600) /* TODO configurable */
1617 track_tags
= parsetags(kvp_get(p
, "tags"));
1618 /* check that no prohibited tag is present for this track */
1619 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1621 /* check that at least one required tags is present for this track */
1622 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1627 /* attempt to pick a random non-alias track */
1628 const char *trackdb_random(int tries
) {
1633 const char *track
, *candidate
;
1636 char **required_tags
, **prohibited_tags
, **tp
;
1641 tid
= trackdb_begin_transaction();
1642 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1644 required_tags
= parsetags(tags
);
1645 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1647 prohibited_tags
= parsetags(tags
);
1649 if(*required_tags
) {
1650 /* Bung all the suitable tracks into a hash and convert to a list of keys
1651 * (to eliminate duplicates). We cache this list since it is possible
1652 * that it will be very large. */
1655 for(tp
= required_tags
; *tp
; ++tp
) {
1656 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1657 memset(&key
, 0, sizeof key
);
1659 key
.size
= strlen(*tp
);
1661 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1663 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1664 HASH_INSERT_OR_REPLACE
);
1666 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1672 case DB_LOCK_DEADLOCK
:
1675 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1677 trackdb_closecursor(c
);
1680 error(0, "required tag %s does not match any tracks", *tp
);
1682 nreqtracks
= hash_count(h
);
1683 reqtracks
= hash_keys(h
);
1685 while(nreqtracks
&& !track
&& tries
-- > 0) {
1686 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1687 candidate
= reqtracks
[r
];
1688 switch(check_suitable(candidate
, tid
,
1689 required_tags
, prohibited_tags
)) {
1695 case DB_LOCK_DEADLOCK
:
1700 /* No required tags. We pick random record numbers in the database
1702 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
1705 case DB_LOCK_DEADLOCK
:
1706 error(0, "error querying tracks.db: %s", db_strerror(err
));
1709 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1712 error(0, "cannot pick tracks at random from an empty database");
1713 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1714 /* record numbers count from 1 upwards */
1715 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1716 memset(&key
, sizeof key
, 0);
1717 key
.flags
= DB_DBT_MALLOC
;
1718 key
.size
= sizeof r
;
1720 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1724 case DB_LOCK_DEADLOCK
:
1725 error(0, "error querying tracks.db: %s", db_strerror(err
));
1728 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1730 candidate
= xstrndup(key
.data
, key
.size
);
1731 switch(check_suitable(candidate
, tid
,
1732 required_tags
, prohibited_tags
)) {
1738 case DB_LOCK_DEADLOCK
:
1745 trackdb_closecursor(c
);
1747 trackdb_abort_transaction(tid
);
1749 trackdb_commit_transaction(tid
);
1751 error(0, "could not pick a random track");
1755 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1756 * from the prefs. */
1757 static const char *getpart(const char *track
,
1758 const char *context
,
1760 const struct kvp
*p
,
1765 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1766 if((result
= kvp_get(p
, pref
)))
1769 result
= trackname_part(track
, context
, part
);
1770 assert(result
!= 0);
1774 /* get a track name part, like trackname_part(), but taking the database into
1776 const char *trackdb_getpart(const char *track
,
1777 const char *context
,
1785 /* construct the full pref */
1786 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1788 tid
= trackdb_begin_transaction();
1789 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1793 trackdb_abort_transaction(tid
);
1795 trackdb_commit_transaction(tid
);
1796 return getpart(actual
, context
, part
, p
, &used_db
);
1799 /* get the raw path name for @track@ (might be an alias) */
1800 const char *trackdb_rawpath(const char *track
) {
1806 tid
= trackdb_begin_transaction();
1807 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1811 trackdb_abort_transaction(tid
);
1813 trackdb_commit_transaction(tid
);
1814 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1818 /* trackdb_list **************************************************************/
1820 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1821 * readable at some point */
1823 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1824 * If RE is a null pointer then it matches everything. */
1825 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1833 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1834 case PCRE_ERROR_NOMATCH
: return 0;
1837 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1844 static int do_list(struct vector
*v
, const char *dir
,
1845 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1851 size_t l
, last_dir_len
= 0;
1852 char *last_dir
= 0, *track
, *alias
;
1856 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1859 /* find the first key >= dir */
1860 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1861 /* keep going while we're dealing with <dir/anything> */
1864 && ((char *)k
.data
)[dl
] == '/'
1865 && !memcmp(k
.data
, dir
, dl
)) {
1866 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1868 /* we have <dir/component/anything>, so <dir/component> is a directory */
1869 l
= ptr
- (char *)k
.data
;
1870 if(what
& trackdb_directories
)
1872 && l
== last_dir_len
1873 && !memcmp(last_dir
, k
.data
, l
))) {
1874 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1875 if(track_matches(dl
, k
.data
, l
, re
))
1876 vector_append(v
, last_dir
);
1879 /* found a plain file */
1880 if((what
& trackdb_files
)) {
1881 track
= xstrndup(k
.data
, k
.size
);
1882 if((err
= trackdb_getdata(trackdb_prefsdb
,
1883 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1885 /* if this file has an alias in the same directory then we skip it */
1886 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1888 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1889 if(track_matches(dl
, k
.data
, k
.size
, re
))
1890 vector_append(v
, track
);
1893 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1901 case DB_LOCK_DEADLOCK
:
1902 error(0, "error querying database: %s", db_strerror(err
));
1905 fatal(0, "error querying database: %s", db_strerror(err
));
1908 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1912 /* return the directories or files below @dir@ */
1913 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1921 tid
= trackdb_begin_transaction();
1924 if(do_list(&v
, dir
, what
, re
, tid
))
1927 for(n
= 0; n
< config
->collection
.n
; ++n
)
1928 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1933 trackdb_abort_transaction(tid
);
1935 trackdb_commit_transaction(tid
);
1936 vector_terminate(&v
);
1942 /* If S is tag:something, return something. Else return 0. */
1943 static const char *checktag(const char *s
) {
1944 if(!strncmp(s
, "tag:", 4))
1950 /* return a list of tracks containing all of the words given. If you
1951 * ask for only stopwords you get no tracks. */
1952 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1953 const char **w
, *best
= 0, *tag
;
1954 char **twords
, **tags
;
1956 int i
, j
, n
, err
, what
;
1966 *ntracks
= 0; /* for early returns */
1967 /* normalize all the words */
1968 w
= xmalloc(nwordlist
* sizeof (char *));
1969 istag
= xmalloc_noptr(nwordlist
);
1970 for(n
= 0; n
< nwordlist
; ++n
) {
1974 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1975 if(checktag(w
[n
])) {
1976 ++ntags
; /* count up tags */
1977 /* Normalize the tag */
1978 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
1981 /* Normalize the search term by removing combining characters */
1982 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1984 nw32
= remove_combining_chars(w32
, nw32
);
1985 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1990 /* find the longest non-stopword */
1991 for(n
= 0; n
< nwordlist
; ++n
)
1992 if(!istag
[n
] && !stopword(w
[n
]))
1993 if(!best
|| strlen(w
[n
]) > strlen(best
))
1995 /* TODO: we should at least in principal be able to identify the word or tag
1996 * with the least matches in log time, and choose that as our primary search
1998 if(ntags
&& !best
) {
1999 /* Only tags are listed. We limit to the first and narrow down with the
2001 best
= istag
[0] ? w
[0] : 0;
2002 db
= trackdb_tagsdb
;
2005 /* We can limit to some word. */
2006 db
= trackdb_searchdb
;
2009 /* Only stopwords */
2015 tid
= trackdb_begin_transaction();
2016 /* find all the tracks that have that word */
2021 cursor
= trackdb_opencursor(db
, tid
);
2022 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2023 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2030 case DB_LOCK_DEADLOCK
:
2031 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2034 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2036 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2038 /* do a naive search over that (hopefuly fairly small) list of tracks */
2040 for(n
= 0; n
< v
.nvec
; ++n
) {
2041 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2044 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2047 twords
= track_to_words(v
.vec
[n
], p
);
2048 tags
= parsetags(kvp_get(p
, "tags"));
2049 for(i
= 0; i
< nwordlist
; ++i
) {
2052 /* Track must have this tag */
2053 for(j
= 0; tags
[j
]; ++j
)
2054 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2055 if(!tags
[j
]) break; /* tag not found */
2057 /* Track must contain this word */
2058 for(j
= 0; twords
[j
]; ++j
)
2059 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2060 if(!twords
[j
]) break; /* word not found */
2063 if(i
>= nwordlist
) /* all words found */
2064 vector_append(&u
, v
.vec
[n
]);
2068 trackdb_closecursor(cursor
);
2070 trackdb_abort_transaction(tid
);
2071 info("retrying search");
2073 trackdb_commit_transaction(tid
);
2074 vector_terminate(&u
);
2080 /* trackdb_scan **************************************************************/
2082 int trackdb_scan(const char *root
,
2083 int (*callback
)(const char *track
,
2091 const size_t root_len
= root ?
strlen(root
) : 0;
2096 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2098 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2101 memset(&k
, 0, sizeof k
);
2102 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2107 || (k
.size
> root_len
2108 && !strncmp(k
.data
, root
, root_len
)
2109 && ((char *)k
.data
)[root_len
] == '/')) {
2110 data
= kvp_urldecode(d
.data
, d
.size
);
2111 if(kvp_get(data
, "_path")) {
2112 track
= xstrndup(k
.data
, k
.size
);
2113 /* Advance to the next track before the callback so that the callback
2114 * may safely delete the track */
2115 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2116 if((cberr
= callback(track
, data
, u
, tid
))) {
2121 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2125 trackdb_closecursor(cursor
);
2132 case DB_LOCK_DEADLOCK
:
2133 error(0, "c->c_get: %s", db_strerror(err
));
2136 fatal(0, "c->c_get: %s", db_strerror(err
));
2140 /* trackdb_rescan ************************************************************/
2142 /* called when the rescanner terminates */
2143 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2146 const struct rusage
attribute((unused
)) *rusage
,
2147 void attribute((unused
)) *u
) {
2148 if(pid
== rescan_pid
) rescan_pid
= -1;
2150 error(0, RESCAN
": %s", wstat(status
));
2152 D((RESCAN
" terminated: %s", wstat(status
)));
2153 /* Our cache of file lookups is out of date now */
2154 cache_clean(&cache_files_type
);
2155 eventlog("rescanned", (char *)0);
2159 /** @brief Initiate a rescan
2160 * @param ev Event loop or 0 to block
2161 * @param check 1 to recheck lengths, 0 to suppress check
2163 void trackdb_rescan(ev_source
*ev
, int check
) {
2166 if(rescan_pid
!= -1) {
2167 error(0, "rescan already underway");
2170 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2171 check ?
"--check" : "--no-check",
2174 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2175 D(("started rescanner"));
2177 /* This is the first rescan, we block until it is complete */
2178 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2180 reap_rescan(0, rescan_pid
, w
, 0, 0);
2184 int trackdb_rescan_cancel(void) {
2185 if(rescan_pid
== -1) return 0;
2186 if(kill(rescan_pid
, SIGTERM
) < 0)
2187 fatal(errno
, "error killing rescanner");
2192 /* global prefs **************************************************************/
2194 void trackdb_set_global(const char *name
,
2202 tid
= trackdb_begin_transaction();
2203 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2205 trackdb_abort_transaction(tid
);
2207 trackdb_commit_transaction(tid
);
2208 /* log important state changes */
2209 if(!strcmp(name
, "playing")) {
2210 state
= !value
|| !strcmp(value
, "yes");
2211 info("playing %s by %s",
2212 state ?
"enabled" : "disabled",
2214 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2216 if(!strcmp(name
, "random-play")) {
2217 state
= !value
|| !strcmp(value
, "yes");
2218 info("random play %s by %s",
2219 state ?
"enabled" : "disabled",
2221 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2223 if(!strcmp(name
, "required-tags"))
2227 int trackdb_set_global_tid(const char *name
,
2233 memset(&k
, 0, sizeof k
);
2234 memset(&d
, 0, sizeof d
);
2235 k
.data
= (void *)name
;
2236 k
.size
= strlen(name
);
2238 d
.data
= (void *)value
;
2239 d
.size
= strlen(value
);
2242 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2244 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2245 if(err
== DB_LOCK_DEADLOCK
) return err
;
2247 fatal(0, "error updating database: %s", db_strerror(err
));
2251 const char *trackdb_get_global(const char *name
) {
2257 tid
= trackdb_begin_transaction();
2258 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2260 trackdb_abort_transaction(tid
);
2262 trackdb_commit_transaction(tid
);
2266 int trackdb_get_global_tid(const char *name
,
2272 memset(&k
, 0, sizeof k
);
2273 k
.data
= (void *)name
;
2274 k
.size
= strlen(name
);
2275 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2276 prepare_data(&d
), 0)) {
2278 *rp
= xstrndup(d
.data
, d
.size
);
2283 case DB_LOCK_DEADLOCK
:
2286 fatal(0, "error reading database: %s", db_strerror(err
));
2290 /** @brief Retrieve the most recently added tracks
2291 * @param ntracksp Where to put count, or 0
2292 * @param maxtracks Maximum number of tracks to retrieve
2293 * @return null-terminated array of track names
2295 * The most recently added track is first in the array.
2297 char **trackdb_new(int *ntracksp
,
2303 tid
= trackdb_begin_transaction();
2304 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2307 trackdb_abort_transaction(tid
);
2309 trackdb_commit_transaction(tid
);
2313 /** @brief Retrieve the most recently added tracks
2314 * @param ntracksp Where to put count, or 0
2315 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2316 * @param tid Transaction ID
2317 * @return null-terminated array of track names, or NULL on deadlock
2319 * The most recently added track is first in the array.
2321 static char **trackdb_new_tid(int *ntracksp
,
2327 struct vector tracks
[1];
2329 vector_init(tracks
);
2330 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2331 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2332 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2333 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2335 case 0: /* hit maxtracks */
2336 case DB_NOTFOUND
: /* ran out of tracks */
2338 case DB_LOCK_DEADLOCK
:
2339 trackdb_closecursor(c
);
2342 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2344 if((err
= trackdb_closecursor(c
)))
2345 return 0; /* deadlock */
2346 vector_terminate(tracks
);
2348 *ntracksp
= tracks
->nvec
;
2352 /** @brief Expire noticed.db
2353 * @param earliest Earliest timestamp to keep
2355 void trackdb_expire_noticed(time_t earliest
) {
2359 tid
= trackdb_begin_transaction();
2360 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2362 trackdb_abort_transaction(tid
);
2364 trackdb_commit_transaction(tid
);
2367 /** @brief Expire noticed.db
2368 * @param earliest Earliest timestamp to keep
2369 * @param tid Transaction ID
2370 * @return 0 or DB_LOCK_DEADLOCK
2372 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2380 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2381 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2383 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2384 if(when
>= earliest
)
2386 if((err
= c
->c_del(c
, 0))) {
2387 if(err
!= DB_LOCK_DEADLOCK
)
2388 fatal(0, "error deleting expired noticed.db entry: %s",
2394 if(err
== DB_NOTFOUND
)
2396 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2397 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2399 if((err
= trackdb_closecursor(c
))) {
2400 if(err
!= DB_LOCK_DEADLOCK
)
2401 fatal(0, "error closing cursor: %s", db_strerror(err
));
2405 info("expired %d tracks from noticed.db", count
);
2409 /* tidying up ****************************************************************/
2411 void trackdb_gc(void) {
2415 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2416 config
->checkpoint_kbyte
,
2417 config
->checkpoint_min
,
2419 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2420 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2421 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2422 /* This makes catastrophic recovery impossible. However, the user can still
2423 * preserve the important data by using disorder-dump to snapshot their
2424 * prefs, and later to restore it. This is likely to have much small
2425 * long-term storage requirements than record the db logfiles. */
2428 /* user database *************************************************************/
2430 /** @brief Return true if @p user is trusted */
2431 static int trusted(const char *user
) {
2434 for(n
= 0; (n
< config
->trust
.n
2435 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2437 return n
< config
->trust
.n
;
2440 /** @brief Return non-zero for a valid username
2442 * Currently we only allow the letters and digits in ASCII. We could be more
2443 * liberal than this but it is a nice simple test. It is critical that
2444 * semicolons are never allowed.
2446 static int valid_username(const char *user
) {
2450 const uint8_t c
= *user
++;
2451 /* For now we are very strict */
2452 if((c
>= 'a' && c
<= 'z')
2453 || (c
>= 'A' && c
<= 'Z')
2454 || (c
>= '0' && c
<= '9'))
2462 /** @brief Add a user */
2463 static int create_user(const char *user
,
2464 const char *password
,
2467 const char *confirmation
,
2473 /* sanity check user */
2474 if(!valid_username(user
)) {
2475 error(0, "invalid username '%s'", user
);
2478 if(parse_rights(rights
, 0, 1)) {
2479 error(0, "invalid rights string");
2482 /* data for this user */
2484 kvp_set(&k
, "password", password
);
2485 kvp_set(&k
, "rights", rights
);
2487 kvp_set(&k
, "email", email
);
2489 kvp_set(&k
, "confirmation", confirmation
);
2490 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2491 kvp_set(&k
, "created", s
);
2492 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2495 /** @brief Add one pre-existing user */
2496 static int one_old_user(const char *user
, const char *password
,
2500 /* www-data doesn't get added */
2501 if(!strcmp(user
, "www-data")) {
2502 info("not adding www-data to user database");
2506 if(!strcmp(user
, "root"))
2508 else if(trusted(user
)) {
2511 parse_rights(config
->default_rights
, &r
, 1);
2512 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2513 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2514 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2515 rights
= rights_string(r
);
2517 rights
= config
->default_rights
;
2518 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2519 tid
, DB_NOOVERWRITE
);
2522 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2525 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2526 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2529 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2532 error(0, "user %s already exists, delete 'allow' directive",
2533 config
->allow
.s
[n
].s
[0]);
2534 /* This won't ever become fatal - eventually 'allow' will be
2537 case DB_LOCK_DEADLOCK
:
2538 return DB_LOCK_DEADLOCK
;
2544 /** @brief Read old 'allow' directives and copy them to the users database */
2545 void trackdb_old_users(void) {
2549 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2552 /** @brief Create a root user in the user database if there is none */
2553 void trackdb_create_root(void) {
2558 /* Choose a new root password */
2559 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2560 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2561 /* Create the root user if it does not exist */
2562 WITH_TRANSACTION(create_user("root", pw
, "all",
2563 0/*email*/, 0/*confirmation*/,
2564 tid
, DB_NOOVERWRITE
));
2566 info("created root user");
2569 /** @brief Find a user's password from the database
2570 * @param user Username
2571 * @return Password or NULL
2573 * Only works if running as a user that can read the database!
2575 * If the user exists but has no password, "" is returned.
2577 const char *trackdb_get_password(const char *user
) {
2580 const char *password
;
2582 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2585 password
= kvp_get(k
, "password");
2586 return password ? password
: "";
2589 /** @brief Add a new user
2590 * @param user Username
2591 * @param password Password or NULL
2592 * @param rights Initial rights
2593 * @param email Email address or NULL
2594 * @param confirmation Confirmation string or NULL
2595 * @return 0 on success, non-0 on error
2597 int trackdb_adduser(const char *user
,
2598 const char *password
,
2601 const char *confirmation
) {
2604 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2605 tid
, DB_NOOVERWRITE
));
2607 error(0, "cannot created user '%s' because they already exist", user
);
2611 info("created user '%s' with rights '%s' and email address '%s'",
2612 user
, rights
, email
);
2614 info("created user '%s' with rights '%s'", user
, rights
);
2619 /** @brief Delete a user
2620 * @param user User to delete
2621 * @return 0 on success, non-0 if the user didn't exist anyway
2623 int trackdb_deluser(const char *user
) {
2626 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2628 error(0, "cannot delete user '%s' because they do not exist", user
);
2631 info("deleted user '%s'", user
);
2635 /** @brief Get user information
2636 * @param user User to query
2637 * @return Linked list of user information or NULL if user does not exist
2639 * Every user has at least a @c rights entry so NULL can be used to mean no
2642 struct kvp
*trackdb_getuserinfo(const char *user
) {
2646 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2653 /** @brief Edit user information
2654 * @param user User to edit
2655 * @param key Key to change
2656 * @param value Value to set, or NULL to remove
2657 * @param tid Transaction ID
2658 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2660 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2661 const char *value
, DB_TXN
*tid
) {
2665 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2667 if(!kvp_set(&k
, key
, value
))
2668 return 0; /* no change */
2669 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2672 /** @brief Edit user information
2673 * @param user User to edit
2674 * @param key Key to change
2675 * @param value Value to set, or NULL to remove
2676 * @return 0 on success, non-0 on error
2678 int trackdb_edituserinfo(const char *user
,
2679 const char *key
, const char *value
) {
2682 if(!strcmp(key
, "rights")) {
2684 error(0, "cannot remove 'rights' key from user '%s'", user
);
2687 if(parse_rights(value
, 0, 1)) {
2688 error(0, "invalid rights string");
2691 } else if(!strcmp(key
, "email")) {
2692 if(!strchr(value
, '@')) {
2693 error(0, "invalid email address '%s' for user '%s'", user
, value
);
2696 } else if(!strcmp(key
, "created")) {
2697 error(0, "cannot change creation date for user '%s'", user
);
2699 } else if(strcmp(key
, "password")
2700 && !strcmp(key
, "confirmation")) {
2701 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2704 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2706 error(0, "unknown user '%s'", user
);
2712 /** @brief List all users
2713 * @return NULL-terminated list of users
2715 char **trackdb_listusers(void) {
2720 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2724 /** @brief Confirm a user registration
2725 * @param user Username
2726 * @param confirmation Confirmation string
2727 * @param rightsp Where to put user rights
2728 * @param tid Transaction ID
2729 * @return 0 on success, non-0 on error
2731 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2732 rights_type
*rightsp
,
2734 const char *stored_confirmation
;
2739 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2741 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2742 error(0, "already confirmed user '%s'", user
);
2743 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2746 if(!(rights
= kvp_get(k
, "rights"))) {
2747 error(0, "no rights for unconfirmed user '%s'", user
);
2750 if(parse_rights(rights
, rightsp
, 1))
2752 if(strcmp(confirmation
, stored_confirmation
)) {
2753 error(0, "wrong confirmation string for user '%s'", user
);
2757 kvp_set(&k
, "confirmation", 0);
2758 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2761 /** @brief Confirm a user registration
2762 * @param user Username
2763 * @param confirmation Confirmation string
2764 * @param rightsp Where to put user rights
2765 * @return 0 on success, non-0 on error
2767 int trackdb_confirm(const char *user
, const char *confirmation
,
2768 rights_type
*rightsp
) {
2771 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2774 info("registration confirmed for user '%s'", user
);
2777 error(0, "confirmation for nonexistent user '%s'", user
);
2779 default: /* already reported */
2789 indent-tabs-mode:nil