2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 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 Test whether the track database can be read
170 * @return 1 if it can, 0 if it cannot
172 int trackdb_readable(void) {
175 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
176 return access(usersdb
, R_OK
) == 0;
179 /** @brief Open database environment
180 * @param flags Flags word
182 * Flags should be one of:
183 * - @ref TRACKDB_NO_RECOVER
184 * - @ref TRACKDB_NORMAL_RECOVER
185 * - @ref TRACKDB_FATAL_RECOVER
186 * - @ref TRACKDB_MAY_CREATE
188 void trackdb_init(int flags
) {
190 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
191 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
194 assert(initialized
== 0);
197 if(strcmp(home
, config
->home
))
198 fatal(0, "cannot change db home without server restart");
202 if(flags
& TRACKDB_MAY_CREATE
) {
208 /* Remove world/group permissions on any regular files already in the
209 * database directory. Actually we don't care about all of them but it's
210 * easier to just do the lot. This can be revisited if it's a serious
211 * practical inconvenience for anyone.
213 * The socket, not being a regular file, is excepted.
215 if(!(dp
= opendir(config
->home
)))
216 fatal(errno
, "error reading %s", config
->home
);
217 while((de
= readdir(dp
))) {
218 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
219 if(lstat(p
, &st
) == 0
220 && S_ISREG(st
.st_mode
)
221 && (st
.st_mode
& 077)) {
222 if(chmod(p
, st
.st_mode
& 07700) < 0)
223 fatal(errno
, "cannot chmod %s", p
);
230 /* create environment */
231 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
233 if((err
= trackdb_env
->set_alloc(trackdb_env
,
234 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
235 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
236 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
237 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
238 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
239 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
240 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
246 |recover_type
[recover
],
248 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
249 trackdb_env
->set_errpfx(trackdb_env
, "DB");
250 trackdb_env
->set_errfile(trackdb_env
, stderr
);
251 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
252 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
253 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
254 D(("initialized database environment"));
257 /* called when deadlock manager terminates */
258 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
259 pid_t
attribute((unused
)) pid
,
261 const struct rusage
attribute((unused
)) *rusage
,
262 void attribute((unused
)) *u
) {
263 db_deadlock_pid
= -1;
265 fatal(0, "deadlock manager unexpectedly terminated: %s",
268 D(("deadlock manager terminated: %s", wstat(status
)));
272 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
276 const char *args
[1024], **argp
, *a
;
280 *argp
++ = "--config";
281 *argp
++ = configfile
;
282 *argp
++ = debugging ?
"--debug" : "--no-debug";
283 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
285 while((a
= va_arg(ap
, const char *)))
289 /* If we're in the background then trap subprocess stdout/stderr */
290 if(!(pid
= xfork())) {
293 ev_signal_atfork(ev
);
294 signal(SIGPIPE
, SIG_DFL
);
299 /* ensure we don't leak privilege anywhere */
300 if(setuid(geteuid()) < 0)
301 fatal(errno
, "error calling setuid");
302 /* If we were negatively niced, undo it. We don't bother checking for
303 * error, it's not that important. */
304 setpriority(PRIO_PROCESS
, 0, 0);
305 execvp(prog
, (char **)args
);
306 fatal(errno
, "error invoking %s", prog
);
311 /* start deadlock manager */
312 void trackdb_master(ev_source
*ev
) {
313 assert(db_deadlock_pid
== -1);
314 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
315 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
316 D(("started deadlock manager"));
319 /* close environment */
320 void trackdb_deinit(void) {
324 assert(initialized
== 1);
327 /* close the environment */
328 if((err
= trackdb_env
->close(trackdb_env
, 0)))
329 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
331 if(rescan_pid
!= -1) {
332 /* shut down the rescanner */
333 if(kill(rescan_pid
, SIGTERM
) < 0)
334 fatal(errno
, "error killing rescanner");
335 /* wait for the rescanner to finish */
336 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
340 /* TODO kill any stats subprocesses */
342 /* finally terminate the deadlock manager */
343 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
344 fatal(errno
, "error killing deadlock manager");
345 db_deadlock_pid
= -1;
347 D(("deinitialized database environment"));
350 /* open a specific database */
351 static DB
*open_db(const char *path
,
359 D(("open %s", path
));
360 path
= config_get_file(path
);
361 if((err
= db_create(&db
, trackdb_env
, 0)))
362 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
364 if((err
= db
->set_flags(db
, dbflags
)))
365 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
366 if(dbtype
== DB_BTREE
)
367 if((err
= db
->set_bt_compare(db
, compare
)))
368 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
369 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
370 openflags
| DB_AUTO_COMMIT
, mode
))) {
371 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
372 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
379 /** @brief Open track databases
380 * @param flags Flags flags word
382 * @p flags should have one of:
383 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
384 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
385 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
387 * - @p TRACKDB_READ_ONLY, read only access
389 void trackdb_open(int flags
) {
392 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
397 /* check the database version first */
398 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
399 if(trackdb_globaldb
) {
400 /* This is an existing database */
404 s
= trackdb_get_global("_dbversion");
405 /* Close the database again, we'll open it property below */
406 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
407 fatal(0, "error closing global.db: %s", db_strerror(err
));
408 trackdb_globaldb
= 0;
409 /* Convert version string to an integer */
410 oldversion
= s ?
atol(s
) : 1;
411 if(oldversion
> config
->dbversion
) {
412 /* Database is from the future; we never allow this. */
413 fatal(0, "this version of DisOrder is too old for database version %ld",
416 if(oldversion
< config
->dbversion
) {
417 /* Database version is out of date */
418 switch(flags
& TRACKDB_UPGRADE_MASK
) {
419 case TRACKDB_NO_UPGRADE
:
420 /* This database needs upgrading but this is not permitted */
421 fatal(0, "database needs upgrading from %ld to %ld",
422 oldversion
, config
->dbversion
);
423 case TRACKDB_CAN_UPGRADE
:
424 /* This database needs upgrading */
425 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
426 oldversion
, config
->dbversion
);
427 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
428 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
431 fatal(0, "disorder-dbupgrade %s", wstat(err
));
432 info("disorder-dbupgrade succeeded");
434 case TRACKDB_OPEN_FOR_UPGRADE
:
440 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
441 /* This doesn't make any sense */
442 fatal(0, "database is already at current version");
444 trackdb_existing_database
= 1;
446 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
447 /* Cannot upgrade a new database */
448 fatal(0, "cannot upgrade a database that does not exist");
450 /* This is a brand new database */
451 trackdb_existing_database
= 0;
453 /* open the databases */
454 if(!(trackdb_usersdb
= open_db("users.db",
455 0, DB_HASH
, dbflags
, 0600)))
456 fatal(0, "cannot open users.db");
457 trackdb_tracksdb
= open_db("tracks.db",
458 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
459 trackdb_searchdb
= open_db("search.db",
460 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
461 trackdb_tagsdb
= open_db("tags.db",
462 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
463 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
464 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
465 trackdb_noticeddb
= open_db("noticed.db",
466 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
467 if(!trackdb_existing_database
) {
468 /* Stash the database version */
471 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
472 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
473 trackdb_set_global("_dbversion", buf
, 0);
475 D(("opened databases"));
478 /* close track databases */
479 void trackdb_close(void) {
485 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
486 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
487 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
488 fatal(0, "error closing search.db: %s", db_strerror(err
));
489 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
490 fatal(0, "error closing tags.db: %s", db_strerror(err
));
491 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
492 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
493 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
494 fatal(0, "error closing global.db: %s", db_strerror(err
));
495 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
496 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
497 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
498 fatal(0, "error closing users.db: %s", db_strerror(err
));
499 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
500 trackdb_tagsdb
= trackdb_globaldb
= 0;
501 D(("closed databases"));
504 /* generic db routines *******************************************************/
506 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
507 * DB_LOCK_DEADLOCK. */
508 int trackdb_getdata(DB
*db
,
515 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
516 prepare_data(&data
), 0)) {
518 *kp
= kvp_urldecode(data
.data
, data
.size
);
523 case DB_LOCK_DEADLOCK
:
524 error(0, "error querying database: %s", db_strerror(err
));
527 fatal(0, "error querying database: %s", db_strerror(err
));
531 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
532 * DB_LOCK_DEADLOCK. */
533 int trackdb_putdata(DB
*db
,
541 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
542 encode_data(&data
, k
), flags
)) {
546 case DB_LOCK_DEADLOCK
:
547 error(0, "error updating database: %s", db_strerror(err
));
550 fatal(0, "error updating database: %s", db_strerror(err
));
554 /** @brief Delete a database entry
556 * @param track Key to delete
557 * @param tid Transaction ID
558 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
560 int trackdb_delkey(DB
*db
,
566 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
570 case DB_LOCK_DEADLOCK
:
571 error(0, "error updating database: %s", db_strerror(err
));
574 fatal(0, "error updating database: %s", db_strerror(err
));
578 /* open a database cursor */
579 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
583 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
585 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
590 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
591 int trackdb_closecursor(DBC
*c
) {
595 switch(err
= c
->c_close(c
)) {
598 case DB_LOCK_DEADLOCK
:
599 error(0, "error closing cursor: %s", db_strerror(err
));
602 fatal(0, "error closing cursor: %s", db_strerror(err
));
606 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
607 int trackdb_delkeydata(DB
*db
,
615 c
= trackdb_opencursor(db
, tid
);
616 switch(err
= c
->c_get(c
, make_key(&key
, word
),
617 make_key(&data
, track
), DB_GET_BOTH
)) {
619 switch(err
= c
->c_del(c
, 0)) {
625 case DB_LOCK_DEADLOCK
:
626 error(0, "error updating database: %s", db_strerror(err
));
629 fatal(0, "c->c_del: %s", db_strerror(err
));
634 case DB_LOCK_DEADLOCK
:
635 error(0, "error updating database: %s", db_strerror(err
));
638 fatal(0, "c->c_get: %s", db_strerror(err
));
640 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
644 /* start a transaction */
645 DB_TXN
*trackdb_begin_transaction(void) {
649 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
650 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
654 /* abort transaction */
655 void trackdb_abort_transaction(DB_TXN
*tid
) {
659 if((err
= tid
->abort(tid
)))
660 fatal(0, "tid->abort: %s", db_strerror(err
));
663 /* commit transaction */
664 void trackdb_commit_transaction(DB_TXN
*tid
) {
667 if((err
= tid
->commit(tid
, 0)))
668 fatal(0, "tid->commit: %s", db_strerror(err
));
671 /* search/tags shared code ***************************************************/
673 /* comparison function used by dedupe() */
674 static int wordcmp(const void *a
, const void *b
) {
675 return strcmp(*(const char **)a
, *(const char **)b
);
678 /* sort and de-dupe VEC */
679 static char **dedupe(char **vec
, int nvec
) {
682 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
686 for(n
= 1; n
< nvec
; ++n
)
687 if(strcmp(vec
[n
], vec
[m
- 1]))
694 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
695 static int register_word(DB
*db
, const char *what
,
696 const char *track
, const char *word
,
701 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
702 make_key(&data
, track
), DB_NODUPDATA
)) {
706 case DB_LOCK_DEADLOCK
:
707 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
710 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
714 /* search primitives *********************************************************/
716 /* return true iff NAME is a trackname_display_ pref */
717 static int is_display_pref(const char *name
) {
718 static const char prefix
[] = "trackname_display_";
719 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
722 /** @brief Word_Break property tailor that treats underscores as spaces */
723 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
727 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
728 return unicode_Word_Break_Other
;
732 /** @brief Remove all combining characters in-place
733 * @param s Pointer to start of string
734 * @param ns Length of string
735 * @return New, possiblby reduced, length
737 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
738 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
741 const uint32_t c
= *s
++;
742 if(!utf32_combining_class(c
))
748 /** @brief Normalize and split a string using a given tailoring */
749 static void word_split(struct vector
*v
,
751 unicode_property_tailor
*pt
) {
753 uint32_t *t32
, **w32
;
755 /* Convert to UTF-32 */
756 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
758 /* Erase case distinctions */
759 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
761 /* Drop combining characters */
762 nt32
= remove_combining_chars(t32
, nt32
);
763 /* Split into words, treating _ as a space */
764 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
765 /* Convert words back to UTF-8 and append to result */
766 for(i
= 0; i
< nw
; ++i
)
767 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
770 /** @brief Normalize a tag
772 * @param ns Length of tag
773 * @return Normalized string or NULL on error
775 * The return value will be:
777 * - have no leading or trailing space
778 * - have no combining characters
779 * - all spacing between words will be a single U+0020 SPACE
781 static char *normalize_tag(const char *s
, size_t ns
) {
782 uint32_t *s32
, **w32
;
783 size_t ns32
, nw32
, i
;
786 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
788 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
790 ns32
= remove_combining_chars(s32
, ns32
);
791 /* Split into words, no Word_Break tailoring */
792 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
793 /* Compose back into a string */
795 for(i
= 0; i
< nw32
; ++i
) {
797 dynstr_append(d
, ' ');
798 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
804 /* compute the words of a track name */
805 static char **track_to_words(const char *track
,
806 const struct kvp
*p
) {
808 const char *rootless
= track_rootless(track
);
811 rootless
= track
; /* bodge */
813 rootless
= strip_extension(rootless
);
814 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
815 for(; p
; p
= p
->next
)
816 if(is_display_pref(p
->name
))
817 word_split(&v
, p
->value
, 0);
818 vector_terminate(&v
);
819 return dedupe(v
.vec
, v
.nvec
);
822 /* return nonzero iff WORD is a stopword */
823 static int stopword(const char *word
) {
826 for(n
= 0; n
< config
->stopword
.n
827 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
829 return n
< config
->stopword
.n
;
832 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
833 static int register_search_word(const char *track
, const char *word
,
835 if(stopword(word
)) return 0;
836 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
839 /* Tags **********************************************************************/
841 /* Return nonzero if C is a valid tag character */
842 static int tagchar(int c
) {
851 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
852 static char **parsetags(const char *s
) {
858 /* skip initial separators */
859 while(*s
&& (!tagchar(*s
) || *s
== ' '))
862 /* find the extent of the tag */
864 while(*s
&& tagchar(*s
))
866 /* strip trailing spaces */
867 while(s
> t
&& s
[-1] == ' ')
869 /* add tag to list */
870 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
871 /* skip intermediate and trailing separators */
872 while(*s
&& (!tagchar(*s
) || *s
== ' '))
876 vector_terminate(&v
);
877 return dedupe(v
.vec
, v
.nvec
);
880 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
881 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
882 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
885 /* aliases *******************************************************************/
887 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
888 * there is no alias sets *aliasp to 0. */
889 static int compute_alias(char **aliasp
,
894 const char *s
= config
->alias
, *t
, *expansion
, *part
;
895 int c
, used_db
= 0, slash_prefix
, err
;
897 const char *const root
= find_track_root(track
);
900 /* Bodge for tracks with no root */
905 dynstr_append_string(&d
, root
);
906 while((c
= (unsigned char)*s
++)) {
908 dynstr_append(&d
, c
);
911 if((slash_prefix
= (*s
== '/')))
914 assert(t
!= 0); /* validated at startup */
915 part
= xstrndup(s
, t
- s
);
916 expansion
= getpart(track
, "display", part
, p
, &used_db
);
918 if(slash_prefix
) dynstr_append(&d
, '/');
919 dynstr_append_string(&d
, expansion
);
921 s
= t
+ 1; /* skip {part} */
923 /* only admit to the alias if we used the db... */
928 dynstr_terminate(&d
);
929 /* ...and the answer differs from the original... */
930 if(!strcmp(track
, d
.vec
)) {
934 /* ...and there isn't already a different track with that name (including as
936 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
938 if((s
= kvp_get(at
, "_alias_for"))
939 && !strcmp(s
, track
)) {
951 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
952 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
953 * Always sets the return values, even if only to null pointers. */
954 static int gettrackdata(const char *track
,
957 const char **actualp
,
959 #define GTD_NOALIAS 0x0001
962 const char *actual
= track
;
963 struct kvp
*t
= 0, *p
= 0;
965 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
966 if((actual
= kvp_get(t
, "_alias_for"))) {
967 if(flags
& GTD_NOALIAS
) {
968 error(0, "alias passed to gettrackdata where real path required");
971 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
976 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
981 if(actualp
) *actualp
= actual
;
987 /* trackdb_notice() **********************************************************/
989 /** @brief notice a possibly new track
990 * @return @c DB_NOTFOUND if new, 0 if already known
992 int trackdb_notice(const char *track
,
998 tid
= trackdb_begin_transaction();
999 err
= trackdb_notice_tid(track
, path
, tid
);
1000 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1003 trackdb_abort_transaction(tid
);
1005 trackdb_commit_transaction(tid
);
1009 /** @brief notice a possibly new track
1010 * @param track NFC UTF-8 track name
1011 * @param path Raw path name
1012 * @param tid Transaction ID
1013 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1015 int trackdb_notice_tid(const char *track
,
1019 struct kvp
*t
, *a
, *p
;
1023 /* notice whether the tracks.db entry changes */
1025 /* get any existing tracks entry */
1026 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1028 ret
= err
; /* 0 or DB_NOTFOUND */
1029 /* this is a real track */
1030 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1031 t_changed
+= kvp_set(&t
, "_path", path
);
1032 /* if we have an alias record it in the database */
1033 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1035 /* won't overwrite someone else's alias as compute_alias() checks */
1036 D(("%s: alias %s", track
, alias
));
1038 kvp_set(&a
, "_alias_for", track
);
1039 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1041 /* update search.db */
1042 w
= track_to_words(track
, p
);
1043 for(n
= 0; w
[n
]; ++n
)
1044 if((err
= register_search_word(track
, w
[n
], tid
)))
1046 /* update tags.db */
1047 w
= parsetags(kvp_get(p
, "tags"));
1048 for(n
= 0; w
[n
]; ++n
)
1049 if((err
= register_tag(track
, w
[n
], tid
)))
1052 /* only store the tracks.db entry if it has changed */
1053 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1055 if(ret
== DB_NOTFOUND
) {
1056 uint32_t timestamp
[2];
1061 timestamp
[0] = htonl((uint64_t)now
>> 32);
1062 timestamp
[1] = htonl((uint32_t)now
);
1063 memset(&key
, 0, sizeof key
);
1064 key
.data
= timestamp
;
1065 key
.size
= sizeof timestamp
;
1066 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1067 make_key(&data
, track
), 0)) {
1069 case DB_LOCK_DEADLOCK
: return err
;
1070 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1076 /* trackdb_obsolete() ********************************************************/
1078 /* obsolete a track */
1079 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1084 if((err
= gettrackdata(track
, 0, &p
, 0,
1085 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1087 else if(err
== DB_NOTFOUND
) return 0;
1088 /* compute the alias, if any, and delete it */
1089 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1091 /* if the alias points to some other track then compute_alias won't
1093 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1094 && err
!= DB_NOTFOUND
)
1097 /* update search.db */
1098 w
= track_to_words(track
, p
);
1099 for(n
= 0; w
[n
]; ++n
)
1100 if(trackdb_delkeydata(trackdb_searchdb
,
1101 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1103 /* update tags.db */
1104 w
= parsetags(kvp_get(p
, "tags"));
1105 for(n
= 0; w
[n
]; ++n
)
1106 if(trackdb_delkeydata(trackdb_tagsdb
,
1107 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1110 /* update tracks.db */
1111 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1113 /* We don't delete the prefs, so they survive temporary outages of the
1114 * (possibly virtual) track filesystem */
1118 /* trackdb_stats() ***********************************************************/
1120 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1121 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1123 static const struct statinfo
{
1126 } statinfo_hash
[] = {
1142 }, statinfo_btree
[] = {
1163 /* look up stats for DB */
1164 static int get_stats(struct vector
*v
,
1166 const struct statinfo
*si
,
1175 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1178 case DB_LOCK_DEADLOCK
:
1179 error(0, "error querying database: %s", db_strerror(err
));
1182 fatal(0, "error querying database: %s", db_strerror(err
));
1184 for(n
= 0; n
< nsi
; ++n
) {
1185 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1186 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1187 vector_append(v
, str
);
1193 /** @brief One entry in the search league */
1194 struct search_entry
{
1199 /** @brief Add a word to the search league
1200 * @param se Pointer to search league
1201 * @param count Maximum size for search league
1202 * @param nse Current size of search league
1203 * @param word New word, or NULL
1204 * @param n How often @p word appears
1205 * @return New size of search league
1207 static int register_search_entry(struct search_entry
*se
,
1214 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1215 /* Find the starting point */
1220 /* Find the insertion point */
1221 while(i
> 0 && n
> se
[i
- 1].n
)
1223 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1230 /* find the top COUNT words in the search database */
1231 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1232 struct search_entry
*se
;
1235 int err
, n
= 0, nse
= 0, i
;
1240 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1241 se
= xmalloc(count
* sizeof *se
);
1242 /* Walk across the whole database counting up the number of times each
1244 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1246 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1247 ++n
; /* same word again */
1249 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1250 word
= xstrndup(k
.data
, wl
= k
.size
);
1258 case DB_LOCK_DEADLOCK
:
1259 error(0, "error querying search database: %s", db_strerror(err
));
1262 fatal(0, "error querying search database: %s", db_strerror(err
));
1264 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1266 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1267 byte_xasprintf(&str
, "Top %d search words:", nse
);
1268 vector_append(v
, str
);
1269 for(i
= 0; i
< nse
; ++i
) {
1270 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1271 vector_append(v
, str
);
1276 #define SI(what) statinfo_##what, \
1277 sizeof statinfo_##what / sizeof (struct statinfo)
1279 /* return a list of database stats */
1280 char **trackdb_stats(int *nstatsp
) {
1286 tid
= trackdb_begin_transaction();
1288 vector_append(&v
, (char *)"Tracks database stats:");
1289 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1290 vector_append(&v
, (char *)"");
1291 vector_append(&v
, (char *)"Search database stats:");
1292 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1293 vector_append(&v
, (char *)"");
1294 vector_append(&v
, (char *)"Prefs database stats:");
1295 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1296 vector_append(&v
, (char *)"");
1297 if(search_league(&v
, 10, tid
)) goto fail
;
1298 vector_terminate(&v
);
1301 trackdb_abort_transaction(tid
);
1303 trackdb_commit_transaction(tid
);
1304 if(nstatsp
) *nstatsp
= v
.nvec
;
1308 struct stats_details
{
1309 void (*done
)(char *data
, void *u
);
1311 int exited
; /* subprocess exited */
1312 int closed
; /* pipe close */
1313 int wstat
; /* wait status from subprocess */
1314 struct dynstr data
[1]; /* data read from pipe */
1317 static void stats_complete(struct stats_details
*d
) {
1320 if(!(d
->exited
&& d
->closed
))
1322 byte_xasprintf(&s
, "\n"
1324 "track lookup cache hits: %lu\n"
1325 "track lookup cache misses: %lu\n",
1327 cache_files_misses
);
1328 dynstr_append_string(d
->data
, s
);
1329 dynstr_terminate(d
->data
);
1330 d
->done(d
->data
->vec
, d
->u
);
1333 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1334 pid_t
attribute((unused
)) pid
,
1336 const struct rusage
attribute((unused
)) *rusage
,
1338 struct stats_details
*const d
= u
;
1342 error(0, "disorder-stats %s", wstat(status
));
1347 static int stats_read(ev_source
attribute((unused
)) *ev
,
1353 struct stats_details
*const d
= u
;
1355 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1356 ev_reader_consume(reader
, bytes
);
1363 static int stats_error(ev_source
attribute((unused
)) *ev
,
1366 struct stats_details
*const d
= u
;
1368 error(errno_value
, "error reading from pipe to disorder-stats");
1374 void trackdb_stats_subprocess(ev_source
*ev
,
1375 void (*done
)(char *data
, void *u
),
1379 struct stats_details
*d
= xmalloc(sizeof *d
);
1381 dynstr_init(d
->data
);
1385 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1387 ev_child(ev
, pid
, 0, stats_finished
, d
);
1388 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1391 /* set a pref (remove if value=0) */
1392 int trackdb_set(const char *track
,
1394 const char *value
) {
1395 struct kvp
*t
, *p
, *a
;
1398 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1401 /* TODO: if value matches default then set value=0 */
1405 tid
= trackdb_begin_transaction();
1406 if((err
= gettrackdata(track
, &t
, &p
, 0,
1407 0, tid
)) == DB_LOCK_DEADLOCK
)
1409 if(err
== DB_NOTFOUND
) break;
1410 if(name
[0] == '_') {
1411 if(kvp_set(&t
, name
, value
))
1412 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1415 /* get the old alias name */
1416 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1417 /* get the old tags */
1418 if(!strcmp(name
, "tags"))
1419 oldtags
= parsetags(kvp_get(p
, "tags"));
1421 if(kvp_set(&p
, name
, value
))
1422 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1424 /* compute the new alias name */
1425 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1426 /* check whether alias has changed */
1427 if(!(oldalias
== newalias
1428 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1429 /* adjust alias records to fit change */
1431 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1435 kvp_set(&a
, "_alias_for", track
);
1436 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1439 /* check whether tags have changed */
1440 if(!strcmp(name
, "tags")) {
1441 newtags
= parsetags(value
);
1442 while(*oldtags
|| *newtags
) {
1443 if(*oldtags
&& *newtags
) {
1444 cmp
= strcmp(*oldtags
, *newtags
);
1446 /* keeping this tag */
1450 /* old tag fits into a gap in the new list, so delete old */
1453 /* new tag fits into a gap in the old list, so insert new */
1455 } else if(*oldtags
) {
1456 /* we've run out of new tags, so remaining old ones are to be
1459 if(trackdb_delkeydata(trackdb_tagsdb
,
1460 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1464 /* we've run out of old tags, so remainig new ones are to be
1467 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1477 trackdb_abort_transaction(tid
);
1479 trackdb_commit_transaction(tid
);
1480 return err
== 0 ?
0 : -1;
1484 const char *trackdb_get(const char *track
,
1486 return kvp_get(trackdb_get_all(track
), name
);
1489 /* get all prefs as a 0-terminated array */
1490 struct kvp
*trackdb_get_all(const char *track
) {
1491 struct kvp
*t
, *p
, **pp
;
1495 tid
= trackdb_begin_transaction();
1496 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1500 trackdb_abort_transaction(tid
);
1502 trackdb_commit_transaction(tid
);
1503 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1510 const char *trackdb_resolve(const char *track
) {
1515 tid
= trackdb_begin_transaction();
1516 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1520 trackdb_abort_transaction(tid
);
1522 trackdb_commit_transaction(tid
);
1526 int trackdb_isalias(const char *track
) {
1527 const char *actual
= trackdb_resolve(track
);
1529 return strcmp(actual
, track
);
1532 /* test whether a track exists (perhaps an alias) */
1533 int trackdb_exists(const char *track
) {
1538 tid
= trackdb_begin_transaction();
1539 /* unusually, here we want the return value */
1540 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1544 trackdb_abort_transaction(tid
);
1546 trackdb_commit_transaction(tid
);
1550 /* return the list of tags */
1551 char **trackdb_alltags(void) {
1556 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1560 /** @brief List all the keys in @p db
1561 * @param db Database
1562 * @param v Vector to store keys in
1563 * @param tid Transaction ID
1564 * @return 0 or DB_LOCK_DEADLOCK
1566 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1569 DBC
*const c
= trackdb_opencursor(db
, tid
);
1572 memset(&k
, 0, sizeof k
);
1573 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1574 vector_append(v
, xstrndup(k
.data
, k
.size
));
1578 case DB_LOCK_DEADLOCK
:
1581 fatal(0, "c->c_get: %s", db_strerror(e
));
1583 if((e
= trackdb_closecursor(c
)))
1585 vector_terminate(v
);
1589 /* return 1 iff sorted tag lists A and B have at least one member in common */
1590 static int tag_intersection(char **a
, char **b
) {
1593 /* Same sort of logic as trackdb_set() above */
1595 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1596 else if(cmp
< 0) ++a
;
1602 /* Check whether a track is suitable for random play. Returns 0 if it is,
1603 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1605 static int check_suitable(const char *track
,
1607 char **required_tags
,
1608 char **prohibited_tags
) {
1612 const char *pick_at_random
, *played_time
;
1614 /* don't pick tracks that aren't in any surviving collection (for instance
1615 * you've edited the config but the rescan hasn't done its job yet) */
1616 if(!find_track_root(track
)) {
1617 info("found track not in any collection: %s", track
);
1620 /* don't pick aliases - only pick the canonical form */
1621 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1622 return DB_LOCK_DEADLOCK
;
1623 if(kvp_get(t
, "_alias_for"))
1625 /* check that random play is not suppressed for this track */
1626 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1627 && !strcmp(pick_at_random
, "0"))
1629 /* don't pick a track that's been played in the last 8 hours */
1630 if((played_time
= kvp_get(p
, "played_time"))) {
1631 last
= atoll(played_time
);
1633 if(now
< last
+ 8 * 3600) /* TODO configurable */
1636 track_tags
= parsetags(kvp_get(p
, "tags"));
1637 /* check that no prohibited tag is present for this track */
1638 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1640 /* check that at least one required tags is present for this track */
1641 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1646 /* attempt to pick a random non-alias track */
1647 const char *trackdb_random(int tries
) {
1652 const char *track
, *candidate
;
1655 char **required_tags
, **prohibited_tags
, **tp
;
1660 tid
= trackdb_begin_transaction();
1661 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1663 required_tags
= parsetags(tags
);
1664 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1666 prohibited_tags
= parsetags(tags
);
1668 if(*required_tags
) {
1669 /* Bung all the suitable tracks into a hash and convert to a list of keys
1670 * (to eliminate duplicates). We cache this list since it is possible
1671 * that it will be very large. */
1674 for(tp
= required_tags
; *tp
; ++tp
) {
1675 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1676 memset(&key
, 0, sizeof key
);
1678 key
.size
= strlen(*tp
);
1680 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1682 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1683 HASH_INSERT_OR_REPLACE
);
1685 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1691 case DB_LOCK_DEADLOCK
:
1694 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1696 trackdb_closecursor(c
);
1699 error(0, "required tag %s does not match any tracks", *tp
);
1701 nreqtracks
= hash_count(h
);
1702 reqtracks
= hash_keys(h
);
1704 while(nreqtracks
&& !track
&& tries
-- > 0) {
1705 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1706 candidate
= reqtracks
[r
];
1707 switch(check_suitable(candidate
, tid
,
1708 required_tags
, prohibited_tags
)) {
1714 case DB_LOCK_DEADLOCK
:
1719 /* No required tags. We pick random record numbers in the database
1721 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
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
));
1731 error(0, "cannot pick tracks at random from an empty database");
1732 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1733 /* record numbers count from 1 upwards */
1734 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1735 memset(&key
, sizeof key
, 0);
1736 key
.flags
= DB_DBT_MALLOC
;
1737 key
.size
= sizeof r
;
1739 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1743 case DB_LOCK_DEADLOCK
:
1744 error(0, "error querying tracks.db: %s", db_strerror(err
));
1747 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1749 candidate
= xstrndup(key
.data
, key
.size
);
1750 switch(check_suitable(candidate
, tid
,
1751 required_tags
, prohibited_tags
)) {
1757 case DB_LOCK_DEADLOCK
:
1764 trackdb_closecursor(c
);
1766 trackdb_abort_transaction(tid
);
1768 trackdb_commit_transaction(tid
);
1770 error(0, "could not pick a random track");
1774 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1775 * from the prefs. */
1776 static const char *getpart(const char *track
,
1777 const char *context
,
1779 const struct kvp
*p
,
1784 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1785 if((result
= kvp_get(p
, pref
)))
1788 result
= trackname_part(track
, context
, part
);
1789 assert(result
!= 0);
1793 /* get a track name part, like trackname_part(), but taking the database into
1795 const char *trackdb_getpart(const char *track
,
1796 const char *context
,
1804 /* construct the full pref */
1805 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1807 tid
= trackdb_begin_transaction();
1808 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1812 trackdb_abort_transaction(tid
);
1814 trackdb_commit_transaction(tid
);
1815 return getpart(actual
, context
, part
, p
, &used_db
);
1818 /* get the raw path name for @track@ (might be an alias) */
1819 const char *trackdb_rawpath(const char *track
) {
1825 tid
= trackdb_begin_transaction();
1826 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1830 trackdb_abort_transaction(tid
);
1832 trackdb_commit_transaction(tid
);
1833 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1837 /* trackdb_list **************************************************************/
1839 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1840 * readable at some point */
1842 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1843 * If RE is a null pointer then it matches everything. */
1844 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1852 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1853 case PCRE_ERROR_NOMATCH
: return 0;
1856 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1863 static int do_list(struct vector
*v
, const char *dir
,
1864 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1870 size_t l
, last_dir_len
= 0;
1871 char *last_dir
= 0, *track
, *alias
;
1875 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1878 /* find the first key >= dir */
1879 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1880 /* keep going while we're dealing with <dir/anything> */
1883 && ((char *)k
.data
)[dl
] == '/'
1884 && !memcmp(k
.data
, dir
, dl
)) {
1885 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1887 /* we have <dir/component/anything>, so <dir/component> is a directory */
1888 l
= ptr
- (char *)k
.data
;
1889 if(what
& trackdb_directories
)
1891 && l
== last_dir_len
1892 && !memcmp(last_dir
, k
.data
, l
))) {
1893 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1894 if(track_matches(dl
, k
.data
, l
, re
))
1895 vector_append(v
, last_dir
);
1898 /* found a plain file */
1899 if((what
& trackdb_files
)) {
1900 track
= xstrndup(k
.data
, k
.size
);
1901 if((err
= trackdb_getdata(trackdb_prefsdb
,
1902 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1904 /* if this file has an alias in the same directory then we skip it */
1905 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1907 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1908 if(track_matches(dl
, k
.data
, k
.size
, re
))
1909 vector_append(v
, track
);
1912 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1920 case DB_LOCK_DEADLOCK
:
1921 error(0, "error querying database: %s", db_strerror(err
));
1924 fatal(0, "error querying database: %s", db_strerror(err
));
1927 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1931 /* return the directories or files below @dir@ */
1932 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1940 tid
= trackdb_begin_transaction();
1943 if(do_list(&v
, dir
, what
, re
, tid
))
1946 for(n
= 0; n
< config
->collection
.n
; ++n
)
1947 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1952 trackdb_abort_transaction(tid
);
1954 trackdb_commit_transaction(tid
);
1955 vector_terminate(&v
);
1961 /* If S is tag:something, return something. Else return 0. */
1962 static const char *checktag(const char *s
) {
1963 if(!strncmp(s
, "tag:", 4))
1969 /* return a list of tracks containing all of the words given. If you
1970 * ask for only stopwords you get no tracks. */
1971 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1972 const char **w
, *best
= 0, *tag
;
1973 char **twords
, **tags
;
1975 int i
, j
, n
, err
, what
;
1985 *ntracks
= 0; /* for early returns */
1986 /* normalize all the words */
1987 w
= xmalloc(nwordlist
* sizeof (char *));
1988 istag
= xmalloc_noptr(nwordlist
);
1989 for(n
= 0; n
< nwordlist
; ++n
) {
1993 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1994 if(checktag(w
[n
])) {
1995 ++ntags
; /* count up tags */
1996 /* Normalize the tag */
1997 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2000 /* Normalize the search term by removing combining characters */
2001 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2003 nw32
= remove_combining_chars(w32
, nw32
);
2004 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2009 /* find the longest non-stopword */
2010 for(n
= 0; n
< nwordlist
; ++n
)
2011 if(!istag
[n
] && !stopword(w
[n
]))
2012 if(!best
|| strlen(w
[n
]) > strlen(best
))
2014 /* TODO: we should at least in principal be able to identify the word or tag
2015 * with the least matches in log time, and choose that as our primary search
2017 if(ntags
&& !best
) {
2018 /* Only tags are listed. We limit to the first and narrow down with the
2020 best
= istag
[0] ? w
[0] : 0;
2021 db
= trackdb_tagsdb
;
2024 /* We can limit to some word. */
2025 db
= trackdb_searchdb
;
2028 /* Only stopwords */
2034 tid
= trackdb_begin_transaction();
2035 /* find all the tracks that have that word */
2040 cursor
= trackdb_opencursor(db
, tid
);
2041 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2042 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2049 case DB_LOCK_DEADLOCK
:
2050 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2053 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2055 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2057 /* do a naive search over that (hopefuly fairly small) list of tracks */
2059 for(n
= 0; n
< v
.nvec
; ++n
) {
2060 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2063 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2066 twords
= track_to_words(v
.vec
[n
], p
);
2067 tags
= parsetags(kvp_get(p
, "tags"));
2068 for(i
= 0; i
< nwordlist
; ++i
) {
2071 /* Track must have this tag */
2072 for(j
= 0; tags
[j
]; ++j
)
2073 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2074 if(!tags
[j
]) break; /* tag not found */
2076 /* Track must contain this word */
2077 for(j
= 0; twords
[j
]; ++j
)
2078 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2079 if(!twords
[j
]) break; /* word not found */
2082 if(i
>= nwordlist
) /* all words found */
2083 vector_append(&u
, v
.vec
[n
]);
2087 trackdb_closecursor(cursor
);
2089 trackdb_abort_transaction(tid
);
2090 info("retrying search");
2092 trackdb_commit_transaction(tid
);
2093 vector_terminate(&u
);
2099 /* trackdb_scan **************************************************************/
2101 int trackdb_scan(const char *root
,
2102 int (*callback
)(const char *track
,
2110 const size_t root_len
= root ?
strlen(root
) : 0;
2115 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2117 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2120 memset(&k
, 0, sizeof k
);
2121 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2126 || (k
.size
> root_len
2127 && !strncmp(k
.data
, root
, root_len
)
2128 && ((char *)k
.data
)[root_len
] == '/')) {
2129 data
= kvp_urldecode(d
.data
, d
.size
);
2130 if(kvp_get(data
, "_path")) {
2131 track
= xstrndup(k
.data
, k
.size
);
2132 /* Advance to the next track before the callback so that the callback
2133 * may safely delete the track */
2134 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2135 if((cberr
= callback(track
, data
, u
, tid
))) {
2140 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2144 trackdb_closecursor(cursor
);
2151 case DB_LOCK_DEADLOCK
:
2152 error(0, "c->c_get: %s", db_strerror(err
));
2155 fatal(0, "c->c_get: %s", db_strerror(err
));
2159 /* trackdb_rescan ************************************************************/
2161 /* called when the rescanner terminates */
2162 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2165 const struct rusage
attribute((unused
)) *rusage
,
2166 void attribute((unused
)) *u
) {
2167 if(pid
== rescan_pid
) rescan_pid
= -1;
2169 error(0, RESCAN
": %s", wstat(status
));
2171 D((RESCAN
" terminated: %s", wstat(status
)));
2172 /* Our cache of file lookups is out of date now */
2173 cache_clean(&cache_files_type
);
2174 eventlog("rescanned", (char *)0);
2178 /** @brief Initiate a rescan
2179 * @param ev Event loop or 0 to block
2180 * @param recheck 1 to recheck lengths, 0 to suppress check
2182 void trackdb_rescan(ev_source
*ev
, int recheck
) {
2185 if(rescan_pid
!= -1) {
2186 error(0, "rescan already underway");
2189 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2190 recheck ?
"--check" : "--no-check",
2193 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2194 D(("started rescanner"));
2196 /* This is the first rescan, we block until it is complete */
2197 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2199 reap_rescan(0, rescan_pid
, w
, 0, 0);
2203 int trackdb_rescan_cancel(void) {
2204 if(rescan_pid
== -1) return 0;
2205 if(kill(rescan_pid
, SIGTERM
) < 0)
2206 fatal(errno
, "error killing rescanner");
2211 /* global prefs **************************************************************/
2213 void trackdb_set_global(const char *name
,
2221 tid
= trackdb_begin_transaction();
2222 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2224 trackdb_abort_transaction(tid
);
2226 trackdb_commit_transaction(tid
);
2227 /* log important state changes */
2228 if(!strcmp(name
, "playing")) {
2229 state
= !value
|| !strcmp(value
, "yes");
2230 info("playing %s by %s",
2231 state ?
"enabled" : "disabled",
2233 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2235 if(!strcmp(name
, "random-play")) {
2236 state
= !value
|| !strcmp(value
, "yes");
2237 info("random play %s by %s",
2238 state ?
"enabled" : "disabled",
2240 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2242 if(!strcmp(name
, "required-tags"))
2246 int trackdb_set_global_tid(const char *name
,
2252 memset(&k
, 0, sizeof k
);
2253 memset(&d
, 0, sizeof d
);
2254 k
.data
= (void *)name
;
2255 k
.size
= strlen(name
);
2257 d
.data
= (void *)value
;
2258 d
.size
= strlen(value
);
2261 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2263 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2264 if(err
== DB_LOCK_DEADLOCK
) return err
;
2266 fatal(0, "error updating database: %s", db_strerror(err
));
2270 const char *trackdb_get_global(const char *name
) {
2276 tid
= trackdb_begin_transaction();
2277 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2279 trackdb_abort_transaction(tid
);
2281 trackdb_commit_transaction(tid
);
2285 int trackdb_get_global_tid(const char *name
,
2291 memset(&k
, 0, sizeof k
);
2292 k
.data
= (void *)name
;
2293 k
.size
= strlen(name
);
2294 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2295 prepare_data(&d
), 0)) {
2297 *rp
= xstrndup(d
.data
, d
.size
);
2302 case DB_LOCK_DEADLOCK
:
2305 fatal(0, "error reading database: %s", db_strerror(err
));
2309 /** @brief Retrieve the most recently added tracks
2310 * @param ntracksp Where to put count, or 0
2311 * @param maxtracks Maximum number of tracks to retrieve
2312 * @return null-terminated array of track names
2314 * The most recently added track is first in the array.
2316 char **trackdb_new(int *ntracksp
,
2322 tid
= trackdb_begin_transaction();
2323 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2326 trackdb_abort_transaction(tid
);
2328 trackdb_commit_transaction(tid
);
2332 /** @brief Retrieve the most recently added tracks
2333 * @param ntracksp Where to put count, or 0
2334 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2335 * @param tid Transaction ID
2336 * @return null-terminated array of track names, or NULL on deadlock
2338 * The most recently added track is first in the array.
2340 static char **trackdb_new_tid(int *ntracksp
,
2346 struct vector tracks
[1];
2348 vector_init(tracks
);
2349 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2350 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2351 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2352 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2354 case 0: /* hit maxtracks */
2355 case DB_NOTFOUND
: /* ran out of tracks */
2357 case DB_LOCK_DEADLOCK
:
2358 trackdb_closecursor(c
);
2361 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2363 if((err
= trackdb_closecursor(c
)))
2364 return 0; /* deadlock */
2365 vector_terminate(tracks
);
2367 *ntracksp
= tracks
->nvec
;
2371 /** @brief Expire noticed.db
2372 * @param earliest Earliest timestamp to keep
2374 void trackdb_expire_noticed(time_t earliest
) {
2378 tid
= trackdb_begin_transaction();
2379 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2381 trackdb_abort_transaction(tid
);
2383 trackdb_commit_transaction(tid
);
2386 /** @brief Expire noticed.db
2387 * @param earliest Earliest timestamp to keep
2388 * @param tid Transaction ID
2389 * @return 0 or DB_LOCK_DEADLOCK
2391 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2399 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2400 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2402 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2403 if(when
>= earliest
)
2405 if((err
= c
->c_del(c
, 0))) {
2406 if(err
!= DB_LOCK_DEADLOCK
)
2407 fatal(0, "error deleting expired noticed.db entry: %s",
2413 if(err
== DB_NOTFOUND
)
2415 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2416 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2418 if((err
= trackdb_closecursor(c
))) {
2419 if(err
!= DB_LOCK_DEADLOCK
)
2420 fatal(0, "error closing cursor: %s", db_strerror(err
));
2424 info("expired %d tracks from noticed.db", count
);
2428 /* tidying up ****************************************************************/
2430 void trackdb_gc(void) {
2434 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2435 config
->checkpoint_kbyte
,
2436 config
->checkpoint_min
,
2438 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2439 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2440 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2441 /* This makes catastrophic recovery impossible. However, the user can still
2442 * preserve the important data by using disorder-dump to snapshot their
2443 * prefs, and later to restore it. This is likely to have much small
2444 * long-term storage requirements than record the db logfiles. */
2447 /* user database *************************************************************/
2449 /** @brief Return true if @p user is trusted */
2450 static int trusted(const char *user
) {
2453 for(n
= 0; (n
< config
->trust
.n
2454 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2456 return n
< config
->trust
.n
;
2459 /** @brief Return non-zero for a valid username
2461 * Currently we only allow the letters and digits in ASCII. We could be more
2462 * liberal than this but it is a nice simple test. It is critical that
2463 * semicolons are never allowed.
2465 static int valid_username(const char *user
) {
2469 const uint8_t c
= *user
++;
2470 /* For now we are very strict */
2471 if((c
>= 'a' && c
<= 'z')
2472 || (c
>= 'A' && c
<= 'Z')
2473 || (c
>= '0' && c
<= '9'))
2481 /** @brief Add a user */
2482 static int create_user(const char *user
,
2483 const char *password
,
2486 const char *confirmation
,
2492 /* sanity check user */
2493 if(!valid_username(user
)) {
2494 error(0, "invalid username '%s'", user
);
2497 if(parse_rights(rights
, 0, 1)) {
2498 error(0, "invalid rights string");
2501 /* data for this user */
2503 kvp_set(&k
, "password", password
);
2504 kvp_set(&k
, "rights", rights
);
2506 kvp_set(&k
, "email", email
);
2508 kvp_set(&k
, "confirmation", confirmation
);
2509 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2510 kvp_set(&k
, "created", s
);
2511 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2514 /** @brief Add one pre-existing user */
2515 static int one_old_user(const char *user
, const char *password
,
2519 /* www-data doesn't get added */
2520 if(!strcmp(user
, "www-data")) {
2521 info("not adding www-data to user database");
2525 if(!strcmp(user
, "root"))
2527 else if(trusted(user
)) {
2530 parse_rights(config
->default_rights
, &r
, 1);
2531 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2532 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2533 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2534 rights
= rights_string(r
);
2536 rights
= config
->default_rights
;
2537 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2538 tid
, DB_NOOVERWRITE
);
2541 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2544 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2545 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2548 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2551 error(0, "user %s already exists, delete 'allow' directive",
2552 config
->allow
.s
[n
].s
[0]);
2553 /* This won't ever become fatal - eventually 'allow' will be
2556 case DB_LOCK_DEADLOCK
:
2557 return DB_LOCK_DEADLOCK
;
2563 /** @brief Read old 'allow' directives and copy them to the users database */
2564 void trackdb_old_users(void) {
2568 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2571 /** @brief Create a root user in the user database if there is none */
2572 void trackdb_create_root(void) {
2577 /* Choose a new root password */
2578 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2579 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2580 /* Create the root user if it does not exist */
2581 WITH_TRANSACTION(create_user("root", pw
, "all",
2582 0/*email*/, 0/*confirmation*/,
2583 tid
, DB_NOOVERWRITE
));
2585 info("created root user");
2588 /** @brief Find a user's password from the database
2589 * @param user Username
2590 * @return Password or NULL
2592 * Only works if running as a user that can read the database!
2594 * If the user exists but has no password, "" is returned.
2596 const char *trackdb_get_password(const char *user
) {
2599 const char *password
;
2601 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2604 password
= kvp_get(k
, "password");
2605 return password ? password
: "";
2608 /** @brief Add a new user
2609 * @param user Username
2610 * @param password Password or NULL
2611 * @param rights Initial rights
2612 * @param email Email address or NULL
2613 * @param confirmation Confirmation string or NULL
2614 * @return 0 on success, non-0 on error
2616 int trackdb_adduser(const char *user
,
2617 const char *password
,
2620 const char *confirmation
) {
2623 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2624 tid
, DB_NOOVERWRITE
));
2626 error(0, "cannot create user '%s' because they already exist", user
);
2630 info("created user '%s' with rights '%s' and email address '%s'",
2631 user
, rights
, email
);
2633 info("created user '%s' with rights '%s'", user
, rights
);
2638 /** @brief Delete a user
2639 * @param user User to delete
2640 * @return 0 on success, non-0 if the user didn't exist anyway
2642 int trackdb_deluser(const char *user
) {
2645 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2647 error(0, "cannot delete user '%s' because they do not exist", user
);
2650 info("deleted user '%s'", user
);
2654 /** @brief Get user information
2655 * @param user User to query
2656 * @return Linked list of user information or NULL if user does not exist
2658 * Every user has at least a @c rights entry so NULL can be used to mean no
2661 struct kvp
*trackdb_getuserinfo(const char *user
) {
2665 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
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 * @param tid Transaction ID
2677 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2679 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2680 const char *value
, DB_TXN
*tid
) {
2684 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2686 if(!kvp_set(&k
, key
, value
))
2687 return 0; /* no change */
2688 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2691 /** @brief Edit user information
2692 * @param user User to edit
2693 * @param key Key to change
2694 * @param value Value to set, or NULL to remove
2695 * @return 0 on success, non-0 on error
2697 int trackdb_edituserinfo(const char *user
,
2698 const char *key
, const char *value
) {
2701 if(!strcmp(key
, "rights")) {
2703 error(0, "cannot remove 'rights' key from user '%s'", user
);
2706 if(parse_rights(value
, 0, 1)) {
2707 error(0, "invalid rights string");
2710 } else if(!strcmp(key
, "email")) {
2711 if(!strchr(value
, '@')) {
2712 error(0, "invalid email address '%s' for user '%s'", user
, value
);
2715 } else if(!strcmp(key
, "created")) {
2716 error(0, "cannot change creation date for user '%s'", user
);
2718 } else if(strcmp(key
, "password")
2719 && !strcmp(key
, "confirmation")) {
2720 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2723 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2725 error(0, "unknown user '%s'", user
);
2731 /** @brief List all users
2732 * @return NULL-terminated list of users
2734 char **trackdb_listusers(void) {
2739 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2743 /** @brief Confirm a user registration
2744 * @param user Username
2745 * @param confirmation Confirmation string
2746 * @param rightsp Where to put user rights
2747 * @param tid Transaction ID
2748 * @return 0 on success, non-0 on error
2750 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2751 rights_type
*rightsp
,
2753 const char *stored_confirmation
;
2758 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2760 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2761 error(0, "already confirmed user '%s'", user
);
2762 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2765 if(!(rights
= kvp_get(k
, "rights"))) {
2766 error(0, "no rights for unconfirmed user '%s'", user
);
2769 if(parse_rights(rights
, rightsp
, 1))
2771 if(strcmp(confirmation
, stored_confirmation
)) {
2772 error(0, "wrong confirmation string for user '%s'", user
);
2776 kvp_set(&k
, "confirmation", 0);
2777 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2780 /** @brief Confirm a user registration
2781 * @param user Username
2782 * @param confirmation Confirmation string
2783 * @param rightsp Where to put user rights
2784 * @return 0 on success, non-0 on error
2786 int trackdb_confirm(const char *user
, const char *confirmation
,
2787 rights_type
*rightsp
) {
2790 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2793 info("registration confirmed for user '%s'", user
);
2796 error(0, "confirmation for nonexistent user '%s'", user
);
2798 default: /* already reported */
2808 indent-tabs-mode:nil