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...
29 #include <sys/socket.h>
35 #include <sys/resource.h>
37 #include <arpa/inet.h>
49 #include "configuration.h"
54 #include "trackname.h"
55 #include "trackdb-int.h"
64 #define RESCAN "disorder-rescan"
65 #define DEADLOCK "disorder-deadlock"
67 static const char *getpart(const char *track
,
72 static char **trackdb_new_tid(int *ntracksp
,
75 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
76 static char *normalize_tag(const char *s
, size_t ns
);
78 const struct cache_type cache_files_type
= { 86400 };
79 unsigned long cache_files_hits
, cache_files_misses
;
81 /** @brief Set by trackdb_open() */
82 int trackdb_existing_database
;
84 /* setup and teardown ********************************************************/
86 static const char *home
; /* home had better not change */
87 DB_ENV
*trackdb_env
; /* db environment */
89 /** @brief The tracks database
90 * - Keys are UTF-8(NFC(unicode(path name)))
91 * - Values are encoded key-value pairs
92 * - Data is reconstructable data about tracks that currently exist
96 /** @brief The preferences database
98 * - Keys are UTF-8(NFC(unicode(path name)))
99 * - Values are encoded key-value pairs
100 * - Data is user data about tracks (that might not exist any more)
101 * and cannot be reconstructed
105 /** @brief The search database
107 * - Keys are UTF-8(NFKC(casefold(search term)))
108 * - Values are UTF-8(NFC(unicode(path name)))
109 * - There can be more than one value per key
110 * - Presence of key,value means that path matches the search terms
111 * - Only tracks fond in @ref trackdb_tracksdb are represented here
112 * - This database can be reconstructed, it contains no user data
114 DB
*trackdb_searchdb
;
116 /** @brief The tags database
118 * - Keys are UTF-8(NFKC(casefold(tag)))
119 * - Values are UTF-8(NFC(unicode(path name)))
120 * - There can be more than one value per key
121 * - Presence of key,value means that path matches the tag
122 * - This is always in sync with the tags preference
123 * - This database can be reconstructed, it contains no user data
125 DB
*trackdb_tagsdb
; /* the tags database */
127 /** @brief The global preferences database
128 * - Keys are UTF-8(NFC(preference))
129 * - Values are global preference values
130 * - Data is user data and cannot be reconstructed
132 DB
*trackdb_globaldb
; /* global preferences */
134 /** @brief The noticed database
135 * - Keys are 64-bit big-endian timestamps
136 * - Values are UTF-8(NFC(unicode(path name)))
137 * - There can be more than one value per key
138 * - Presence of key,value means that path was added at the given time
139 * - Data cannot be reconstructed (but isn't THAT important)
141 DB
*trackdb_noticeddb
; /* when track noticed */
143 /** @brief The schedule database
145 * - Keys are ID strings, generated at random
146 * - Values are encoded key-value pairs
147 * - There can be more than one value per key
148 * - Data cannot be reconstructed
150 * See @ref server/schedule.c for further information.
152 DB
*trackdb_scheduledb
;
154 /** @brief The user database
155 * - Keys are usernames
156 * - Values are encoded key-value pairs
157 * - Data is user data and cannot be reconstructed
161 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
162 static pid_t rescan_pid
= -1; /* rescanner PID */
163 static int initialized
, opened
; /* state */
165 /* comparison function for keys */
166 static int compare(DB
attribute((unused
)) *db_
,
167 const DBT
*a
, const DBT
*b
) {
168 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
171 /** @brief Test whether the track database can be read
172 * @return 1 if it can, 0 if it cannot
174 int trackdb_readable(void) {
177 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
178 return access(usersdb
, R_OK
) == 0;
181 /** @brief Open database environment
182 * @param flags Flags word
184 * Flags should be one of:
185 * - @ref TRACKDB_NO_RECOVER
186 * - @ref TRACKDB_NORMAL_RECOVER
187 * - @ref TRACKDB_FATAL_RECOVER
188 * - @ref TRACKDB_MAY_CREATE
190 void trackdb_init(int flags
) {
192 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
193 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
196 assert(initialized
== 0);
199 if(strcmp(home
, config
->home
))
200 fatal(0, "cannot change db home without server restart");
204 if(flags
& TRACKDB_MAY_CREATE
) {
210 /* Remove world/group permissions on any regular files already in the
211 * database directory. Actually we don't care about all of them but it's
212 * easier to just do the lot. This can be revisited if it's a serious
213 * practical inconvenience for anyone.
215 * The socket, not being a regular file, is excepted.
217 if(!(dp
= opendir(config
->home
)))
218 fatal(errno
, "error reading %s", config
->home
);
219 while((de
= readdir(dp
))) {
220 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
221 if(lstat(p
, &st
) == 0
222 && S_ISREG(st
.st_mode
)
223 && (st
.st_mode
& 077)) {
224 if(chmod(p
, st
.st_mode
& 07700) < 0)
225 fatal(errno
, "cannot chmod %s", p
);
232 /* create environment */
233 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
235 if((err
= trackdb_env
->set_alloc(trackdb_env
,
236 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
237 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
238 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
239 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
240 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
241 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
242 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
248 |recover_type
[recover
],
250 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
251 trackdb_env
->set_errpfx(trackdb_env
, "DB");
252 trackdb_env
->set_errfile(trackdb_env
, stderr
);
253 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
254 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
255 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
256 D(("initialized database environment"));
259 /* called when deadlock manager terminates */
260 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
261 pid_t
attribute((unused
)) pid
,
263 const struct rusage
attribute((unused
)) *rusage
,
264 void attribute((unused
)) *u
) {
265 db_deadlock_pid
= -1;
267 fatal(0, "deadlock manager unexpectedly terminated: %s",
270 D(("deadlock manager terminated: %s", wstat(status
)));
274 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
278 const char *args
[1024], **argp
, *a
;
282 *argp
++ = "--config";
283 *argp
++ = configfile
;
284 *argp
++ = debugging ?
"--debug" : "--no-debug";
285 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
287 while((a
= va_arg(ap
, const char *)))
291 /* If we're in the background then trap subprocess stdout/stderr */
292 if(!(pid
= xfork())) {
295 ev_signal_atfork(ev
);
296 signal(SIGPIPE
, SIG_DFL
);
301 /* ensure we don't leak privilege anywhere */
302 if(setuid(geteuid()) < 0)
303 fatal(errno
, "error calling setuid");
304 /* If we were negatively niced, undo it. We don't bother checking for
305 * error, it's not that important. */
306 setpriority(PRIO_PROCESS
, 0, 0);
307 execvp(prog
, (char **)args
);
308 fatal(errno
, "error invoking %s", prog
);
313 /* start deadlock manager */
314 void trackdb_master(ev_source
*ev
) {
315 assert(db_deadlock_pid
== -1);
316 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
317 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
318 D(("started deadlock manager"));
321 /* close environment */
322 void trackdb_deinit(void) {
326 assert(initialized
== 1);
329 /* close the environment */
330 if((err
= trackdb_env
->close(trackdb_env
, 0)))
331 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
333 if(rescan_pid
!= -1) {
334 /* shut down the rescanner */
335 if(kill(rescan_pid
, SIGTERM
) < 0)
336 fatal(errno
, "error killing rescanner");
337 /* wait for the rescanner to finish */
338 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
342 /* TODO kill any stats subprocesses */
344 /* finally terminate the deadlock manager */
345 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
346 fatal(errno
, "error killing deadlock manager");
347 db_deadlock_pid
= -1;
349 D(("deinitialized database environment"));
352 /* open a specific database */
353 static DB
*open_db(const char *path
,
361 D(("open %s", path
));
362 path
= config_get_file(path
);
363 if((err
= db_create(&db
, trackdb_env
, 0)))
364 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
366 if((err
= db
->set_flags(db
, dbflags
)))
367 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
368 if(dbtype
== DB_BTREE
)
369 if((err
= db
->set_bt_compare(db
, compare
)))
370 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
371 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
372 openflags
| DB_AUTO_COMMIT
, mode
))) {
373 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
374 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
381 /** @brief Open track databases
382 * @param flags Flags flags word
384 * @p flags should have one of:
385 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
386 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
387 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
389 * - @p TRACKDB_READ_ONLY, read only access
391 void trackdb_open(int flags
) {
394 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
399 /* check the database version first */
400 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
401 if(trackdb_globaldb
) {
402 /* This is an existing database */
406 s
= trackdb_get_global("_dbversion");
407 /* Close the database again, we'll open it property below */
408 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
409 fatal(0, "error closing global.db: %s", db_strerror(err
));
410 trackdb_globaldb
= 0;
411 /* Convert version string to an integer */
412 oldversion
= s ?
atol(s
) : 1;
413 if(oldversion
> config
->dbversion
) {
414 /* Database is from the future; we never allow this. */
415 fatal(0, "this version of DisOrder is too old for database version %ld",
418 if(oldversion
< config
->dbversion
) {
419 /* Database version is out of date */
420 switch(flags
& TRACKDB_UPGRADE_MASK
) {
421 case TRACKDB_NO_UPGRADE
:
422 /* This database needs upgrading but this is not permitted */
423 fatal(0, "database needs upgrading from %ld to %ld",
424 oldversion
, config
->dbversion
);
425 case TRACKDB_CAN_UPGRADE
:
426 /* This database needs upgrading */
427 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
428 oldversion
, config
->dbversion
);
429 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
430 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
433 fatal(0, "disorder-dbupgrade %s", wstat(err
));
434 info("disorder-dbupgrade succeeded");
436 case TRACKDB_OPEN_FOR_UPGRADE
:
442 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
443 /* This doesn't make any sense */
444 fatal(0, "database is already at current version");
446 trackdb_existing_database
= 1;
448 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
449 /* Cannot upgrade a new database */
450 fatal(0, "cannot upgrade a database that does not exist");
452 /* This is a brand new database */
453 trackdb_existing_database
= 0;
455 /* open the databases */
456 if(!(trackdb_usersdb
= open_db("users.db",
457 0, DB_HASH
, dbflags
, 0600)))
458 fatal(0, "cannot open users.db");
459 trackdb_tracksdb
= open_db("tracks.db",
460 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
461 trackdb_searchdb
= open_db("search.db",
462 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
463 trackdb_tagsdb
= open_db("tags.db",
464 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
465 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
466 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
467 trackdb_noticeddb
= open_db("noticed.db",
468 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
469 trackdb_scheduledb
= open_db("schedule.db", 0, DB_HASH
, dbflags
, 0666);
470 if(!trackdb_existing_database
) {
471 /* Stash the database version */
474 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
475 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
476 trackdb_set_global("_dbversion", buf
, 0);
478 D(("opened databases"));
481 /* close track databases */
482 void trackdb_close(void) {
488 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
489 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
490 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
491 fatal(0, "error closing search.db: %s", db_strerror(err
));
492 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
493 fatal(0, "error closing tags.db: %s", db_strerror(err
));
494 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
495 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
496 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
497 fatal(0, "error closing global.db: %s", db_strerror(err
));
498 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
499 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
500 if((err
= trackdb_scheduledb
->close(trackdb_scheduledb
, 0)))
501 fatal(0, "error closing schedule.db: %s", db_strerror(err
));
502 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
503 fatal(0, "error closing users.db: %s", db_strerror(err
));
504 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
505 trackdb_tagsdb
= trackdb_globaldb
= 0;
506 D(("closed databases"));
509 /* generic db routines *******************************************************/
511 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
512 * DB_LOCK_DEADLOCK. */
513 int trackdb_getdata(DB
*db
,
520 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
521 prepare_data(&data
), 0)) {
523 *kp
= kvp_urldecode(data
.data
, data
.size
);
528 case DB_LOCK_DEADLOCK
:
529 error(0, "error querying database: %s", db_strerror(err
));
532 fatal(0, "error querying database: %s", db_strerror(err
));
536 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
537 * DB_LOCK_DEADLOCK. */
538 int trackdb_putdata(DB
*db
,
546 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
547 encode_data(&data
, k
), flags
)) {
551 case DB_LOCK_DEADLOCK
:
552 error(0, "error updating database: %s", db_strerror(err
));
555 fatal(0, "error updating database: %s", db_strerror(err
));
559 /** @brief Delete a database entry
561 * @param track Key to delete
562 * @param tid Transaction ID
563 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
565 int trackdb_delkey(DB
*db
,
571 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
575 case DB_LOCK_DEADLOCK
:
576 error(0, "error updating database: %s", db_strerror(err
));
579 fatal(0, "error updating database: %s", db_strerror(err
));
583 /* open a database cursor */
584 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
588 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
590 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
595 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
596 int trackdb_closecursor(DBC
*c
) {
600 switch(err
= c
->c_close(c
)) {
603 case DB_LOCK_DEADLOCK
:
604 error(0, "error closing cursor: %s", db_strerror(err
));
607 fatal(0, "error closing cursor: %s", db_strerror(err
));
611 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
612 int trackdb_delkeydata(DB
*db
,
620 c
= trackdb_opencursor(db
, tid
);
621 switch(err
= c
->c_get(c
, make_key(&key
, word
),
622 make_key(&data
, track
), DB_GET_BOTH
)) {
624 switch(err
= c
->c_del(c
, 0)) {
630 case DB_LOCK_DEADLOCK
:
631 error(0, "error updating database: %s", db_strerror(err
));
634 fatal(0, "c->c_del: %s", db_strerror(err
));
639 case DB_LOCK_DEADLOCK
:
640 error(0, "error updating database: %s", db_strerror(err
));
643 fatal(0, "c->c_get: %s", db_strerror(err
));
645 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
649 /* start a transaction */
650 DB_TXN
*trackdb_begin_transaction(void) {
654 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
655 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
659 /* abort transaction */
660 void trackdb_abort_transaction(DB_TXN
*tid
) {
664 if((err
= tid
->abort(tid
)))
665 fatal(0, "tid->abort: %s", db_strerror(err
));
668 /* commit transaction */
669 void trackdb_commit_transaction(DB_TXN
*tid
) {
672 if((err
= tid
->commit(tid
, 0)))
673 fatal(0, "tid->commit: %s", db_strerror(err
));
676 /* search/tags shared code ***************************************************/
678 /* comparison function used by dedupe() */
679 static int wordcmp(const void *a
, const void *b
) {
680 return strcmp(*(const char **)a
, *(const char **)b
);
683 /* sort and de-dupe VEC */
684 static char **dedupe(char **vec
, int nvec
) {
687 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
691 for(n
= 1; n
< nvec
; ++n
)
692 if(strcmp(vec
[n
], vec
[m
- 1]))
699 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
700 static int register_word(DB
*db
, const char *what
,
701 const char *track
, const char *word
,
706 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
707 make_key(&data
, track
), DB_NODUPDATA
)) {
711 case DB_LOCK_DEADLOCK
:
712 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
715 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
719 /* search primitives *********************************************************/
721 /* return true iff NAME is a trackname_display_ pref */
722 static int is_display_pref(const char *name
) {
723 static const char prefix
[] = "trackname_display_";
724 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
727 /** @brief Word_Break property tailor that treats underscores as spaces */
728 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
732 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
733 return unicode_Word_Break_Other
;
737 /** @brief Remove all combining characters in-place
738 * @param s Pointer to start of string
739 * @param ns Length of string
740 * @return New, possiblby reduced, length
742 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
743 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
746 const uint32_t c
= *s
++;
747 if(!utf32_combining_class(c
))
753 /** @brief Normalize and split a string using a given tailoring */
754 static void word_split(struct vector
*v
,
756 unicode_property_tailor
*pt
) {
758 uint32_t *t32
, **w32
;
760 /* Convert to UTF-32 */
761 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
763 /* Erase case distinctions */
764 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
766 /* Drop combining characters */
767 nt32
= remove_combining_chars(t32
, nt32
);
768 /* Split into words, treating _ as a space */
769 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
770 /* Convert words back to UTF-8 and append to result */
771 for(i
= 0; i
< nw
; ++i
)
772 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
775 /** @brief Normalize a tag
777 * @param ns Length of tag
778 * @return Normalized string or NULL on error
780 * The return value will be:
782 * - have no leading or trailing space
783 * - have no combining characters
784 * - all spacing between words will be a single U+0020 SPACE
786 static char *normalize_tag(const char *s
, size_t ns
) {
787 uint32_t *s32
, **w32
;
788 size_t ns32
, nw32
, i
;
791 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
793 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
795 ns32
= remove_combining_chars(s32
, ns32
);
796 /* Split into words, no Word_Break tailoring */
797 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
798 /* Compose back into a string */
800 for(i
= 0; i
< nw32
; ++i
) {
802 dynstr_append(d
, ' ');
803 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
809 /* compute the words of a track name */
810 static char **track_to_words(const char *track
,
811 const struct kvp
*p
) {
813 const char *rootless
= track_rootless(track
);
816 rootless
= track
; /* bodge */
818 rootless
= strip_extension(rootless
);
819 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
820 for(; p
; p
= p
->next
)
821 if(is_display_pref(p
->name
))
822 word_split(&v
, p
->value
, 0);
823 vector_terminate(&v
);
824 return dedupe(v
.vec
, v
.nvec
);
827 /* return nonzero iff WORD is a stopword */
828 static int stopword(const char *word
) {
831 for(n
= 0; n
< config
->stopword
.n
832 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
834 return n
< config
->stopword
.n
;
837 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
838 static int register_search_word(const char *track
, const char *word
,
840 if(stopword(word
)) return 0;
841 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
844 /* Tags **********************************************************************/
846 /* Return nonzero if C is a valid tag character */
847 static int tagchar(int c
) {
856 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
857 char **parsetags(const char *s
) {
863 /* skip initial separators */
864 while(*s
&& (!tagchar(*s
) || *s
== ' '))
867 /* find the extent of the tag */
869 while(*s
&& tagchar(*s
))
871 /* strip trailing spaces */
872 while(s
> t
&& s
[-1] == ' ')
874 /* add tag to list */
875 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
876 /* skip intermediate and trailing separators */
877 while(*s
&& (!tagchar(*s
) || *s
== ' '))
881 vector_terminate(&v
);
882 return dedupe(v
.vec
, v
.nvec
);
885 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
886 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
887 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
890 /* aliases *******************************************************************/
892 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
893 * there is no alias sets *aliasp to 0. */
894 static int compute_alias(char **aliasp
,
899 const char *s
= config
->alias
, *t
, *expansion
, *part
;
900 int c
, used_db
= 0, slash_prefix
, err
;
902 const char *const root
= find_track_root(track
);
905 /* Bodge for tracks with no root */
910 dynstr_append_string(&d
, root
);
911 while((c
= (unsigned char)*s
++)) {
913 dynstr_append(&d
, c
);
916 if((slash_prefix
= (*s
== '/')))
919 assert(t
!= 0); /* validated at startup */
920 part
= xstrndup(s
, t
- s
);
921 expansion
= getpart(track
, "display", part
, p
, &used_db
);
923 if(slash_prefix
) dynstr_append(&d
, '/');
924 dynstr_append_string(&d
, expansion
);
926 s
= t
+ 1; /* skip {part} */
928 /* only admit to the alias if we used the db... */
933 dynstr_terminate(&d
);
934 /* ...and the answer differs from the original... */
935 if(!strcmp(track
, d
.vec
)) {
939 /* ...and there isn't already a different track with that name (including as
941 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
943 if((s
= kvp_get(at
, "_alias_for"))
944 && !strcmp(s
, track
)) {
956 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
957 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
958 * Always sets the return values, even if only to null pointers. */
959 static int gettrackdata(const char *track
,
962 const char **actualp
,
964 #define GTD_NOALIAS 0x0001
967 const char *actual
= track
;
968 struct kvp
*t
= 0, *p
= 0;
970 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
971 if((actual
= kvp_get(t
, "_alias_for"))) {
972 if(flags
& GTD_NOALIAS
) {
973 error(0, "alias passed to gettrackdata where real path required");
976 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
981 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
986 if(actualp
) *actualp
= actual
;
992 /* trackdb_notice() **********************************************************/
994 /** @brief notice a possibly new track
995 * @return @c DB_NOTFOUND if new, 0 if already known
997 int trackdb_notice(const char *track
,
1003 tid
= trackdb_begin_transaction();
1004 err
= trackdb_notice_tid(track
, path
, tid
);
1005 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1008 trackdb_abort_transaction(tid
);
1010 trackdb_commit_transaction(tid
);
1014 /** @brief notice a possibly new track
1015 * @param track NFC UTF-8 track name
1016 * @param path Raw path name
1017 * @param tid Transaction ID
1018 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1020 int trackdb_notice_tid(const char *track
,
1024 struct kvp
*t
, *a
, *p
;
1026 char *alias
, **w
, *noticed
;
1029 /* notice whether the tracks.db entry changes */
1031 /* get any existing tracks entry */
1032 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1034 ret
= err
; /* 0 or DB_NOTFOUND */
1035 /* this is a real track */
1036 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1037 t_changed
+= kvp_set(&t
, "_path", path
);
1039 if(ret
== DB_NOTFOUND
) {
1040 /* It's a new track; record the time */
1041 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1042 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1044 /* if we have an alias record it in the database */
1045 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1047 /* won't overwrite someone else's alias as compute_alias() checks */
1048 D(("%s: alias %s", track
, alias
));
1050 kvp_set(&a
, "_alias_for", track
);
1051 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1053 /* update search.db */
1054 w
= track_to_words(track
, p
);
1055 for(n
= 0; w
[n
]; ++n
)
1056 if((err
= register_search_word(track
, w
[n
], tid
)))
1058 /* update tags.db */
1059 w
= parsetags(kvp_get(p
, "tags"));
1060 for(n
= 0; w
[n
]; ++n
)
1061 if((err
= register_tag(track
, w
[n
], tid
)))
1063 /* only store the tracks.db entry if it has changed */
1064 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1066 if(ret
== DB_NOTFOUND
) {
1067 uint32_t timestamp
[2];
1070 timestamp
[0] = htonl((uint64_t)now
>> 32);
1071 timestamp
[1] = htonl((uint32_t)now
);
1072 memset(&key
, 0, sizeof key
);
1073 key
.data
= timestamp
;
1074 key
.size
= sizeof timestamp
;
1075 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1076 make_key(&data
, track
), 0)) {
1078 case DB_LOCK_DEADLOCK
: return err
;
1079 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1085 /* trackdb_obsolete() ********************************************************/
1087 /* obsolete a track */
1088 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1093 if((err
= gettrackdata(track
, 0, &p
, 0,
1094 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1096 else if(err
== DB_NOTFOUND
) return 0;
1097 /* compute the alias, if any, and delete it */
1098 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1100 /* if the alias points to some other track then compute_alias won't
1102 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1103 && err
!= DB_NOTFOUND
)
1106 /* update search.db */
1107 w
= track_to_words(track
, p
);
1108 for(n
= 0; w
[n
]; ++n
)
1109 if(trackdb_delkeydata(trackdb_searchdb
,
1110 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1112 /* update tags.db */
1113 w
= parsetags(kvp_get(p
, "tags"));
1114 for(n
= 0; w
[n
]; ++n
)
1115 if(trackdb_delkeydata(trackdb_tagsdb
,
1116 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1118 /* update tracks.db */
1119 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1121 /* We don't delete the prefs, so they survive temporary outages of the
1122 * (possibly virtual) track filesystem */
1126 /* trackdb_stats() ***********************************************************/
1128 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1129 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1131 static const struct statinfo
{
1134 } statinfo_hash
[] = {
1150 }, statinfo_btree
[] = {
1171 /* look up stats for DB */
1172 static int get_stats(struct vector
*v
,
1174 const struct statinfo
*si
,
1183 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1186 case DB_LOCK_DEADLOCK
:
1187 error(0, "error querying database: %s", db_strerror(err
));
1190 fatal(0, "error querying database: %s", db_strerror(err
));
1192 for(n
= 0; n
< nsi
; ++n
) {
1193 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1194 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1195 vector_append(v
, str
);
1201 /** @brief One entry in the search league */
1202 struct search_entry
{
1207 /** @brief Add a word to the search league
1208 * @param se Pointer to search league
1209 * @param count Maximum size for search league
1210 * @param nse Current size of search league
1211 * @param word New word, or NULL
1212 * @param n How often @p word appears
1213 * @return New size of search league
1215 static int register_search_entry(struct search_entry
*se
,
1222 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1223 /* Find the starting point */
1228 /* Find the insertion point */
1229 while(i
> 0 && n
> se
[i
- 1].n
)
1231 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1238 /* find the top COUNT words in the search database */
1239 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1240 struct search_entry
*se
;
1243 int err
, n
= 0, nse
= 0, i
;
1248 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1249 se
= xmalloc(count
* sizeof *se
);
1250 /* Walk across the whole database counting up the number of times each
1252 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1254 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1255 ++n
; /* same word again */
1257 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1258 word
= xstrndup(k
.data
, wl
= k
.size
);
1266 case DB_LOCK_DEADLOCK
:
1267 error(0, "error querying search database: %s", db_strerror(err
));
1270 fatal(0, "error querying search database: %s", db_strerror(err
));
1272 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1274 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1275 byte_xasprintf(&str
, "Top %d search words:", nse
);
1276 vector_append(v
, str
);
1277 for(i
= 0; i
< nse
; ++i
) {
1278 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1279 vector_append(v
, str
);
1284 #define SI(what) statinfo_##what, \
1285 sizeof statinfo_##what / sizeof (struct statinfo)
1287 /* return a list of database stats */
1288 char **trackdb_stats(int *nstatsp
) {
1294 tid
= trackdb_begin_transaction();
1296 vector_append(&v
, (char *)"Tracks database stats:");
1297 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1298 vector_append(&v
, (char *)"");
1299 vector_append(&v
, (char *)"Search database stats:");
1300 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1301 vector_append(&v
, (char *)"");
1302 vector_append(&v
, (char *)"Prefs database stats:");
1303 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1304 vector_append(&v
, (char *)"");
1305 if(search_league(&v
, 10, tid
)) goto fail
;
1306 vector_terminate(&v
);
1309 trackdb_abort_transaction(tid
);
1311 trackdb_commit_transaction(tid
);
1312 if(nstatsp
) *nstatsp
= v
.nvec
;
1316 struct stats_details
{
1317 void (*done
)(char *data
, void *u
);
1319 int exited
; /* subprocess exited */
1320 int closed
; /* pipe close */
1321 int wstat
; /* wait status from subprocess */
1322 struct dynstr data
[1]; /* data read from pipe */
1325 static void stats_complete(struct stats_details
*d
) {
1328 if(!(d
->exited
&& d
->closed
))
1330 byte_xasprintf(&s
, "\n"
1332 "track lookup cache hits: %lu\n"
1333 "track lookup cache misses: %lu\n",
1335 cache_files_misses
);
1336 dynstr_append_string(d
->data
, s
);
1337 dynstr_terminate(d
->data
);
1338 d
->done(d
->data
->vec
, d
->u
);
1341 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1342 pid_t
attribute((unused
)) pid
,
1344 const struct rusage
attribute((unused
)) *rusage
,
1346 struct stats_details
*const d
= u
;
1350 error(0, "disorder-stats %s", wstat(status
));
1355 static int stats_read(ev_source
attribute((unused
)) *ev
,
1361 struct stats_details
*const d
= u
;
1363 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1364 ev_reader_consume(reader
, bytes
);
1371 static int stats_error(ev_source
attribute((unused
)) *ev
,
1374 struct stats_details
*const d
= u
;
1376 error(errno_value
, "error reading from pipe to disorder-stats");
1382 void trackdb_stats_subprocess(ev_source
*ev
,
1383 void (*done
)(char *data
, void *u
),
1387 struct stats_details
*d
= xmalloc(sizeof *d
);
1389 dynstr_init(d
->data
);
1393 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1395 ev_child(ev
, pid
, 0, stats_finished
, d
);
1396 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1399 /** @brief Parse a track name part preference
1400 * @param name Preference name
1401 * @param partp Where to store part name
1402 * @param contextp Where to store context name
1403 * @return 0 on success, non-0 if parse fails
1405 static int trackdb__parse_namepref(const char *name
,
1409 static const char prefix
[] = "trackname_";
1411 if(strncmp(name
, prefix
, strlen(prefix
)))
1412 return -1; /* not trackname_* at all */
1413 name
+= strlen(prefix
);
1414 /* There had better be a _ between context and part */
1415 c
= strchr(name
, '_');
1418 /* Context is first in the pref name even though most APIs have the part
1419 * first. Confusing; sorry. */
1420 *contextp
= xstrndup(name
, c
- name
);
1422 /* There had better NOT be a second _ */
1425 *partp
= xstrdup(c
);
1429 /** @brief Compute the default value for a track preference
1430 * @param track Track name
1431 * @param name Preference name
1432 * @return Default value or 0 if none/not known
1434 static const char *trackdb__default(const char *track
, const char *name
) {
1435 char *context
, *part
;
1437 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1438 /* We can work out the default for a trackname_ pref */
1439 return trackname_part(track
, context
, part
);
1440 } else if(!strcmp(name
, "weight")) {
1441 /* We know the default weight */
1443 } else if(!strcmp(name
, "pick_at_random")) {
1444 /* By default everything is eligible for picking at random */
1446 } else if(!strcmp(name
, "tags")) {
1447 /* By default everything no track has any tags */
1453 /* set a pref (remove if value=0) */
1454 int trackdb_set(const char *track
,
1456 const char *value
) {
1457 struct kvp
*t
, *p
, *a
;
1460 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1463 /* If the value matches the default then unset instead, to keep the database
1464 * tidy. Older versions did not have this feature so your database may yet
1465 * have some default values stored in it. */
1467 def
= trackdb__default(track
, name
);
1468 if(def
&& !strcmp(value
, def
))
1473 tid
= trackdb_begin_transaction();
1474 if((err
= gettrackdata(track
, &t
, &p
, 0,
1475 0, tid
)) == DB_LOCK_DEADLOCK
)
1477 if(err
== DB_NOTFOUND
) break;
1478 if(name
[0] == '_') {
1479 if(kvp_set(&t
, name
, value
))
1480 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1483 /* get the old alias name */
1484 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1485 /* get the old tags */
1486 if(!strcmp(name
, "tags"))
1487 oldtags
= parsetags(kvp_get(p
, "tags"));
1489 if(kvp_set(&p
, name
, value
))
1490 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1492 /* compute the new alias name */
1493 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1494 /* check whether alias has changed */
1495 if(!(oldalias
== newalias
1496 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1497 /* adjust alias records to fit change */
1499 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1503 kvp_set(&a
, "_alias_for", track
);
1504 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1507 /* check whether tags have changed */
1508 if(!strcmp(name
, "tags")) {
1509 newtags
= parsetags(value
);
1510 while(*oldtags
|| *newtags
) {
1511 if(*oldtags
&& *newtags
) {
1512 cmp
= strcmp(*oldtags
, *newtags
);
1514 /* keeping this tag */
1518 /* old tag fits into a gap in the new list, so delete old */
1521 /* new tag fits into a gap in the old list, so insert new */
1523 } else if(*oldtags
) {
1524 /* we've run out of new tags, so remaining old ones are to be
1527 if(trackdb_delkeydata(trackdb_tagsdb
,
1528 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1532 /* we've run out of old tags, so remainig new ones are to be
1535 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1544 trackdb_abort_transaction(tid
);
1546 trackdb_commit_transaction(tid
);
1547 return err
== 0 ?
0 : -1;
1551 const char *trackdb_get(const char *track
,
1553 return kvp_get(trackdb_get_all(track
), name
);
1556 /* get all prefs as a 0-terminated array */
1557 struct kvp
*trackdb_get_all(const char *track
) {
1558 struct kvp
*t
, *p
, **pp
;
1562 tid
= trackdb_begin_transaction();
1563 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1567 trackdb_abort_transaction(tid
);
1569 trackdb_commit_transaction(tid
);
1570 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1577 const char *trackdb_resolve(const char *track
) {
1582 tid
= trackdb_begin_transaction();
1583 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1587 trackdb_abort_transaction(tid
);
1589 trackdb_commit_transaction(tid
);
1593 int trackdb_isalias(const char *track
) {
1594 const char *actual
= trackdb_resolve(track
);
1596 return strcmp(actual
, track
);
1599 /* test whether a track exists (perhaps an alias) */
1600 int trackdb_exists(const char *track
) {
1605 tid
= trackdb_begin_transaction();
1606 /* unusually, here we want the return value */
1607 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1611 trackdb_abort_transaction(tid
);
1613 trackdb_commit_transaction(tid
);
1617 /* return the list of tags */
1618 char **trackdb_alltags(void) {
1623 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1627 /** @brief List all the keys in @p db
1628 * @param db Database
1629 * @param v Vector to store keys in
1630 * @param tid Transaction ID
1631 * @return 0 or DB_LOCK_DEADLOCK
1633 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1636 DBC
*const c
= trackdb_opencursor(db
, tid
);
1639 memset(&k
, 0, sizeof k
);
1640 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1641 vector_append(v
, xstrndup(k
.data
, k
.size
));
1645 case DB_LOCK_DEADLOCK
:
1648 fatal(0, "c->c_get: %s", db_strerror(e
));
1650 if((e
= trackdb_closecursor(c
)))
1652 vector_terminate(v
);
1656 /* return 1 iff sorted tag lists A and B have at least one member in common */
1657 int tag_intersection(char **a
, char **b
) {
1660 /* Same sort of logic as trackdb_set() above */
1662 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1663 else if(cmp
< 0) ++a
;
1669 static pid_t choose_pid
= -1;
1670 static int choose_fd
;
1671 static random_callback
*choose_callback
;
1672 static struct dynstr choose_output
;
1673 static unsigned choose_complete
;
1674 static int choose_status
;
1675 #define CHOOSE_RUNNING 1
1676 #define CHOOSE_READING 2
1678 static void choose_finished(ev_source
*ev
, unsigned which
) {
1679 choose_complete
|= which
;
1680 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1683 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1684 dynstr_terminate(&choose_output
);
1685 choose_callback(ev
, xstrdup(choose_output
.vec
));
1687 choose_callback(ev
, 0);
1690 /** @brief Called when @c disorder-choose terminates */
1691 static int choose_exited(ev_source
*ev
,
1692 pid_t
attribute((unused
)) pid
,
1694 const struct rusage
attribute((unused
)) *rusage
,
1695 void attribute((unused
)) *u
) {
1697 error(0, "disorder-choose %s", wstat(status
));
1698 choose_status
= status
;
1699 choose_finished(ev
, CHOOSE_RUNNING
);
1703 /** @brief Called with data from @c disorder-choose pipe */
1704 static int choose_readable(ev_source
*ev
,
1709 void attribute((unused
)) *u
) {
1710 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1711 ev_reader_consume(reader
, bytes
);
1713 choose_finished(ev
, CHOOSE_READING
);
1717 static int choose_read_error(ev_source
*ev
,
1719 void attribute((unused
)) *u
) {
1720 error(errno_value
, "error reading disorder-choose pipe");
1721 choose_finished(ev
, CHOOSE_READING
);
1725 /** @brief Request a random track
1726 * @param ev Event source
1727 * @param callback Called with random track or NULL
1728 * @return 0 if a request was initiated, else -1
1730 * Initiates a random track choice. @p callback will later be called back with
1731 * the choice (or NULL on error). If a choice is already underway then -1 is
1732 * returned and there will be no additional callback.
1734 * The caller shouldn't assume that the track returned actually exists (it
1735 * might be removed between the choice and the callback, or between being added
1736 * to the queue and being played).
1738 int trackdb_request_random(ev_source
*ev
,
1739 random_callback
*callback
) {
1742 if(choose_pid
!= -1)
1743 return -1; /* don't run concurrent chooses */
1746 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1749 choose_callback
= callback
;
1750 choose_output
.nvec
= 0;
1751 choose_complete
= 0;
1752 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1753 "disorder-choose reader"); /* owns p[0] */
1754 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1758 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1759 * from the prefs. */
1760 static const char *getpart(const char *track
,
1761 const char *context
,
1763 const struct kvp
*p
,
1768 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1769 if((result
= kvp_get(p
, pref
)))
1772 result
= trackname_part(track
, context
, part
);
1773 assert(result
!= 0);
1777 /* get a track name part, like trackname_part(), but taking the database into
1779 const char *trackdb_getpart(const char *track
,
1780 const char *context
,
1788 /* construct the full pref */
1789 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1791 tid
= trackdb_begin_transaction();
1792 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1796 trackdb_abort_transaction(tid
);
1798 trackdb_commit_transaction(tid
);
1799 return getpart(actual
, context
, part
, p
, &used_db
);
1802 /* get the raw path name for @track@ (might be an alias) */
1803 const char *trackdb_rawpath(const char *track
) {
1809 tid
= trackdb_begin_transaction();
1810 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1814 trackdb_abort_transaction(tid
);
1816 trackdb_commit_transaction(tid
);
1817 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1821 /* trackdb_list **************************************************************/
1823 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1824 * readable at some point */
1826 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1827 * If RE is a null pointer then it matches everything. */
1828 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1836 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1837 case PCRE_ERROR_NOMATCH
: return 0;
1840 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1847 static int do_list(struct vector
*v
, const char *dir
,
1848 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1854 size_t l
, last_dir_len
= 0;
1855 char *last_dir
= 0, *track
;
1859 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1862 /* find the first key >= dir */
1863 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1864 /* keep going while we're dealing with <dir/anything> */
1867 && ((char *)k
.data
)[dl
] == '/'
1868 && !memcmp(k
.data
, dir
, dl
)) {
1869 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1871 /* we have <dir/component/anything>, so <dir/component> is a directory */
1872 l
= ptr
- (char *)k
.data
;
1873 if(what
& trackdb_directories
)
1875 && l
== last_dir_len
1876 && !memcmp(last_dir
, k
.data
, l
))) {
1877 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1878 if(track_matches(dl
, k
.data
, l
, re
))
1879 vector_append(v
, last_dir
);
1882 /* found a plain file */
1883 if((what
& trackdb_files
)) {
1884 track
= xstrndup(k
.data
, k
.size
);
1885 if((err
= trackdb_getdata(trackdb_prefsdb
,
1886 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1888 /* There's an awkward question here...
1890 * If a track shares a directory with its alias then we could
1891 * do one of three things:
1892 * - report both. Looks ridiculuous in most UIs.
1893 * - report just the alias. Remarkably inconvenient to write
1895 * - report just the real name. Ugly if the UI doesn't prettify
1896 * names via the name parts.
1899 /* If this file is an alias for a track in the same directory then we
1901 struct kvp
*t
= kvp_urldecode(d
.data
, d
.size
);
1902 const char *alias_target
= kvp_get(t
, "_alias_for");
1904 && !strcmp(d_dirname(alias_target
),
1906 if(track_matches(dl
, k
.data
, k
.size
, re
))
1907 vector_append(v
, track
);
1909 /* if this file has an alias in the same directory then we skip it */
1911 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1913 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1914 if(track_matches(dl
, k
.data
, k
.size
, re
))
1915 vector_append(v
, track
);
1919 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1927 case DB_LOCK_DEADLOCK
:
1928 error(0, "error querying database: %s", db_strerror(err
));
1931 fatal(0, "error querying database: %s", db_strerror(err
));
1934 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1938 /* return the directories or files below @dir@ */
1939 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1947 tid
= trackdb_begin_transaction();
1950 if(do_list(&v
, dir
, what
, re
, tid
))
1953 for(n
= 0; n
< config
->collection
.n
; ++n
)
1954 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1959 trackdb_abort_transaction(tid
);
1961 trackdb_commit_transaction(tid
);
1962 vector_terminate(&v
);
1968 /* If S is tag:something, return something. Else return 0. */
1969 static const char *checktag(const char *s
) {
1970 if(!strncmp(s
, "tag:", 4))
1976 /* return a list of tracks containing all of the words given. If you
1977 * ask for only stopwords you get no tracks. */
1978 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1979 const char **w
, *best
= 0, *tag
;
1980 char **twords
, **tags
;
1982 int i
, j
, n
, err
, what
;
1992 *ntracks
= 0; /* for early returns */
1993 /* normalize all the words */
1994 w
= xmalloc(nwordlist
* sizeof (char *));
1995 istag
= xmalloc_noptr(nwordlist
);
1996 for(n
= 0; n
< nwordlist
; ++n
) {
2000 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
2001 if(checktag(w
[n
])) {
2002 ++ntags
; /* count up tags */
2003 /* Normalize the tag */
2004 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2007 /* Normalize the search term by removing combining characters */
2008 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2010 nw32
= remove_combining_chars(w32
, nw32
);
2011 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2016 /* find the longest non-stopword */
2017 for(n
= 0; n
< nwordlist
; ++n
)
2018 if(!istag
[n
] && !stopword(w
[n
]))
2019 if(!best
|| strlen(w
[n
]) > strlen(best
))
2021 /* TODO: we should at least in principal be able to identify the word or tag
2022 * with the least matches in log time, and choose that as our primary search
2024 if(ntags
&& !best
) {
2025 /* Only tags are listed. We limit to the first and narrow down with the
2027 best
= istag
[0] ? w
[0] : 0;
2028 db
= trackdb_tagsdb
;
2031 /* We can limit to some word. */
2032 db
= trackdb_searchdb
;
2035 /* Only stopwords */
2041 tid
= trackdb_begin_transaction();
2042 /* find all the tracks that have that word */
2047 cursor
= trackdb_opencursor(db
, tid
);
2048 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2049 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2056 case DB_LOCK_DEADLOCK
:
2057 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2060 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2062 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2064 /* do a naive search over that (hopefuly fairly small) list of tracks */
2066 for(n
= 0; n
< v
.nvec
; ++n
) {
2067 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2070 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2073 twords
= track_to_words(v
.vec
[n
], p
);
2074 tags
= parsetags(kvp_get(p
, "tags"));
2075 for(i
= 0; i
< nwordlist
; ++i
) {
2078 /* Track must have this tag */
2079 for(j
= 0; tags
[j
]; ++j
)
2080 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2081 if(!tags
[j
]) break; /* tag not found */
2083 /* Track must contain this word */
2084 for(j
= 0; twords
[j
]; ++j
)
2085 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2086 if(!twords
[j
]) break; /* word not found */
2089 if(i
>= nwordlist
) /* all words found */
2090 vector_append(&u
, v
.vec
[n
]);
2094 trackdb_closecursor(cursor
);
2096 trackdb_abort_transaction(tid
);
2097 info("retrying search");
2099 trackdb_commit_transaction(tid
);
2100 vector_terminate(&u
);
2106 /* trackdb_scan **************************************************************/
2108 int trackdb_scan(const char *root
,
2109 int (*callback
)(const char *track
,
2118 const size_t root_len
= root ?
strlen(root
) : 0;
2120 struct kvp
*data
, *prefs
;
2123 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2125 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2128 memset(&k
, 0, sizeof k
);
2129 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2134 || (k
.size
> root_len
2135 && !strncmp(k
.data
, root
, root_len
)
2136 && ((char *)k
.data
)[root_len
] == '/')) {
2137 data
= kvp_urldecode(d
.data
, d
.size
);
2138 if(kvp_get(data
, "_path")) {
2139 track
= xstrndup(k
.data
, k
.size
);
2140 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2141 * do a lookup for every single track. In fact this is quite quick:
2142 * with around 10,000 tracks a complete scan is around 0.3s on my
2143 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2144 * linear walk as we already do over trackdb_tracksdb, and probably get
2145 * even higher performance. That would require upgrade logic to
2146 * translate old databases though.
2148 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2149 prepare_data(&pd
), 0)) {
2151 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2156 case DB_LOCK_DEADLOCK
:
2157 error(0, "getting prefs: %s", db_strerror(err
));
2158 trackdb_closecursor(cursor
);
2161 fatal(0, "getting prefs: %s", db_strerror(err
));
2163 /* Advance to the next track before the callback so that the callback
2164 * may safely delete the track */
2165 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2166 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2171 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2175 trackdb_closecursor(cursor
);
2182 case DB_LOCK_DEADLOCK
:
2183 error(0, "c->c_get: %s", db_strerror(err
));
2186 fatal(0, "c->c_get: %s", db_strerror(err
));
2190 /* trackdb_rescan ************************************************************/
2192 /** @brief Node in the list of rescan-complete callbacks */
2193 struct rescanned_node
{
2194 struct rescanned_node
*next
;
2195 void (*rescanned
)(void *ru
);
2199 /** @brief List of rescan-complete callbacks */
2200 static struct rescanned_node
*rescanned_list
;
2202 /** @brief Add a rescan completion callback */
2203 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2206 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2207 n
->next
= rescanned_list
;
2208 n
->rescanned
= rescanned
;
2214 /* called when the rescanner terminates */
2215 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2218 const struct rusage
attribute((unused
)) *rusage
,
2219 void attribute((unused
)) *u
) {
2220 if(pid
== rescan_pid
) rescan_pid
= -1;
2222 error(0, RESCAN
": %s", wstat(status
));
2224 D((RESCAN
" terminated: %s", wstat(status
)));
2225 /* Our cache of file lookups is out of date now */
2226 cache_clean(&cache_files_type
);
2227 eventlog("rescanned", (char *)0);
2228 /* Call rescanned callbacks */
2229 while(rescanned_list
) {
2230 void (*rescanned
)(void *u_
) = rescanned_list
->rescanned
;
2231 void *ru
= rescanned_list
->ru
;
2233 rescanned_list
= rescanned_list
->next
;
2239 /** @brief Initiate a rescan
2240 * @param ev Event loop or 0 to block
2241 * @param recheck 1 to recheck lengths, 0 to suppress check
2242 * @param rescanned Called on completion (if not NULL)
2243 * @param u Passed to @p rescanned
2245 void trackdb_rescan(ev_source
*ev
, int recheck
,
2246 void (*rescanned
)(void *ru
),
2250 if(rescan_pid
!= -1) {
2251 trackdb_add_rescanned(rescanned
, ru
);
2252 error(0, "rescan already underway");
2255 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2256 recheck ?
"--check" : "--no-check",
2258 trackdb_add_rescanned(rescanned
, ru
);
2260 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2261 D(("started rescanner"));
2263 /* This is the first rescan, we block until it is complete */
2264 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2266 reap_rescan(0, rescan_pid
, w
, 0, 0);
2270 int trackdb_rescan_cancel(void) {
2271 if(rescan_pid
== -1) return 0;
2272 if(kill(rescan_pid
, SIGTERM
) < 0)
2273 fatal(errno
, "error killing rescanner");
2278 /** @brief Return true if a rescan is underway */
2279 int trackdb_rescan_underway(void) {
2280 return rescan_pid
!= -1;
2283 /* global prefs **************************************************************/
2285 void trackdb_set_global(const char *name
,
2293 tid
= trackdb_begin_transaction();
2294 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2296 trackdb_abort_transaction(tid
);
2298 trackdb_commit_transaction(tid
);
2299 /* log important state changes */
2300 if(!strcmp(name
, "playing")) {
2301 state
= !value
|| !strcmp(value
, "yes");
2302 info("playing %s by %s",
2303 state ?
"enabled" : "disabled",
2305 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2307 if(!strcmp(name
, "random-play")) {
2308 state
= !value
|| !strcmp(value
, "yes");
2309 info("random play %s by %s",
2310 state ?
"enabled" : "disabled",
2312 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2316 int trackdb_set_global_tid(const char *name
,
2322 memset(&k
, 0, sizeof k
);
2323 memset(&d
, 0, sizeof d
);
2324 k
.data
= (void *)name
;
2325 k
.size
= strlen(name
);
2327 d
.data
= (void *)value
;
2328 d
.size
= strlen(value
);
2331 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2333 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2334 if(err
== DB_LOCK_DEADLOCK
) return err
;
2336 fatal(0, "error updating database: %s", db_strerror(err
));
2340 const char *trackdb_get_global(const char *name
) {
2346 tid
= trackdb_begin_transaction();
2347 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2349 trackdb_abort_transaction(tid
);
2351 trackdb_commit_transaction(tid
);
2355 int trackdb_get_global_tid(const char *name
,
2361 memset(&k
, 0, sizeof k
);
2362 k
.data
= (void *)name
;
2363 k
.size
= strlen(name
);
2364 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2365 prepare_data(&d
), 0)) {
2367 *rp
= xstrndup(d
.data
, d
.size
);
2372 case DB_LOCK_DEADLOCK
:
2375 fatal(0, "error reading database: %s", db_strerror(err
));
2379 /** @brief Retrieve the most recently added tracks
2380 * @param ntracksp Where to put count, or 0
2381 * @param maxtracks Maximum number of tracks to retrieve
2382 * @return null-terminated array of track names
2384 * The most recently added track is first in the array.
2386 char **trackdb_new(int *ntracksp
,
2392 tid
= trackdb_begin_transaction();
2393 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2396 trackdb_abort_transaction(tid
);
2398 trackdb_commit_transaction(tid
);
2402 /** @brief Retrieve the most recently added tracks
2403 * @param ntracksp Where to put count, or 0
2404 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2405 * @param tid Transaction ID
2406 * @return null-terminated array of track names, or NULL on deadlock
2408 * The most recently added track is first in the array.
2410 * TODO: exclude tracks that have been deleted again.
2413 static char **trackdb_new_tid(int *ntracksp
,
2419 struct vector tracks
[1];
2421 vector_init(tracks
);
2422 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2423 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2424 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2425 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2427 case 0: /* hit maxtracks */
2428 case DB_NOTFOUND
: /* ran out of tracks */
2430 case DB_LOCK_DEADLOCK
:
2431 trackdb_closecursor(c
);
2434 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2436 if((err
= trackdb_closecursor(c
)))
2437 return 0; /* deadlock */
2438 vector_terminate(tracks
);
2440 *ntracksp
= tracks
->nvec
;
2444 /** @brief Expire noticed.db
2445 * @param earliest Earliest timestamp to keep
2447 void trackdb_expire_noticed(time_t earliest
) {
2451 tid
= trackdb_begin_transaction();
2452 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2454 trackdb_abort_transaction(tid
);
2456 trackdb_commit_transaction(tid
);
2459 /** @brief Expire noticed.db
2460 * @param earliest Earliest timestamp to keep
2461 * @param tid Transaction ID
2462 * @return 0 or DB_LOCK_DEADLOCK
2464 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2472 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2473 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2475 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2476 if(when
>= earliest
)
2478 if((err
= c
->c_del(c
, 0))) {
2479 if(err
!= DB_LOCK_DEADLOCK
)
2480 fatal(0, "error deleting expired noticed.db entry: %s",
2486 if(err
== DB_NOTFOUND
)
2488 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2489 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2491 if((err
= trackdb_closecursor(c
))) {
2492 if(err
!= DB_LOCK_DEADLOCK
)
2493 fatal(0, "error closing cursor: %s", db_strerror(err
));
2497 info("expired %d tracks from noticed.db", count
);
2501 /* tidying up ****************************************************************/
2503 void trackdb_gc(void) {
2507 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2508 config
->checkpoint_kbyte
,
2509 config
->checkpoint_min
,
2511 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2512 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2513 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2514 /* This makes catastrophic recovery impossible. However, the user can still
2515 * preserve the important data by using disorder-dump to snapshot their
2516 * prefs, and later to restore it. This is likely to have much small
2517 * long-term storage requirements than record the db logfiles. */
2520 /* user database *************************************************************/
2522 /** @brief Return true if @p user is trusted */
2523 static int trusted(const char *user
) {
2526 for(n
= 0; (n
< config
->trust
.n
2527 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2529 return n
< config
->trust
.n
;
2532 /** @brief Return non-zero for a valid username
2534 * Currently we only allow the letters and digits in ASCII. We could be more
2535 * liberal than this but it is a nice simple test. It is critical that
2536 * semicolons are never allowed.
2538 static int valid_username(const char *user
) {
2542 const uint8_t c
= *user
++;
2543 /* For now we are very strict */
2544 if((c
>= 'a' && c
<= 'z')
2545 || (c
>= 'A' && c
<= 'Z')
2546 || (c
>= '0' && c
<= '9'))
2554 /** @brief Add a user */
2555 static int create_user(const char *user
,
2556 const char *password
,
2559 const char *confirmation
,
2565 /* sanity check user */
2566 if(!valid_username(user
)) {
2567 error(0, "invalid username '%s'", user
);
2570 if(parse_rights(rights
, 0, 1)) {
2571 error(0, "invalid rights string");
2574 /* data for this user */
2576 kvp_set(&k
, "password", password
);
2577 kvp_set(&k
, "rights", rights
);
2579 kvp_set(&k
, "email", email
);
2581 kvp_set(&k
, "confirmation", confirmation
);
2582 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2583 kvp_set(&k
, "created", s
);
2584 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2587 /** @brief Add one pre-existing user */
2588 static int one_old_user(const char *user
, const char *password
,
2592 /* www-data doesn't get added */
2593 if(!strcmp(user
, "www-data")) {
2594 info("not adding www-data to user database");
2598 if(!strcmp(user
, "root"))
2600 else if(trusted(user
)) {
2603 parse_rights(config
->default_rights
, &r
, 1);
2604 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2605 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2606 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2607 rights
= rights_string(r
);
2609 rights
= config
->default_rights
;
2610 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2611 tid
, DB_NOOVERWRITE
);
2614 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2617 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2618 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2621 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2624 error(0, "user %s already exists, delete 'allow' directive",
2625 config
->allow
.s
[n
].s
[0]);
2626 /* This won't ever become fatal - eventually 'allow' will be
2629 case DB_LOCK_DEADLOCK
:
2630 return DB_LOCK_DEADLOCK
;
2636 /** @brief Read old 'allow' directives and copy them to the users database */
2637 void trackdb_old_users(void) {
2641 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2644 /** @brief Create a root user in the user database if there is none */
2645 void trackdb_create_root(void) {
2650 /* Choose a new root password */
2651 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2652 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2653 /* Create the root user if it does not exist */
2654 WITH_TRANSACTION(create_user("root", pw
, "all",
2655 0/*email*/, 0/*confirmation*/,
2656 tid
, DB_NOOVERWRITE
));
2658 info("created root user");
2661 /** @brief Find a user's password from the database
2662 * @param user Username
2663 * @return Password or NULL
2665 * Only works if running as a user that can read the database!
2667 * If the user exists but has no password, "" is returned.
2669 const char *trackdb_get_password(const char *user
) {
2672 const char *password
;
2674 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2677 password
= kvp_get(k
, "password");
2678 return password ? password
: "";
2681 /** @brief Add a new user
2682 * @param user Username
2683 * @param password Password or NULL
2684 * @param rights Initial rights
2685 * @param email Email address or NULL
2686 * @param confirmation Confirmation string or NULL
2687 * @return 0 on success, non-0 on error
2689 int trackdb_adduser(const char *user
,
2690 const char *password
,
2693 const char *confirmation
) {
2696 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2697 tid
, DB_NOOVERWRITE
));
2699 error(0, "cannot create user '%s' because they already exist", user
);
2703 info("created user '%s' with rights '%s' and email address '%s'",
2704 user
, rights
, email
);
2706 info("created user '%s' with rights '%s'", user
, rights
);
2707 eventlog("user_add", user
, (char *)0);
2712 /** @brief Delete a user
2713 * @param user User to delete
2714 * @return 0 on success, non-0 if the user didn't exist anyway
2716 int trackdb_deluser(const char *user
) {
2719 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2721 error(0, "cannot delete user '%s' because they do not exist", user
);
2724 info("deleted user '%s'", user
);
2725 eventlog("user_delete", user
, (char *)0);
2729 /** @brief Get user information
2730 * @param user User to query
2731 * @return Linked list of user information or NULL if user does not exist
2733 * Every user has at least a @c rights entry so NULL can be used to mean no
2736 struct kvp
*trackdb_getuserinfo(const char *user
) {
2740 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2747 /** @brief Edit user information
2748 * @param user User to edit
2749 * @param key Key to change
2750 * @param value Value to set, or NULL to remove
2751 * @param tid Transaction ID
2752 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2754 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2755 const char *value
, DB_TXN
*tid
) {
2759 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2761 if(!kvp_set(&k
, key
, value
))
2762 return 0; /* no change */
2763 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2766 /** @brief Edit user information
2767 * @param user User to edit
2768 * @param key Key to change
2769 * @param value Value to set, or NULL to remove
2770 * @return 0 on success, non-0 on error
2772 int trackdb_edituserinfo(const char *user
,
2773 const char *key
, const char *value
) {
2776 if(!strcmp(key
, "rights")) {
2778 error(0, "cannot remove 'rights' key from user '%s'", user
);
2781 if(parse_rights(value
, 0, 1)) {
2782 error(0, "invalid rights string");
2785 } else if(!strcmp(key
, "email")) {
2787 if(!strchr(value
, '@')) {
2788 error(0, "invalid email address '%s' for user '%s'", user
, value
);
2792 value
= 0; /* no email -> remove key */
2793 } else if(!strcmp(key
, "created")) {
2794 error(0, "cannot change creation date for user '%s'", user
);
2796 } else if(strcmp(key
, "password")
2797 && !strcmp(key
, "confirmation")) {
2798 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2801 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2803 error(0, "unknown user '%s'", user
);
2806 eventlog("user_edit", user
, key
, (char *)0);
2811 /** @brief List all users
2812 * @return NULL-terminated list of users
2814 char **trackdb_listusers(void) {
2819 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2823 /** @brief Confirm a user registration
2824 * @param user Username
2825 * @param confirmation Confirmation string
2826 * @param rightsp Where to put user rights
2827 * @param tid Transaction ID
2828 * @return 0 on success, non-0 on error
2830 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2831 rights_type
*rightsp
,
2833 const char *stored_confirmation
;
2838 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2840 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2841 error(0, "already confirmed user '%s'", user
);
2842 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2845 if(!(rights
= kvp_get(k
, "rights"))) {
2846 error(0, "no rights for unconfirmed user '%s'", user
);
2849 if(parse_rights(rights
, rightsp
, 1))
2851 if(strcmp(confirmation
, stored_confirmation
)) {
2852 error(0, "wrong confirmation string for user '%s'", user
);
2856 kvp_set(&k
, "confirmation", 0);
2857 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2860 /** @brief Confirm a user registration
2861 * @param user Username
2862 * @param confirmation Confirmation string
2863 * @param rightsp Where to put user rights
2864 * @return 0 on success, non-0 on error
2866 int trackdb_confirm(const char *user
, const char *confirmation
,
2867 rights_type
*rightsp
) {
2870 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2873 info("registration confirmed for user '%s'", user
);
2874 eventlog("user_confirm", user
, (char *)0);
2877 error(0, "confirmation for nonexistent user '%s'", user
);
2879 default: /* already reported */
2889 indent-tabs-mode:nil