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 /* comparison function for keys */
160 static int compare(DB
attribute((unused
)) *db_
,
161 const DBT
*a
, const DBT
*b
) {
162 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
165 /** @brief Test whether the track database can be read
166 * @return 1 if it can, 0 if it cannot
168 int trackdb_readable(void) {
171 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
172 return access(usersdb
, R_OK
) == 0;
175 /** @brief Open database environment
176 * @param flags Flags word
178 * Flags should be one of:
179 * - @ref TRACKDB_NO_RECOVER
180 * - @ref TRACKDB_NORMAL_RECOVER
181 * - @ref TRACKDB_FATAL_RECOVER
182 * - @ref TRACKDB_MAY_CREATE
184 void trackdb_init(int flags
) {
186 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
187 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
190 assert(initialized
== 0);
193 if(strcmp(home
, config
->home
))
194 fatal(0, "cannot change db home without server restart");
198 if(flags
& TRACKDB_MAY_CREATE
) {
204 /* Remove world/group permissions on any regular files already in the
205 * database directory. Actually we don't care about all of them but it's
206 * easier to just do the lot. This can be revisited if it's a serious
207 * practical inconvenience for anyone.
209 * The socket, not being a regular file, is excepted.
211 if(!(dp
= opendir(config
->home
)))
212 fatal(errno
, "error reading %s", config
->home
);
213 while((de
= readdir(dp
))) {
214 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
215 if(lstat(p
, &st
) == 0
216 && S_ISREG(st
.st_mode
)
217 && (st
.st_mode
& 077)) {
218 if(chmod(p
, st
.st_mode
& 07700) < 0)
219 fatal(errno
, "cannot chmod %s", p
);
226 /* create environment */
227 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
229 if((err
= trackdb_env
->set_alloc(trackdb_env
,
230 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
231 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
232 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
233 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
234 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
235 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
236 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
242 |recover_type
[recover
],
244 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
245 trackdb_env
->set_errpfx(trackdb_env
, "DB");
246 trackdb_env
->set_errfile(trackdb_env
, stderr
);
247 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
248 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
249 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
250 D(("initialized database environment"));
253 /* called when deadlock manager terminates */
254 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
255 pid_t
attribute((unused
)) pid
,
257 const struct rusage
attribute((unused
)) *rusage
,
258 void attribute((unused
)) *u
) {
259 db_deadlock_pid
= -1;
261 fatal(0, "deadlock manager unexpectedly terminated: %s",
264 D(("deadlock manager terminated: %s", wstat(status
)));
268 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
272 const char *args
[1024], **argp
, *a
;
276 *argp
++ = "--config";
277 *argp
++ = configfile
;
278 *argp
++ = debugging ?
"--debug" : "--no-debug";
279 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
281 while((a
= va_arg(ap
, const char *)))
285 /* If we're in the background then trap subprocess stdout/stderr */
286 if(!(pid
= xfork())) {
289 ev_signal_atfork(ev
);
290 signal(SIGPIPE
, SIG_DFL
);
295 /* ensure we don't leak privilege anywhere */
296 if(setuid(geteuid()) < 0)
297 fatal(errno
, "error calling setuid");
298 /* If we were negatively niced, undo it. We don't bother checking for
299 * error, it's not that important. */
300 setpriority(PRIO_PROCESS
, 0, 0);
301 execvp(prog
, (char **)args
);
302 fatal(errno
, "error invoking %s", prog
);
307 /* start deadlock manager */
308 void trackdb_master(ev_source
*ev
) {
309 assert(db_deadlock_pid
== -1);
310 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
311 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
312 D(("started deadlock manager"));
315 /* close environment */
316 void trackdb_deinit(void) {
320 assert(initialized
== 1);
323 /* close the environment */
324 if((err
= trackdb_env
->close(trackdb_env
, 0)))
325 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
327 if(rescan_pid
!= -1) {
328 /* shut down the rescanner */
329 if(kill(rescan_pid
, SIGTERM
) < 0)
330 fatal(errno
, "error killing rescanner");
331 /* wait for the rescanner to finish */
332 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
336 /* TODO kill any stats subprocesses */
338 /* finally terminate the deadlock manager */
339 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
340 fatal(errno
, "error killing deadlock manager");
341 db_deadlock_pid
= -1;
343 D(("deinitialized database environment"));
346 /* open a specific database */
347 static DB
*open_db(const char *path
,
355 D(("open %s", path
));
356 path
= config_get_file(path
);
357 if((err
= db_create(&db
, trackdb_env
, 0)))
358 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
360 if((err
= db
->set_flags(db
, dbflags
)))
361 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
362 if(dbtype
== DB_BTREE
)
363 if((err
= db
->set_bt_compare(db
, compare
)))
364 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
365 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
366 openflags
| DB_AUTO_COMMIT
, mode
))) {
367 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
368 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
375 /** @brief Open track databases
376 * @param flags Flags flags word
378 * @p flags should have one of:
379 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
380 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
381 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
383 * - @p TRACKDB_READ_ONLY, read only access
385 void trackdb_open(int flags
) {
388 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
393 /* check the database version first */
394 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
395 if(trackdb_globaldb
) {
396 /* This is an existing database */
400 s
= trackdb_get_global("_dbversion");
401 /* Close the database again, we'll open it property below */
402 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
403 fatal(0, "error closing global.db: %s", db_strerror(err
));
404 trackdb_globaldb
= 0;
405 /* Convert version string to an integer */
406 oldversion
= s ?
atol(s
) : 1;
407 if(oldversion
> config
->dbversion
) {
408 /* Database is from the future; we never allow this. */
409 fatal(0, "this version of DisOrder is too old for database version %ld",
412 if(oldversion
< config
->dbversion
) {
413 /* Database version is out of date */
414 switch(flags
& TRACKDB_UPGRADE_MASK
) {
415 case TRACKDB_NO_UPGRADE
:
416 /* This database needs upgrading but this is not permitted */
417 fatal(0, "database needs upgrading from %ld to %ld",
418 oldversion
, config
->dbversion
);
419 case TRACKDB_CAN_UPGRADE
:
420 /* This database needs upgrading */
421 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
422 oldversion
, config
->dbversion
);
423 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
424 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
427 fatal(0, "disorder-dbupgrade %s", wstat(err
));
428 info("disorder-dbupgrade succeeded");
430 case TRACKDB_OPEN_FOR_UPGRADE
:
436 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
437 /* This doesn't make any sense */
438 fatal(0, "database is already at current version");
440 trackdb_existing_database
= 1;
442 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
443 /* Cannot upgrade a new database */
444 fatal(0, "cannot upgrade a database that does not exist");
446 /* This is a brand new database */
447 trackdb_existing_database
= 0;
449 /* open the databases */
450 if(!(trackdb_usersdb
= open_db("users.db",
451 0, DB_HASH
, dbflags
, 0600)))
452 fatal(0, "cannot open users.db");
453 trackdb_tracksdb
= open_db("tracks.db",
454 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
455 trackdb_searchdb
= open_db("search.db",
456 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
457 trackdb_tagsdb
= open_db("tags.db",
458 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
459 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
460 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
461 trackdb_noticeddb
= open_db("noticed.db",
462 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
463 if(!trackdb_existing_database
) {
464 /* Stash the database version */
467 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
468 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
469 trackdb_set_global("_dbversion", buf
, 0);
471 D(("opened databases"));
474 /* close track databases */
475 void trackdb_close(void) {
481 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
482 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
483 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
484 fatal(0, "error closing search.db: %s", db_strerror(err
));
485 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
486 fatal(0, "error closing tags.db: %s", db_strerror(err
));
487 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
488 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
489 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
490 fatal(0, "error closing global.db: %s", db_strerror(err
));
491 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
492 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
493 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
494 fatal(0, "error closing users.db: %s", db_strerror(err
));
495 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
496 trackdb_tagsdb
= trackdb_globaldb
= 0;
497 D(("closed databases"));
500 /* generic db routines *******************************************************/
502 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
503 * DB_LOCK_DEADLOCK. */
504 int trackdb_getdata(DB
*db
,
511 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
512 prepare_data(&data
), 0)) {
514 *kp
= kvp_urldecode(data
.data
, data
.size
);
519 case DB_LOCK_DEADLOCK
:
520 error(0, "error querying database: %s", db_strerror(err
));
523 fatal(0, "error querying database: %s", db_strerror(err
));
527 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
528 * DB_LOCK_DEADLOCK. */
529 int trackdb_putdata(DB
*db
,
537 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
538 encode_data(&data
, k
), flags
)) {
542 case DB_LOCK_DEADLOCK
:
543 error(0, "error updating database: %s", db_strerror(err
));
546 fatal(0, "error updating database: %s", db_strerror(err
));
550 /** @brief Delete a database entry
552 * @param track Key to delete
553 * @param tid Transaction ID
554 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
556 int trackdb_delkey(DB
*db
,
562 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
566 case DB_LOCK_DEADLOCK
:
567 error(0, "error updating database: %s", db_strerror(err
));
570 fatal(0, "error updating database: %s", db_strerror(err
));
574 /* open a database cursor */
575 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
579 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
581 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
586 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
587 int trackdb_closecursor(DBC
*c
) {
591 switch(err
= c
->c_close(c
)) {
594 case DB_LOCK_DEADLOCK
:
595 error(0, "error closing cursor: %s", db_strerror(err
));
598 fatal(0, "error closing cursor: %s", db_strerror(err
));
602 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
603 int trackdb_delkeydata(DB
*db
,
611 c
= trackdb_opencursor(db
, tid
);
612 switch(err
= c
->c_get(c
, make_key(&key
, word
),
613 make_key(&data
, track
), DB_GET_BOTH
)) {
615 switch(err
= c
->c_del(c
, 0)) {
621 case DB_LOCK_DEADLOCK
:
622 error(0, "error updating database: %s", db_strerror(err
));
625 fatal(0, "c->c_del: %s", db_strerror(err
));
630 case DB_LOCK_DEADLOCK
:
631 error(0, "error updating database: %s", db_strerror(err
));
634 fatal(0, "c->c_get: %s", db_strerror(err
));
636 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
640 /* start a transaction */
641 DB_TXN
*trackdb_begin_transaction(void) {
645 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
646 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
650 /* abort transaction */
651 void trackdb_abort_transaction(DB_TXN
*tid
) {
655 if((err
= tid
->abort(tid
)))
656 fatal(0, "tid->abort: %s", db_strerror(err
));
659 /* commit transaction */
660 void trackdb_commit_transaction(DB_TXN
*tid
) {
663 if((err
= tid
->commit(tid
, 0)))
664 fatal(0, "tid->commit: %s", db_strerror(err
));
667 /* search/tags shared code ***************************************************/
669 /* comparison function used by dedupe() */
670 static int wordcmp(const void *a
, const void *b
) {
671 return strcmp(*(const char **)a
, *(const char **)b
);
674 /* sort and de-dupe VEC */
675 static char **dedupe(char **vec
, int nvec
) {
678 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
682 for(n
= 1; n
< nvec
; ++n
)
683 if(strcmp(vec
[n
], vec
[m
- 1]))
690 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
691 static int register_word(DB
*db
, const char *what
,
692 const char *track
, const char *word
,
697 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
698 make_key(&data
, track
), DB_NODUPDATA
)) {
702 case DB_LOCK_DEADLOCK
:
703 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
706 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
710 /* search primitives *********************************************************/
712 /* return true iff NAME is a trackname_display_ pref */
713 static int is_display_pref(const char *name
) {
714 static const char prefix
[] = "trackname_display_";
715 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
718 /** @brief Word_Break property tailor that treats underscores as spaces */
719 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
723 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
724 return unicode_Word_Break_Other
;
728 /** @brief Remove all combining characters in-place
729 * @param s Pointer to start of string
730 * @param ns Length of string
731 * @return New, possiblby reduced, length
733 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
734 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
737 const uint32_t c
= *s
++;
738 if(!utf32_combining_class(c
))
744 /** @brief Normalize and split a string using a given tailoring */
745 static void word_split(struct vector
*v
,
747 unicode_property_tailor
*pt
) {
749 uint32_t *t32
, **w32
;
751 /* Convert to UTF-32 */
752 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
754 /* Erase case distinctions */
755 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
757 /* Drop combining characters */
758 nt32
= remove_combining_chars(t32
, nt32
);
759 /* Split into words, treating _ as a space */
760 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
761 /* Convert words back to UTF-8 and append to result */
762 for(i
= 0; i
< nw
; ++i
)
763 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
766 /** @brief Normalize a tag
768 * @param ns Length of tag
769 * @return Normalized string or NULL on error
771 * The return value will be:
773 * - have no leading or trailing space
774 * - have no combining characters
775 * - all spacing between words will be a single U+0020 SPACE
777 static char *normalize_tag(const char *s
, size_t ns
) {
778 uint32_t *s32
, **w32
;
779 size_t ns32
, nw32
, i
;
782 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
784 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
786 ns32
= remove_combining_chars(s32
, ns32
);
787 /* Split into words, no Word_Break tailoring */
788 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
789 /* Compose back into a string */
791 for(i
= 0; i
< nw32
; ++i
) {
793 dynstr_append(d
, ' ');
794 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
800 /* compute the words of a track name */
801 static char **track_to_words(const char *track
,
802 const struct kvp
*p
) {
804 const char *rootless
= track_rootless(track
);
807 rootless
= track
; /* bodge */
809 rootless
= strip_extension(rootless
);
810 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
811 for(; p
; p
= p
->next
)
812 if(is_display_pref(p
->name
))
813 word_split(&v
, p
->value
, 0);
814 vector_terminate(&v
);
815 return dedupe(v
.vec
, v
.nvec
);
818 /* return nonzero iff WORD is a stopword */
819 static int stopword(const char *word
) {
822 for(n
= 0; n
< config
->stopword
.n
823 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
825 return n
< config
->stopword
.n
;
828 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
829 static int register_search_word(const char *track
, const char *word
,
831 if(stopword(word
)) return 0;
832 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
835 /* Tags **********************************************************************/
837 /* Return nonzero if C is a valid tag character */
838 static int tagchar(int c
) {
847 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
848 char **parsetags(const char *s
) {
854 /* skip initial separators */
855 while(*s
&& (!tagchar(*s
) || *s
== ' '))
858 /* find the extent of the tag */
860 while(*s
&& tagchar(*s
))
862 /* strip trailing spaces */
863 while(s
> t
&& s
[-1] == ' ')
865 /* add tag to list */
866 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
867 /* skip intermediate and trailing separators */
868 while(*s
&& (!tagchar(*s
) || *s
== ' '))
872 vector_terminate(&v
);
873 return dedupe(v
.vec
, v
.nvec
);
876 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
877 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
878 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
881 /* aliases *******************************************************************/
883 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
884 * there is no alias sets *aliasp to 0. */
885 static int compute_alias(char **aliasp
,
890 const char *s
= config
->alias
, *t
, *expansion
, *part
;
891 int c
, used_db
= 0, slash_prefix
, err
;
893 const char *const root
= find_track_root(track
);
896 /* Bodge for tracks with no root */
901 dynstr_append_string(&d
, root
);
902 while((c
= (unsigned char)*s
++)) {
904 dynstr_append(&d
, c
);
907 if((slash_prefix
= (*s
== '/')))
910 assert(t
!= 0); /* validated at startup */
911 part
= xstrndup(s
, t
- s
);
912 expansion
= getpart(track
, "display", part
, p
, &used_db
);
914 if(slash_prefix
) dynstr_append(&d
, '/');
915 dynstr_append_string(&d
, expansion
);
917 s
= t
+ 1; /* skip {part} */
919 /* only admit to the alias if we used the db... */
924 dynstr_terminate(&d
);
925 /* ...and the answer differs from the original... */
926 if(!strcmp(track
, d
.vec
)) {
930 /* ...and there isn't already a different track with that name (including as
932 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
934 if((s
= kvp_get(at
, "_alias_for"))
935 && !strcmp(s
, track
)) {
947 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
948 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
949 * Always sets the return values, even if only to null pointers. */
950 static int gettrackdata(const char *track
,
953 const char **actualp
,
955 #define GTD_NOALIAS 0x0001
958 const char *actual
= track
;
959 struct kvp
*t
= 0, *p
= 0;
961 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
962 if((actual
= kvp_get(t
, "_alias_for"))) {
963 if(flags
& GTD_NOALIAS
) {
964 error(0, "alias passed to gettrackdata where real path required");
967 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
972 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
977 if(actualp
) *actualp
= actual
;
983 /* trackdb_notice() **********************************************************/
985 /** @brief notice a possibly new track
986 * @return @c DB_NOTFOUND if new, 0 if already known
988 int trackdb_notice(const char *track
,
994 tid
= trackdb_begin_transaction();
995 err
= trackdb_notice_tid(track
, path
, tid
);
996 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
999 trackdb_abort_transaction(tid
);
1001 trackdb_commit_transaction(tid
);
1005 /** @brief notice a possibly new track
1006 * @param track NFC UTF-8 track name
1007 * @param path Raw path name
1008 * @param tid Transaction ID
1009 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1011 int trackdb_notice_tid(const char *track
,
1015 struct kvp
*t
, *a
, *p
;
1017 char *alias
, **w
, *noticed
;
1020 /* notice whether the tracks.db entry changes */
1022 /* get any existing tracks entry */
1023 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1025 ret
= err
; /* 0 or DB_NOTFOUND */
1026 /* this is a real track */
1027 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1028 t_changed
+= kvp_set(&t
, "_path", path
);
1030 if(ret
== DB_NOTFOUND
) {
1031 /* It's a new track; record the time */
1032 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1033 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1035 /* if we have an alias record it in the database */
1036 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1038 /* won't overwrite someone else's alias as compute_alias() checks */
1039 D(("%s: alias %s", track
, alias
));
1041 kvp_set(&a
, "_alias_for", track
);
1042 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1044 /* update search.db */
1045 w
= track_to_words(track
, p
);
1046 for(n
= 0; w
[n
]; ++n
)
1047 if((err
= register_search_word(track
, w
[n
], tid
)))
1049 /* update tags.db */
1050 w
= parsetags(kvp_get(p
, "tags"));
1051 for(n
= 0; w
[n
]; ++n
)
1052 if((err
= register_tag(track
, w
[n
], tid
)))
1054 /* only store the tracks.db entry if it has changed */
1055 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1057 if(ret
== DB_NOTFOUND
) {
1058 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
)
1109 /* update tracks.db */
1110 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1112 /* We don't delete the prefs, so they survive temporary outages of the
1113 * (possibly virtual) track filesystem */
1117 /* trackdb_stats() ***********************************************************/
1119 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1120 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1122 static const struct statinfo
{
1125 } statinfo_hash
[] = {
1141 }, statinfo_btree
[] = {
1162 /* look up stats for DB */
1163 static int get_stats(struct vector
*v
,
1165 const struct statinfo
*si
,
1174 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1177 case DB_LOCK_DEADLOCK
:
1178 error(0, "error querying database: %s", db_strerror(err
));
1181 fatal(0, "error querying database: %s", db_strerror(err
));
1183 for(n
= 0; n
< nsi
; ++n
) {
1184 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1185 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1186 vector_append(v
, str
);
1192 /** @brief One entry in the search league */
1193 struct search_entry
{
1198 /** @brief Add a word to the search league
1199 * @param se Pointer to search league
1200 * @param count Maximum size for search league
1201 * @param nse Current size of search league
1202 * @param word New word, or NULL
1203 * @param n How often @p word appears
1204 * @return New size of search league
1206 static int register_search_entry(struct search_entry
*se
,
1213 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1214 /* Find the starting point */
1219 /* Find the insertion point */
1220 while(i
> 0 && n
> se
[i
- 1].n
)
1222 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1229 /* find the top COUNT words in the search database */
1230 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1231 struct search_entry
*se
;
1234 int err
, n
= 0, nse
= 0, i
;
1239 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1240 se
= xmalloc(count
* sizeof *se
);
1241 /* Walk across the whole database counting up the number of times each
1243 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1245 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1246 ++n
; /* same word again */
1248 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1249 word
= xstrndup(k
.data
, wl
= k
.size
);
1257 case DB_LOCK_DEADLOCK
:
1258 error(0, "error querying search database: %s", db_strerror(err
));
1261 fatal(0, "error querying search database: %s", db_strerror(err
));
1263 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1265 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1266 byte_xasprintf(&str
, "Top %d search words:", nse
);
1267 vector_append(v
, str
);
1268 for(i
= 0; i
< nse
; ++i
) {
1269 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1270 vector_append(v
, str
);
1275 #define SI(what) statinfo_##what, \
1276 sizeof statinfo_##what / sizeof (struct statinfo)
1278 /* return a list of database stats */
1279 char **trackdb_stats(int *nstatsp
) {
1285 tid
= trackdb_begin_transaction();
1287 vector_append(&v
, (char *)"Tracks database stats:");
1288 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1289 vector_append(&v
, (char *)"");
1290 vector_append(&v
, (char *)"Search database stats:");
1291 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1292 vector_append(&v
, (char *)"");
1293 vector_append(&v
, (char *)"Prefs database stats:");
1294 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1295 vector_append(&v
, (char *)"");
1296 if(search_league(&v
, 10, tid
)) goto fail
;
1297 vector_terminate(&v
);
1300 trackdb_abort_transaction(tid
);
1302 trackdb_commit_transaction(tid
);
1303 if(nstatsp
) *nstatsp
= v
.nvec
;
1307 struct stats_details
{
1308 void (*done
)(char *data
, void *u
);
1310 int exited
; /* subprocess exited */
1311 int closed
; /* pipe close */
1312 int wstat
; /* wait status from subprocess */
1313 struct dynstr data
[1]; /* data read from pipe */
1316 static void stats_complete(struct stats_details
*d
) {
1319 if(!(d
->exited
&& d
->closed
))
1321 byte_xasprintf(&s
, "\n"
1323 "track lookup cache hits: %lu\n"
1324 "track lookup cache misses: %lu\n",
1326 cache_files_misses
);
1327 dynstr_append_string(d
->data
, s
);
1328 dynstr_terminate(d
->data
);
1329 d
->done(d
->data
->vec
, d
->u
);
1332 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1333 pid_t
attribute((unused
)) pid
,
1335 const struct rusage
attribute((unused
)) *rusage
,
1337 struct stats_details
*const d
= u
;
1341 error(0, "disorder-stats %s", wstat(status
));
1346 static int stats_read(ev_source
attribute((unused
)) *ev
,
1352 struct stats_details
*const d
= u
;
1354 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1355 ev_reader_consume(reader
, bytes
);
1362 static int stats_error(ev_source
attribute((unused
)) *ev
,
1365 struct stats_details
*const d
= u
;
1367 error(errno_value
, "error reading from pipe to disorder-stats");
1373 void trackdb_stats_subprocess(ev_source
*ev
,
1374 void (*done
)(char *data
, void *u
),
1378 struct stats_details
*d
= xmalloc(sizeof *d
);
1380 dynstr_init(d
->data
);
1384 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1386 ev_child(ev
, pid
, 0, stats_finished
, d
);
1387 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1390 /** @brief Parse a track name part preference
1391 * @param name Preference name
1392 * @param partp Where to store part name
1393 * @param contextp Where to store context name
1394 * @return 0 on success, non-0 if parse fails
1396 static int trackdb__parse_namepref(const char *name
,
1400 static const char prefix
[] = "trackname_";
1402 if(strncmp(name
, prefix
, strlen(prefix
)))
1403 return -1; /* not trackname_* at all */
1404 name
+= strlen(prefix
);
1405 /* There had better be a _ between context and part */
1406 c
= strchr(name
, '_');
1409 /* Context is first in the pref name even though most APIs have the part
1410 * first. Confusing; sorry. */
1411 *contextp
= xstrndup(name
, c
- name
);
1413 /* There had better NOT be a second _ */
1416 *partp
= xstrdup(c
);
1420 /** @brief Compute the default value for a track preference
1421 * @param track Track name
1422 * @param name Preference name
1423 * @return Default value or 0 if none/not known
1425 static const char *trackdb__default(const char *track
, const char *name
) {
1426 char *context
, *part
;
1428 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1429 /* We can work out the default for a trackname_ pref */
1430 return trackname_part(track
, context
, part
);
1431 } else if(!strcmp(name
, "weight")) {
1432 /* We know the default weight */
1434 } else if(!strcmp(name
, "pick_at_random")) {
1435 /* By default everything is eligible for picking at random */
1437 } else if(!strcmp(name
, "tags")) {
1438 /* By default everything no track has any tags */
1444 /* set a pref (remove if value=0) */
1445 int trackdb_set(const char *track
,
1447 const char *value
) {
1448 struct kvp
*t
, *p
, *a
;
1451 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1454 /* If the value matches the default then unset instead, to keep the database
1455 * tidy. Older versions did not have this feature so your database may yet
1456 * have some default values stored in it. */
1458 def
= trackdb__default(track
, name
);
1459 if(def
&& !strcmp(value
, def
))
1464 tid
= trackdb_begin_transaction();
1465 if((err
= gettrackdata(track
, &t
, &p
, 0,
1466 0, tid
)) == DB_LOCK_DEADLOCK
)
1468 if(err
== DB_NOTFOUND
) break;
1469 if(name
[0] == '_') {
1470 if(kvp_set(&t
, name
, value
))
1471 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1474 /* get the old alias name */
1475 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1476 /* get the old tags */
1477 if(!strcmp(name
, "tags"))
1478 oldtags
= parsetags(kvp_get(p
, "tags"));
1480 if(kvp_set(&p
, name
, value
))
1481 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1483 /* compute the new alias name */
1484 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1485 /* check whether alias has changed */
1486 if(!(oldalias
== newalias
1487 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1488 /* adjust alias records to fit change */
1490 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1494 kvp_set(&a
, "_alias_for", track
);
1495 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1498 /* check whether tags have changed */
1499 if(!strcmp(name
, "tags")) {
1500 newtags
= parsetags(value
);
1501 while(*oldtags
|| *newtags
) {
1502 if(*oldtags
&& *newtags
) {
1503 cmp
= strcmp(*oldtags
, *newtags
);
1505 /* keeping this tag */
1509 /* old tag fits into a gap in the new list, so delete old */
1512 /* new tag fits into a gap in the old list, so insert new */
1514 } else if(*oldtags
) {
1515 /* we've run out of new tags, so remaining old ones are to be
1518 if(trackdb_delkeydata(trackdb_tagsdb
,
1519 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1523 /* we've run out of old tags, so remainig new ones are to be
1526 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1535 trackdb_abort_transaction(tid
);
1537 trackdb_commit_transaction(tid
);
1538 return err
== 0 ?
0 : -1;
1542 const char *trackdb_get(const char *track
,
1544 return kvp_get(trackdb_get_all(track
), name
);
1547 /* get all prefs as a 0-terminated array */
1548 struct kvp
*trackdb_get_all(const char *track
) {
1549 struct kvp
*t
, *p
, **pp
;
1553 tid
= trackdb_begin_transaction();
1554 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1558 trackdb_abort_transaction(tid
);
1560 trackdb_commit_transaction(tid
);
1561 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1568 const char *trackdb_resolve(const char *track
) {
1573 tid
= trackdb_begin_transaction();
1574 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1578 trackdb_abort_transaction(tid
);
1580 trackdb_commit_transaction(tid
);
1584 int trackdb_isalias(const char *track
) {
1585 const char *actual
= trackdb_resolve(track
);
1587 return strcmp(actual
, track
);
1590 /* test whether a track exists (perhaps an alias) */
1591 int trackdb_exists(const char *track
) {
1596 tid
= trackdb_begin_transaction();
1597 /* unusually, here we want the return value */
1598 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1602 trackdb_abort_transaction(tid
);
1604 trackdb_commit_transaction(tid
);
1608 /* return the list of tags */
1609 char **trackdb_alltags(void) {
1614 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1618 /** @brief List all the keys in @p db
1619 * @param db Database
1620 * @param v Vector to store keys in
1621 * @param tid Transaction ID
1622 * @return 0 or DB_LOCK_DEADLOCK
1624 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1627 DBC
*const c
= trackdb_opencursor(db
, tid
);
1630 memset(&k
, 0, sizeof k
);
1631 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1632 vector_append(v
, xstrndup(k
.data
, k
.size
));
1636 case DB_LOCK_DEADLOCK
:
1639 fatal(0, "c->c_get: %s", db_strerror(e
));
1641 if((e
= trackdb_closecursor(c
)))
1643 vector_terminate(v
);
1647 /* return 1 iff sorted tag lists A and B have at least one member in common */
1648 int tag_intersection(char **a
, char **b
) {
1651 /* Same sort of logic as trackdb_set() above */
1653 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1654 else if(cmp
< 0) ++a
;
1660 static pid_t choose_pid
= -1;
1661 static int choose_fd
;
1662 static random_callback
*choose_callback
;
1663 static struct dynstr choose_output
;
1664 static unsigned choose_complete
;
1665 static int choose_status
;
1666 #define CHOOSE_RUNNING 1
1667 #define CHOOSE_READING 2
1669 static void choose_finished(ev_source
*ev
, unsigned which
) {
1670 choose_complete
|= which
;
1671 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1674 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1675 dynstr_terminate(&choose_output
);
1676 choose_callback(ev
, xstrdup(choose_output
.vec
));
1678 choose_callback(ev
, 0);
1681 /** @brief Called when @c disorder-choose terminates */
1682 static int choose_exited(ev_source
*ev
,
1683 pid_t
attribute((unused
)) pid
,
1685 const struct rusage
attribute((unused
)) *rusage
,
1686 void attribute((unused
)) *u
) {
1688 error(0, "disorder-choose %s", wstat(status
));
1689 choose_status
= status
;
1690 choose_finished(ev
, CHOOSE_RUNNING
);
1694 /** @brief Called with data from @c disorder-choose pipe */
1695 static int choose_readable(ev_source
*ev
,
1700 void attribute((unused
)) *u
) {
1701 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1702 ev_reader_consume(reader
, bytes
);
1704 choose_finished(ev
, CHOOSE_READING
);
1708 static int choose_read_error(ev_source
*ev
,
1710 void attribute((unused
)) *u
) {
1711 error(errno_value
, "error reading disorder-choose pipe");
1712 choose_finished(ev
, CHOOSE_READING
);
1716 /** @brief Request a random track
1717 * @param ev Event source
1718 * @param callback Called with random track or NULL
1719 * @return 0 if a request was initiated, else -1
1721 * Initiates a random track choice. @p callback will later be called back with
1722 * the choice (or NULL on error). If a choice is already underway then -1 is
1723 * returned and there will be no additional callback.
1725 * The caller shouldn't assume that the track returned actually exists (it
1726 * might be removed between the choice and the callback, or between being added
1727 * to the queue and being played).
1729 int trackdb_request_random(ev_source
*ev
,
1730 random_callback
*callback
) {
1733 if(choose_pid
!= -1)
1734 return -1; /* don't run concurrent chooses */
1737 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1740 choose_callback
= callback
;
1741 choose_output
.nvec
= 0;
1742 choose_complete
= 0;
1743 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1744 "disorder-choose reader"); /* owns p[0] */
1745 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1749 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1750 * from the prefs. */
1751 static const char *getpart(const char *track
,
1752 const char *context
,
1754 const struct kvp
*p
,
1759 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1760 if((result
= kvp_get(p
, pref
)))
1763 result
= trackname_part(track
, context
, part
);
1764 assert(result
!= 0);
1768 /* get a track name part, like trackname_part(), but taking the database into
1770 const char *trackdb_getpart(const char *track
,
1771 const char *context
,
1779 /* construct the full pref */
1780 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1782 tid
= trackdb_begin_transaction();
1783 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1787 trackdb_abort_transaction(tid
);
1789 trackdb_commit_transaction(tid
);
1790 return getpart(actual
, context
, part
, p
, &used_db
);
1793 /* get the raw path name for @track@ (might be an alias) */
1794 const char *trackdb_rawpath(const char *track
) {
1800 tid
= trackdb_begin_transaction();
1801 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1805 trackdb_abort_transaction(tid
);
1807 trackdb_commit_transaction(tid
);
1808 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1812 /* trackdb_list **************************************************************/
1814 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1815 * readable at some point */
1817 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1818 * If RE is a null pointer then it matches everything. */
1819 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1827 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1828 case PCRE_ERROR_NOMATCH
: return 0;
1831 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1838 static int do_list(struct vector
*v
, const char *dir
,
1839 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1845 size_t l
, last_dir_len
= 0;
1846 char *last_dir
= 0, *track
, *alias
;
1850 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1853 /* find the first key >= dir */
1854 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1855 /* keep going while we're dealing with <dir/anything> */
1858 && ((char *)k
.data
)[dl
] == '/'
1859 && !memcmp(k
.data
, dir
, dl
)) {
1860 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1862 /* we have <dir/component/anything>, so <dir/component> is a directory */
1863 l
= ptr
- (char *)k
.data
;
1864 if(what
& trackdb_directories
)
1866 && l
== last_dir_len
1867 && !memcmp(last_dir
, k
.data
, l
))) {
1868 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1869 if(track_matches(dl
, k
.data
, l
, re
))
1870 vector_append(v
, last_dir
);
1873 /* found a plain file */
1874 if((what
& trackdb_files
)) {
1875 track
= xstrndup(k
.data
, k
.size
);
1876 if((err
= trackdb_getdata(trackdb_prefsdb
,
1877 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1879 /* if this file has an alias in the same directory then we skip it */
1880 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1882 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1883 if(track_matches(dl
, k
.data
, k
.size
, re
))
1884 vector_append(v
, track
);
1887 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1895 case DB_LOCK_DEADLOCK
:
1896 error(0, "error querying database: %s", db_strerror(err
));
1899 fatal(0, "error querying database: %s", db_strerror(err
));
1902 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1906 /* return the directories or files below @dir@ */
1907 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1915 tid
= trackdb_begin_transaction();
1918 if(do_list(&v
, dir
, what
, re
, tid
))
1921 for(n
= 0; n
< config
->collection
.n
; ++n
)
1922 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1927 trackdb_abort_transaction(tid
);
1929 trackdb_commit_transaction(tid
);
1930 vector_terminate(&v
);
1936 /* If S is tag:something, return something. Else return 0. */
1937 static const char *checktag(const char *s
) {
1938 if(!strncmp(s
, "tag:", 4))
1944 /* return a list of tracks containing all of the words given. If you
1945 * ask for only stopwords you get no tracks. */
1946 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1947 const char **w
, *best
= 0, *tag
;
1948 char **twords
, **tags
;
1950 int i
, j
, n
, err
, what
;
1960 *ntracks
= 0; /* for early returns */
1961 /* normalize all the words */
1962 w
= xmalloc(nwordlist
* sizeof (char *));
1963 istag
= xmalloc_noptr(nwordlist
);
1964 for(n
= 0; n
< nwordlist
; ++n
) {
1968 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1969 if(checktag(w
[n
])) {
1970 ++ntags
; /* count up tags */
1971 /* Normalize the tag */
1972 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
1975 /* Normalize the search term by removing combining characters */
1976 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1978 nw32
= remove_combining_chars(w32
, nw32
);
1979 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1984 /* find the longest non-stopword */
1985 for(n
= 0; n
< nwordlist
; ++n
)
1986 if(!istag
[n
] && !stopword(w
[n
]))
1987 if(!best
|| strlen(w
[n
]) > strlen(best
))
1989 /* TODO: we should at least in principal be able to identify the word or tag
1990 * with the least matches in log time, and choose that as our primary search
1992 if(ntags
&& !best
) {
1993 /* Only tags are listed. We limit to the first and narrow down with the
1995 best
= istag
[0] ? w
[0] : 0;
1996 db
= trackdb_tagsdb
;
1999 /* We can limit to some word. */
2000 db
= trackdb_searchdb
;
2003 /* Only stopwords */
2009 tid
= trackdb_begin_transaction();
2010 /* find all the tracks that have that word */
2015 cursor
= trackdb_opencursor(db
, tid
);
2016 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2017 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2024 case DB_LOCK_DEADLOCK
:
2025 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2028 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2030 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2032 /* do a naive search over that (hopefuly fairly small) list of tracks */
2034 for(n
= 0; n
< v
.nvec
; ++n
) {
2035 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2038 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2041 twords
= track_to_words(v
.vec
[n
], p
);
2042 tags
= parsetags(kvp_get(p
, "tags"));
2043 for(i
= 0; i
< nwordlist
; ++i
) {
2046 /* Track must have this tag */
2047 for(j
= 0; tags
[j
]; ++j
)
2048 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2049 if(!tags
[j
]) break; /* tag not found */
2051 /* Track must contain this word */
2052 for(j
= 0; twords
[j
]; ++j
)
2053 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2054 if(!twords
[j
]) break; /* word not found */
2057 if(i
>= nwordlist
) /* all words found */
2058 vector_append(&u
, v
.vec
[n
]);
2062 trackdb_closecursor(cursor
);
2064 trackdb_abort_transaction(tid
);
2065 info("retrying search");
2067 trackdb_commit_transaction(tid
);
2068 vector_terminate(&u
);
2074 /* trackdb_scan **************************************************************/
2076 int trackdb_scan(const char *root
,
2077 int (*callback
)(const char *track
,
2086 const size_t root_len
= root ?
strlen(root
) : 0;
2088 struct kvp
*data
, *prefs
;
2091 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2093 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2096 memset(&k
, 0, sizeof k
);
2097 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2102 || (k
.size
> root_len
2103 && !strncmp(k
.data
, root
, root_len
)
2104 && ((char *)k
.data
)[root_len
] == '/')) {
2105 data
= kvp_urldecode(d
.data
, d
.size
);
2106 if(kvp_get(data
, "_path")) {
2107 track
= xstrndup(k
.data
, k
.size
);
2108 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2109 * do a lookup for every single track. In fact this is quite quick:
2110 * with around 10,000 tracks a complete scan is around 0.3s on my
2111 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2112 * linear walk as we already do over trackdb_tracksdb, and probably get
2113 * even higher performance. That would require upgrade logic to
2114 * translate old databases though.
2116 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2117 prepare_data(&pd
), 0)) {
2119 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2124 case DB_LOCK_DEADLOCK
:
2125 error(0, "getting prefs: %s", db_strerror(err
));
2126 trackdb_closecursor(cursor
);
2129 fatal(0, "getting prefs: %s", db_strerror(err
));
2131 /* Advance to the next track before the callback so that the callback
2132 * may safely delete the track */
2133 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2134 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2139 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2143 trackdb_closecursor(cursor
);
2150 case DB_LOCK_DEADLOCK
:
2151 error(0, "c->c_get: %s", db_strerror(err
));
2154 fatal(0, "c->c_get: %s", db_strerror(err
));
2158 /* trackdb_rescan ************************************************************/
2160 /** @brief Node in the list of rescan-complete callbacks */
2161 struct rescanned_node
{
2162 struct rescanned_node
*next
;
2163 void (*rescanned
)(void *ru
);
2167 /** @brief List of rescan-complete callbacks */
2168 static struct rescanned_node
*rescanned_list
;
2170 /** @brief Add a rescan completion callback */
2171 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2174 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2175 n
->next
= rescanned_list
;
2176 n
->rescanned
= rescanned
;
2182 /* called when the rescanner terminates */
2183 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2186 const struct rusage
attribute((unused
)) *rusage
,
2187 void attribute((unused
)) *u
) {
2188 if(pid
== rescan_pid
) rescan_pid
= -1;
2190 error(0, RESCAN
": %s", wstat(status
));
2192 D((RESCAN
" terminated: %s", wstat(status
)));
2193 /* Our cache of file lookups is out of date now */
2194 cache_clean(&cache_files_type
);
2195 eventlog("rescanned", (char *)0);
2196 /* Call rescanned callbacks */
2197 while(rescanned_list
) {
2198 void (*rescanned
)(void *u
) = rescanned_list
->rescanned
;
2199 void *ru
= rescanned_list
->ru
;
2201 rescanned_list
= rescanned_list
->next
;
2207 /** @brief Initiate a rescan
2208 * @param ev Event loop or 0 to block
2209 * @param recheck 1 to recheck lengths, 0 to suppress check
2210 * @param rescanned Called on completion (if not NULL)
2211 * @param u Passed to @p rescanned
2213 void trackdb_rescan(ev_source
*ev
, int recheck
,
2214 void (*rescanned
)(void *ru
),
2218 if(rescan_pid
!= -1) {
2219 trackdb_add_rescanned(rescanned
, ru
);
2220 error(0, "rescan already underway");
2223 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2224 recheck ?
"--check" : "--no-check",
2226 trackdb_add_rescanned(rescanned
, ru
);
2228 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2229 D(("started rescanner"));
2231 /* This is the first rescan, we block until it is complete */
2232 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2234 reap_rescan(0, rescan_pid
, w
, 0, 0);
2238 int trackdb_rescan_cancel(void) {
2239 if(rescan_pid
== -1) return 0;
2240 if(kill(rescan_pid
, SIGTERM
) < 0)
2241 fatal(errno
, "error killing rescanner");
2246 /** @brief Return true if a rescan is underway */
2247 int trackdb_rescan_underway(void) {
2248 return rescan_pid
!= -1;
2251 /* global prefs **************************************************************/
2253 void trackdb_set_global(const char *name
,
2261 tid
= trackdb_begin_transaction();
2262 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2264 trackdb_abort_transaction(tid
);
2266 trackdb_commit_transaction(tid
);
2267 /* log important state changes */
2268 if(!strcmp(name
, "playing")) {
2269 state
= !value
|| !strcmp(value
, "yes");
2270 info("playing %s by %s",
2271 state ?
"enabled" : "disabled",
2273 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2275 if(!strcmp(name
, "random-play")) {
2276 state
= !value
|| !strcmp(value
, "yes");
2277 info("random play %s by %s",
2278 state ?
"enabled" : "disabled",
2280 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2284 int trackdb_set_global_tid(const char *name
,
2290 memset(&k
, 0, sizeof k
);
2291 memset(&d
, 0, sizeof d
);
2292 k
.data
= (void *)name
;
2293 k
.size
= strlen(name
);
2295 d
.data
= (void *)value
;
2296 d
.size
= strlen(value
);
2299 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2301 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2302 if(err
== DB_LOCK_DEADLOCK
) return err
;
2304 fatal(0, "error updating database: %s", db_strerror(err
));
2308 const char *trackdb_get_global(const char *name
) {
2314 tid
= trackdb_begin_transaction();
2315 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2317 trackdb_abort_transaction(tid
);
2319 trackdb_commit_transaction(tid
);
2323 int trackdb_get_global_tid(const char *name
,
2329 memset(&k
, 0, sizeof k
);
2330 k
.data
= (void *)name
;
2331 k
.size
= strlen(name
);
2332 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2333 prepare_data(&d
), 0)) {
2335 *rp
= xstrndup(d
.data
, d
.size
);
2340 case DB_LOCK_DEADLOCK
:
2343 fatal(0, "error reading database: %s", db_strerror(err
));
2347 /** @brief Retrieve the most recently added tracks
2348 * @param ntracksp Where to put count, or 0
2349 * @param maxtracks Maximum number of tracks to retrieve
2350 * @return null-terminated array of track names
2352 * The most recently added track is first in the array.
2354 char **trackdb_new(int *ntracksp
,
2360 tid
= trackdb_begin_transaction();
2361 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2364 trackdb_abort_transaction(tid
);
2366 trackdb_commit_transaction(tid
);
2370 /** @brief Retrieve the most recently added tracks
2371 * @param ntracksp Where to put count, or 0
2372 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2373 * @param tid Transaction ID
2374 * @return null-terminated array of track names, or NULL on deadlock
2376 * The most recently added track is first in the array.
2378 static char **trackdb_new_tid(int *ntracksp
,
2384 struct vector tracks
[1];
2386 vector_init(tracks
);
2387 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2388 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2389 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2390 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2392 case 0: /* hit maxtracks */
2393 case DB_NOTFOUND
: /* ran out of tracks */
2395 case DB_LOCK_DEADLOCK
:
2396 trackdb_closecursor(c
);
2399 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2401 if((err
= trackdb_closecursor(c
)))
2402 return 0; /* deadlock */
2403 vector_terminate(tracks
);
2405 *ntracksp
= tracks
->nvec
;
2409 /** @brief Expire noticed.db
2410 * @param earliest Earliest timestamp to keep
2412 void trackdb_expire_noticed(time_t earliest
) {
2416 tid
= trackdb_begin_transaction();
2417 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2419 trackdb_abort_transaction(tid
);
2421 trackdb_commit_transaction(tid
);
2424 /** @brief Expire noticed.db
2425 * @param earliest Earliest timestamp to keep
2426 * @param tid Transaction ID
2427 * @return 0 or DB_LOCK_DEADLOCK
2429 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2437 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2438 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2440 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2441 if(when
>= earliest
)
2443 if((err
= c
->c_del(c
, 0))) {
2444 if(err
!= DB_LOCK_DEADLOCK
)
2445 fatal(0, "error deleting expired noticed.db entry: %s",
2451 if(err
== DB_NOTFOUND
)
2453 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2454 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2456 if((err
= trackdb_closecursor(c
))) {
2457 if(err
!= DB_LOCK_DEADLOCK
)
2458 fatal(0, "error closing cursor: %s", db_strerror(err
));
2462 info("expired %d tracks from noticed.db", count
);
2466 /* tidying up ****************************************************************/
2468 void trackdb_gc(void) {
2472 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2473 config
->checkpoint_kbyte
,
2474 config
->checkpoint_min
,
2476 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2477 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2478 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2479 /* This makes catastrophic recovery impossible. However, the user can still
2480 * preserve the important data by using disorder-dump to snapshot their
2481 * prefs, and later to restore it. This is likely to have much small
2482 * long-term storage requirements than record the db logfiles. */
2485 /* user database *************************************************************/
2487 /** @brief Return true if @p user is trusted */
2488 static int trusted(const char *user
) {
2491 for(n
= 0; (n
< config
->trust
.n
2492 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2494 return n
< config
->trust
.n
;
2497 /** @brief Return non-zero for a valid username
2499 * Currently we only allow the letters and digits in ASCII. We could be more
2500 * liberal than this but it is a nice simple test. It is critical that
2501 * semicolons are never allowed.
2503 static int valid_username(const char *user
) {
2507 const uint8_t c
= *user
++;
2508 /* For now we are very strict */
2509 if((c
>= 'a' && c
<= 'z')
2510 || (c
>= 'A' && c
<= 'Z')
2511 || (c
>= '0' && c
<= '9'))
2519 /** @brief Add a user */
2520 static int create_user(const char *user
,
2521 const char *password
,
2524 const char *confirmation
,
2530 /* sanity check user */
2531 if(!valid_username(user
)) {
2532 error(0, "invalid username '%s'", user
);
2535 if(parse_rights(rights
, 0, 1)) {
2536 error(0, "invalid rights string");
2539 /* data for this user */
2541 kvp_set(&k
, "password", password
);
2542 kvp_set(&k
, "rights", rights
);
2544 kvp_set(&k
, "email", email
);
2546 kvp_set(&k
, "confirmation", confirmation
);
2547 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2548 kvp_set(&k
, "created", s
);
2549 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2552 /** @brief Add one pre-existing user */
2553 static int one_old_user(const char *user
, const char *password
,
2557 /* www-data doesn't get added */
2558 if(!strcmp(user
, "www-data")) {
2559 info("not adding www-data to user database");
2563 if(!strcmp(user
, "root"))
2565 else if(trusted(user
)) {
2568 parse_rights(config
->default_rights
, &r
, 1);
2569 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2570 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2571 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2572 rights
= rights_string(r
);
2574 rights
= config
->default_rights
;
2575 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2576 tid
, DB_NOOVERWRITE
);
2579 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2582 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2583 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2586 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2589 error(0, "user %s already exists, delete 'allow' directive",
2590 config
->allow
.s
[n
].s
[0]);
2591 /* This won't ever become fatal - eventually 'allow' will be
2594 case DB_LOCK_DEADLOCK
:
2595 return DB_LOCK_DEADLOCK
;
2601 /** @brief Read old 'allow' directives and copy them to the users database */
2602 void trackdb_old_users(void) {
2606 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2609 /** @brief Create a root user in the user database if there is none */
2610 void trackdb_create_root(void) {
2615 /* Choose a new root password */
2616 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2617 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2618 /* Create the root user if it does not exist */
2619 WITH_TRANSACTION(create_user("root", pw
, "all",
2620 0/*email*/, 0/*confirmation*/,
2621 tid
, DB_NOOVERWRITE
));
2623 info("created root user");
2626 /** @brief Find a user's password from the database
2627 * @param user Username
2628 * @return Password or NULL
2630 * Only works if running as a user that can read the database!
2632 * If the user exists but has no password, "" is returned.
2634 const char *trackdb_get_password(const char *user
) {
2637 const char *password
;
2639 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2642 password
= kvp_get(k
, "password");
2643 return password ? password
: "";
2646 /** @brief Add a new user
2647 * @param user Username
2648 * @param password Password or NULL
2649 * @param rights Initial rights
2650 * @param email Email address or NULL
2651 * @param confirmation Confirmation string or NULL
2652 * @return 0 on success, non-0 on error
2654 int trackdb_adduser(const char *user
,
2655 const char *password
,
2658 const char *confirmation
) {
2661 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2662 tid
, DB_NOOVERWRITE
));
2664 error(0, "cannot create user '%s' because they already exist", user
);
2668 info("created user '%s' with rights '%s' and email address '%s'",
2669 user
, rights
, email
);
2671 info("created user '%s' with rights '%s'", user
, rights
);
2676 /** @brief Delete a user
2677 * @param user User to delete
2678 * @return 0 on success, non-0 if the user didn't exist anyway
2680 int trackdb_deluser(const char *user
) {
2683 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2685 error(0, "cannot delete user '%s' because they do not exist", user
);
2688 info("deleted user '%s'", user
);
2692 /** @brief Get user information
2693 * @param user User to query
2694 * @return Linked list of user information or NULL if user does not exist
2696 * Every user has at least a @c rights entry so NULL can be used to mean no
2699 struct kvp
*trackdb_getuserinfo(const char *user
) {
2703 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2710 /** @brief Edit user information
2711 * @param user User to edit
2712 * @param key Key to change
2713 * @param value Value to set, or NULL to remove
2714 * @param tid Transaction ID
2715 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2717 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2718 const char *value
, DB_TXN
*tid
) {
2722 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2724 if(!kvp_set(&k
, key
, value
))
2725 return 0; /* no change */
2726 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2729 /** @brief Edit user information
2730 * @param user User to edit
2731 * @param key Key to change
2732 * @param value Value to set, or NULL to remove
2733 * @return 0 on success, non-0 on error
2735 int trackdb_edituserinfo(const char *user
,
2736 const char *key
, const char *value
) {
2739 if(!strcmp(key
, "rights")) {
2741 error(0, "cannot remove 'rights' key from user '%s'", user
);
2744 if(parse_rights(value
, 0, 1)) {
2745 error(0, "invalid rights string");
2748 } else if(!strcmp(key
, "email")) {
2750 if(!strchr(value
, '@')) {
2751 error(0, "invalid email address '%s' for user '%s'", user
, value
);
2755 value
= 0; /* no email -> remove key */
2756 } else if(!strcmp(key
, "created")) {
2757 error(0, "cannot change creation date for user '%s'", user
);
2759 } else if(strcmp(key
, "password")
2760 && !strcmp(key
, "confirmation")) {
2761 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2764 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2766 error(0, "unknown user '%s'", user
);
2772 /** @brief List all users
2773 * @return NULL-terminated list of users
2775 char **trackdb_listusers(void) {
2780 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2784 /** @brief Confirm a user registration
2785 * @param user Username
2786 * @param confirmation Confirmation string
2787 * @param rightsp Where to put user rights
2788 * @param tid Transaction ID
2789 * @return 0 on success, non-0 on error
2791 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2792 rights_type
*rightsp
,
2794 const char *stored_confirmation
;
2799 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2801 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2802 error(0, "already confirmed user '%s'", user
);
2803 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2806 if(!(rights
= kvp_get(k
, "rights"))) {
2807 error(0, "no rights for unconfirmed user '%s'", user
);
2810 if(parse_rights(rights
, rightsp
, 1))
2812 if(strcmp(confirmation
, stored_confirmation
)) {
2813 error(0, "wrong confirmation string for user '%s'", user
);
2817 kvp_set(&k
, "confirmation", 0);
2818 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2821 /** @brief Confirm a user registration
2822 * @param user Username
2823 * @param confirmation Confirmation string
2824 * @param rightsp Where to put user rights
2825 * @return 0 on success, non-0 on error
2827 int trackdb_confirm(const char *user
, const char *confirmation
,
2828 rights_type
*rightsp
) {
2831 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2834 info("registration confirmed for user '%s'", user
);
2837 error(0, "confirmation for nonexistent user '%s'", user
);
2839 default: /* already reported */
2849 indent-tabs-mode:nil