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"
65 #define RESCAN "disorder-rescan"
66 #define DEADLOCK "disorder-deadlock"
68 static const char *getpart(const char *track
,
73 static char **trackdb_new_tid(int *ntracksp
,
76 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
77 static char *normalize_tag(const char *s
, size_t ns
);
79 const struct cache_type cache_files_type
= { 86400 };
80 unsigned long cache_files_hits
, cache_files_misses
;
82 /** @brief Set by trackdb_open() */
83 int trackdb_existing_database
;
85 /* setup and teardown ********************************************************/
87 static const char *home
; /* home had better not change */
88 DB_ENV
*trackdb_env
; /* db environment */
90 /** @brief The tracks database
91 * - Keys are UTF-8(NFC(unicode(path name)))
92 * - Values are encoded key-value pairs
93 * - Data is reconstructable data about tracks that currently exist
97 /** @brief The preferences database
99 * - Keys are UTF-8(NFC(unicode(path name)))
100 * - Values are encoded key-value pairs
101 * - Data is user data about tracks (that might not exist any more)
102 * and cannot be reconstructed
106 /** @brief The search database
108 * - Keys are UTF-8(NFKC(casefold(search term)))
109 * - Values are UTF-8(NFC(unicode(path name)))
110 * - There can be more than one value per key
111 * - Presence of key,value means that path matches the search terms
112 * - Only tracks fond in @ref trackdb_tracksdb are represented here
113 * - This database can be reconstructed, it contains no user data
115 DB
*trackdb_searchdb
;
117 /** @brief The tags database
119 * - Keys are UTF-8(NFKC(casefold(tag)))
120 * - Values are UTF-8(NFC(unicode(path name)))
121 * - There can be more than one value per key
122 * - Presence of key,value means that path matches the tag
123 * - This is always in sync with the tags preference
124 * - This database can be reconstructed, it contains no user data
126 DB
*trackdb_tagsdb
; /* the tags database */
128 /** @brief The global preferences database
129 * - Keys are UTF-8(NFC(preference))
130 * - Values are global preference values
131 * - Data is user data and cannot be reconstructed
133 DB
*trackdb_globaldb
; /* global preferences */
135 /** @brief The noticed database
136 * - Keys are 64-bit big-endian timestamps
137 * - Values are UTF-8(NFC(unicode(path name)))
138 * - There can be more than one value per key
139 * - Presence of key,value means that path was added at the given time
140 * - Data cannot be reconstructed (but isn't THAT important)
142 DB
*trackdb_noticeddb
; /* when track noticed */
144 /** @brief The schedule database
146 * - Keys are ID strings, generated at random
147 * - Values are encoded key-value pairs
148 * - There can be more than one value per key
149 * - Data cannot be reconstructed
151 * See @ref server/schedule.c for further information.
153 DB
*trackdb_scheduledb
;
155 /** @brief The user database
156 * - Keys are usernames
157 * - Values are encoded key-value pairs
158 * - Data is user data and cannot be reconstructed
162 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
163 static pid_t rescan_pid
= -1; /* rescanner PID */
164 static int initialized
, opened
; /* state */
166 /* comparison function for keys */
167 static int compare(DB
attribute((unused
)) *db_
,
168 const DBT
*a
, const DBT
*b
) {
169 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
172 /** @brief Test whether the track database can be read
173 * @return 1 if it can, 0 if it cannot
175 int trackdb_readable(void) {
178 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
179 return access(usersdb
, R_OK
) == 0;
182 /** @brief Open database environment
183 * @param flags Flags word
185 * Flags should be one of:
186 * - @ref TRACKDB_NO_RECOVER
187 * - @ref TRACKDB_NORMAL_RECOVER
188 * - @ref TRACKDB_FATAL_RECOVER
189 * - @ref TRACKDB_MAY_CREATE
191 void trackdb_init(int flags
) {
193 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
194 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
197 assert(initialized
== 0);
200 if(strcmp(home
, config
->home
))
201 fatal(0, "cannot change db home without server restart");
205 if(flags
& TRACKDB_MAY_CREATE
) {
211 /* Remove world/group permissions on any regular files already in the
212 * database directory. Actually we don't care about all of them but it's
213 * easier to just do the lot. This can be revisited if it's a serious
214 * practical inconvenience for anyone.
216 * The socket, not being a regular file, is excepted.
218 if(!(dp
= opendir(config
->home
)))
219 fatal(errno
, "error reading %s", config
->home
);
220 while((de
= readdir(dp
))) {
221 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
222 if(lstat(p
, &st
) == 0
223 && S_ISREG(st
.st_mode
)
224 && (st
.st_mode
& 077)) {
225 if(chmod(p
, st
.st_mode
& 07700) < 0)
226 fatal(errno
, "cannot chmod %s", p
);
233 /* create environment */
234 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
236 if((err
= trackdb_env
->set_alloc(trackdb_env
,
237 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
238 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
239 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
240 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
241 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
242 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
243 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
249 |recover_type
[recover
],
251 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
252 trackdb_env
->set_errpfx(trackdb_env
, "DB");
253 trackdb_env
->set_errfile(trackdb_env
, stderr
);
254 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
255 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
256 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
257 D(("initialized database environment"));
260 /* called when deadlock manager terminates */
261 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
262 pid_t
attribute((unused
)) pid
,
264 const struct rusage
attribute((unused
)) *rusage
,
265 void attribute((unused
)) *u
) {
266 db_deadlock_pid
= -1;
268 fatal(0, "deadlock manager unexpectedly terminated: %s",
271 D(("deadlock manager terminated: %s", wstat(status
)));
275 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
279 const char *args
[1024], **argp
, *a
;
283 *argp
++ = "--config";
284 *argp
++ = configfile
;
285 *argp
++ = debugging ?
"--debug" : "--no-debug";
286 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
288 while((a
= va_arg(ap
, const char *)))
292 /* If we're in the background then trap subprocess stdout/stderr */
293 if(!(pid
= xfork())) {
296 ev_signal_atfork(ev
);
297 signal(SIGPIPE
, SIG_DFL
);
302 /* ensure we don't leak privilege anywhere */
303 if(setuid(geteuid()) < 0)
304 fatal(errno
, "error calling setuid");
305 /* If we were negatively niced, undo it. We don't bother checking for
306 * error, it's not that important. */
307 setpriority(PRIO_PROCESS
, 0, 0);
308 execvp(prog
, (char **)args
);
309 fatal(errno
, "error invoking %s", prog
);
314 /* start deadlock manager */
315 void trackdb_master(ev_source
*ev
) {
316 assert(db_deadlock_pid
== -1);
317 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
318 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
319 D(("started deadlock manager"));
322 /* close environment */
323 void trackdb_deinit(void) {
327 assert(initialized
== 1);
330 /* close the environment */
331 if((err
= trackdb_env
->close(trackdb_env
, 0)))
332 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
334 if(rescan_pid
!= -1) {
335 /* shut down the rescanner */
336 if(kill(rescan_pid
, SIGTERM
) < 0)
337 fatal(errno
, "error killing rescanner");
338 /* wait for the rescanner to finish */
339 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
343 /* TODO kill any stats subprocesses */
345 /* finally terminate the deadlock manager */
346 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
347 fatal(errno
, "error killing deadlock manager");
348 db_deadlock_pid
= -1;
350 D(("deinitialized database environment"));
353 /* open a specific database */
354 static DB
*open_db(const char *path
,
362 D(("open %s", path
));
363 path
= config_get_file(path
);
364 if((err
= db_create(&db
, trackdb_env
, 0)))
365 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
367 if((err
= db
->set_flags(db
, dbflags
)))
368 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
369 if(dbtype
== DB_BTREE
)
370 if((err
= db
->set_bt_compare(db
, compare
)))
371 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
372 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
373 openflags
| DB_AUTO_COMMIT
, mode
))) {
374 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
375 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
382 /** @brief Open track databases
383 * @param flags Flags flags word
385 * @p flags should have one of:
386 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
387 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
388 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
390 * - @p TRACKDB_READ_ONLY, read only access
392 void trackdb_open(int flags
) {
395 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
400 /* check the database version first */
401 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
402 if(trackdb_globaldb
) {
403 /* This is an existing database */
407 s
= trackdb_get_global("_dbversion");
408 /* Close the database again, we'll open it property below */
409 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
410 fatal(0, "error closing global.db: %s", db_strerror(err
));
411 trackdb_globaldb
= 0;
412 /* Convert version string to an integer */
413 oldversion
= s ?
atol(s
) : 1;
414 if(oldversion
> config
->dbversion
) {
415 /* Database is from the future; we never allow this. */
416 fatal(0, "this version of DisOrder is too old for database version %ld",
419 if(oldversion
< config
->dbversion
) {
420 /* Database version is out of date */
421 switch(flags
& TRACKDB_UPGRADE_MASK
) {
422 case TRACKDB_NO_UPGRADE
:
423 /* This database needs upgrading but this is not permitted */
424 fatal(0, "database needs upgrading from %ld to %ld",
425 oldversion
, config
->dbversion
);
426 case TRACKDB_CAN_UPGRADE
:
427 /* This database needs upgrading */
428 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
429 oldversion
, config
->dbversion
);
430 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
431 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
434 fatal(0, "disorder-dbupgrade %s", wstat(err
));
435 info("disorder-dbupgrade succeeded");
437 case TRACKDB_OPEN_FOR_UPGRADE
:
443 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
444 /* This doesn't make any sense */
445 fatal(0, "database is already at current version");
447 trackdb_existing_database
= 1;
449 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
450 /* Cannot upgrade a new database */
451 fatal(0, "cannot upgrade a database that does not exist");
453 /* This is a brand new database */
454 trackdb_existing_database
= 0;
456 /* open the databases */
457 if(!(trackdb_usersdb
= open_db("users.db",
458 0, DB_HASH
, dbflags
, 0600)))
459 fatal(0, "cannot open users.db");
460 trackdb_tracksdb
= open_db("tracks.db",
461 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
462 trackdb_searchdb
= open_db("search.db",
463 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
464 trackdb_tagsdb
= open_db("tags.db",
465 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
466 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
467 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
468 trackdb_noticeddb
= open_db("noticed.db",
469 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
470 trackdb_scheduledb
= open_db("schedule.db", 0, DB_HASH
, dbflags
, 0666);
471 if(!trackdb_existing_database
) {
472 /* Stash the database version */
475 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
476 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
477 trackdb_set_global("_dbversion", buf
, 0);
479 D(("opened databases"));
482 /* close track databases */
483 void trackdb_close(void) {
489 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
490 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
491 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
492 fatal(0, "error closing search.db: %s", db_strerror(err
));
493 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
494 fatal(0, "error closing tags.db: %s", db_strerror(err
));
495 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
496 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
497 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
498 fatal(0, "error closing global.db: %s", db_strerror(err
));
499 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
500 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
501 if((err
= trackdb_scheduledb
->close(trackdb_scheduledb
, 0)))
502 fatal(0, "error closing schedule.db: %s", db_strerror(err
));
503 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
504 fatal(0, "error closing users.db: %s", db_strerror(err
));
505 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
506 trackdb_tagsdb
= trackdb_globaldb
= 0;
507 D(("closed databases"));
510 /* generic db routines *******************************************************/
512 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
513 * DB_LOCK_DEADLOCK. */
514 int trackdb_getdata(DB
*db
,
521 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
522 prepare_data(&data
), 0)) {
524 *kp
= kvp_urldecode(data
.data
, data
.size
);
529 case DB_LOCK_DEADLOCK
:
530 error(0, "error querying database: %s", db_strerror(err
));
533 fatal(0, "error querying database: %s", db_strerror(err
));
537 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
538 * DB_LOCK_DEADLOCK. */
539 int trackdb_putdata(DB
*db
,
547 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
548 encode_data(&data
, k
), flags
)) {
552 case DB_LOCK_DEADLOCK
:
553 error(0, "error updating database: %s", db_strerror(err
));
556 fatal(0, "error updating database: %s", db_strerror(err
));
560 /** @brief Delete a database entry
562 * @param track Key to delete
563 * @param tid Transaction ID
564 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
566 int trackdb_delkey(DB
*db
,
572 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
576 case DB_LOCK_DEADLOCK
:
577 error(0, "error updating database: %s", db_strerror(err
));
580 fatal(0, "error updating database: %s", db_strerror(err
));
584 /* open a database cursor */
585 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
589 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
591 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
596 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
597 int trackdb_closecursor(DBC
*c
) {
601 switch(err
= c
->c_close(c
)) {
604 case DB_LOCK_DEADLOCK
:
605 error(0, "error closing cursor: %s", db_strerror(err
));
608 fatal(0, "error closing cursor: %s", db_strerror(err
));
612 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
613 int trackdb_delkeydata(DB
*db
,
621 c
= trackdb_opencursor(db
, tid
);
622 switch(err
= c
->c_get(c
, make_key(&key
, word
),
623 make_key(&data
, track
), DB_GET_BOTH
)) {
625 switch(err
= c
->c_del(c
, 0)) {
631 case DB_LOCK_DEADLOCK
:
632 error(0, "error updating database: %s", db_strerror(err
));
635 fatal(0, "c->c_del: %s", db_strerror(err
));
640 case DB_LOCK_DEADLOCK
:
641 error(0, "error updating database: %s", db_strerror(err
));
644 fatal(0, "c->c_get: %s", db_strerror(err
));
646 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
650 /* start a transaction */
651 DB_TXN
*trackdb_begin_transaction(void) {
655 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
656 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
660 /* abort transaction */
661 void trackdb_abort_transaction(DB_TXN
*tid
) {
665 if((err
= tid
->abort(tid
)))
666 fatal(0, "tid->abort: %s", db_strerror(err
));
669 /* commit transaction */
670 void trackdb_commit_transaction(DB_TXN
*tid
) {
673 if((err
= tid
->commit(tid
, 0)))
674 fatal(0, "tid->commit: %s", db_strerror(err
));
677 /* search/tags shared code ***************************************************/
679 /* comparison function used by dedupe() */
680 static int wordcmp(const void *a
, const void *b
) {
681 return strcmp(*(const char **)a
, *(const char **)b
);
684 /* sort and de-dupe VEC */
685 static char **dedupe(char **vec
, int nvec
) {
688 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
692 for(n
= 1; n
< nvec
; ++n
)
693 if(strcmp(vec
[n
], vec
[m
- 1]))
700 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
701 static int register_word(DB
*db
, const char *what
,
702 const char *track
, const char *word
,
707 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
708 make_key(&data
, track
), DB_NODUPDATA
)) {
712 case DB_LOCK_DEADLOCK
:
713 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
716 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
720 /* search primitives *********************************************************/
722 /* return true iff NAME is a trackname_display_ pref */
723 static int is_display_pref(const char *name
) {
724 static const char prefix
[] = "trackname_display_";
725 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
728 /** @brief Word_Break property tailor that treats underscores as spaces */
729 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
733 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
734 return unicode_Word_Break_Other
;
738 /** @brief Remove all combining characters in-place
739 * @param s Pointer to start of string
740 * @param ns Length of string
741 * @return New, possiblby reduced, length
743 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
744 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
747 const uint32_t c
= *s
++;
748 if(!utf32_combining_class(c
))
754 /** @brief Normalize and split a string using a given tailoring */
755 static void word_split(struct vector
*v
,
757 unicode_property_tailor
*pt
) {
759 uint32_t *t32
, **w32
;
761 /* Convert to UTF-32 */
762 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
764 /* Erase case distinctions */
765 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
767 /* Drop combining characters */
768 nt32
= remove_combining_chars(t32
, nt32
);
769 /* Split into words, treating _ as a space */
770 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
771 /* Convert words back to UTF-8 and append to result */
772 for(i
= 0; i
< nw
; ++i
)
773 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
776 /** @brief Normalize a tag
778 * @param ns Length of tag
779 * @return Normalized string or NULL on error
781 * The return value will be:
783 * - have no leading or trailing space
784 * - have no combining characters
785 * - all spacing between words will be a single U+0020 SPACE
787 static char *normalize_tag(const char *s
, size_t ns
) {
788 uint32_t *s32
, **w32
;
789 size_t ns32
, nw32
, i
;
792 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
794 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
796 ns32
= remove_combining_chars(s32
, ns32
);
797 /* Split into words, no Word_Break tailoring */
798 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
799 /* Compose back into a string */
801 for(i
= 0; i
< nw32
; ++i
) {
803 dynstr_append(d
, ' ');
804 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
810 /* compute the words of a track name */
811 static char **track_to_words(const char *track
,
812 const struct kvp
*p
) {
814 const char *rootless
= track_rootless(track
);
817 rootless
= track
; /* bodge */
819 rootless
= strip_extension(rootless
);
820 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
821 for(; p
; p
= p
->next
)
822 if(is_display_pref(p
->name
))
823 word_split(&v
, p
->value
, 0);
824 vector_terminate(&v
);
825 return dedupe(v
.vec
, v
.nvec
);
828 /* return nonzero iff WORD is a stopword */
829 static int stopword(const char *word
) {
832 for(n
= 0; n
< config
->stopword
.n
833 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
835 return n
< config
->stopword
.n
;
838 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
839 static int register_search_word(const char *track
, const char *word
,
841 if(stopword(word
)) return 0;
842 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
845 /* Tags **********************************************************************/
847 /* Return nonzero if C is a valid tag character */
848 static int tagchar(int c
) {
857 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
858 char **parsetags(const char *s
) {
864 /* skip initial separators */
865 while(*s
&& (!tagchar(*s
) || *s
== ' '))
868 /* find the extent of the tag */
870 while(*s
&& tagchar(*s
))
872 /* strip trailing spaces */
873 while(s
> t
&& s
[-1] == ' ')
875 /* add tag to list */
876 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
877 /* skip intermediate and trailing separators */
878 while(*s
&& (!tagchar(*s
) || *s
== ' '))
882 vector_terminate(&v
);
883 return dedupe(v
.vec
, v
.nvec
);
886 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
887 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
888 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
891 /* aliases *******************************************************************/
893 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
894 * there is no alias sets *aliasp to 0. */
895 static int compute_alias(char **aliasp
,
900 const char *s
= config
->alias
, *t
, *expansion
, *part
;
901 int c
, used_db
= 0, slash_prefix
, err
;
903 const char *const root
= find_track_root(track
);
906 /* Bodge for tracks with no root */
911 dynstr_append_string(&d
, root
);
912 while((c
= (unsigned char)*s
++)) {
914 dynstr_append(&d
, c
);
917 if((slash_prefix
= (*s
== '/')))
920 assert(t
!= 0); /* validated at startup */
921 part
= xstrndup(s
, t
- s
);
922 expansion
= getpart(track
, "display", part
, p
, &used_db
);
924 if(slash_prefix
) dynstr_append(&d
, '/');
925 dynstr_append_string(&d
, expansion
);
927 s
= t
+ 1; /* skip {part} */
929 /* only admit to the alias if we used the db... */
934 dynstr_terminate(&d
);
935 /* ...and the answer differs from the original... */
936 if(!strcmp(track
, d
.vec
)) {
940 /* ...and there isn't already a different track with that name (including as
942 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
944 if((s
= kvp_get(at
, "_alias_for"))
945 && !strcmp(s
, track
)) {
957 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
958 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
959 * Always sets the return values, even if only to null pointers. */
960 static int gettrackdata(const char *track
,
963 const char **actualp
,
965 #define GTD_NOALIAS 0x0001
968 const char *actual
= track
;
969 struct kvp
*t
= 0, *p
= 0;
971 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
972 if((actual
= kvp_get(t
, "_alias_for"))) {
973 if(flags
& GTD_NOALIAS
) {
974 error(0, "alias passed to gettrackdata where real path required");
977 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
982 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
987 if(actualp
) *actualp
= actual
;
993 /* trackdb_notice() **********************************************************/
995 /** @brief notice a possibly new track
996 * @return @c DB_NOTFOUND if new, 0 if already known
998 int trackdb_notice(const char *track
,
1004 tid
= trackdb_begin_transaction();
1005 err
= trackdb_notice_tid(track
, path
, tid
);
1006 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1009 trackdb_abort_transaction(tid
);
1011 trackdb_commit_transaction(tid
);
1015 /** @brief notice a possibly new track
1016 * @param track NFC UTF-8 track name
1017 * @param path Raw path name
1018 * @param tid Transaction ID
1019 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1021 int trackdb_notice_tid(const char *track
,
1025 struct kvp
*t
, *a
, *p
;
1027 char *alias
, **w
, *noticed
;
1030 /* notice whether the tracks.db entry changes */
1032 /* get any existing tracks entry */
1033 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1035 ret
= err
; /* 0 or DB_NOTFOUND */
1036 /* this is a real track */
1037 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1038 t_changed
+= kvp_set(&t
, "_path", path
);
1040 if(ret
== DB_NOTFOUND
) {
1041 /* It's a new track; record the time */
1042 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1043 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1045 /* if we have an alias record it in the database */
1046 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1048 /* won't overwrite someone else's alias as compute_alias() checks */
1049 D(("%s: alias %s", track
, alias
));
1051 kvp_set(&a
, "_alias_for", track
);
1052 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1054 /* update search.db */
1055 w
= track_to_words(track
, p
);
1056 for(n
= 0; w
[n
]; ++n
)
1057 if((err
= register_search_word(track
, w
[n
], tid
)))
1059 /* update tags.db */
1060 w
= parsetags(kvp_get(p
, "tags"));
1061 for(n
= 0; w
[n
]; ++n
)
1062 if((err
= register_tag(track
, w
[n
], tid
)))
1064 /* only store the tracks.db entry if it has changed */
1065 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1067 if(ret
== DB_NOTFOUND
) {
1068 uint32_t timestamp
[2];
1071 timestamp
[0] = htonl((uint64_t)now
>> 32);
1072 timestamp
[1] = htonl((uint32_t)now
);
1073 memset(&key
, 0, sizeof key
);
1074 key
.data
= timestamp
;
1075 key
.size
= sizeof timestamp
;
1076 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1077 make_key(&data
, track
), 0)) {
1079 case DB_LOCK_DEADLOCK
: return err
;
1080 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1086 /* trackdb_obsolete() ********************************************************/
1088 /* obsolete a track */
1089 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1094 if((err
= gettrackdata(track
, 0, &p
, 0,
1095 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1097 else if(err
== DB_NOTFOUND
) return 0;
1098 /* compute the alias, if any, and delete it */
1099 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1101 /* if the alias points to some other track then compute_alias won't
1103 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1104 && err
!= DB_NOTFOUND
)
1107 /* update search.db */
1108 w
= track_to_words(track
, p
);
1109 for(n
= 0; w
[n
]; ++n
)
1110 if(trackdb_delkeydata(trackdb_searchdb
,
1111 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1113 /* update tags.db */
1114 w
= parsetags(kvp_get(p
, "tags"));
1115 for(n
= 0; w
[n
]; ++n
)
1116 if(trackdb_delkeydata(trackdb_tagsdb
,
1117 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1119 /* update tracks.db */
1120 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1122 /* We don't delete the prefs, so they survive temporary outages of the
1123 * (possibly virtual) track filesystem */
1127 /* trackdb_stats() ***********************************************************/
1129 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1130 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1132 static const struct statinfo
{
1135 } statinfo_hash
[] = {
1151 }, statinfo_btree
[] = {
1172 /* look up stats for DB */
1173 static int get_stats(struct vector
*v
,
1175 const struct statinfo
*si
,
1184 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1187 case DB_LOCK_DEADLOCK
:
1188 error(0, "error querying database: %s", db_strerror(err
));
1191 fatal(0, "error querying database: %s", db_strerror(err
));
1193 for(n
= 0; n
< nsi
; ++n
) {
1194 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1195 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1196 vector_append(v
, str
);
1202 /** @brief One entry in the search league */
1203 struct search_entry
{
1208 /** @brief Add a word to the search league
1209 * @param se Pointer to search league
1210 * @param count Maximum size for search league
1211 * @param nse Current size of search league
1212 * @param word New word, or NULL
1213 * @param n How often @p word appears
1214 * @return New size of search league
1216 static int register_search_entry(struct search_entry
*se
,
1223 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1224 /* Find the starting point */
1229 /* Find the insertion point */
1230 while(i
> 0 && n
> se
[i
- 1].n
)
1232 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1239 /* find the top COUNT words in the search database */
1240 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1241 struct search_entry
*se
;
1244 int err
, n
= 0, nse
= 0, i
;
1249 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1250 se
= xmalloc(count
* sizeof *se
);
1251 /* Walk across the whole database counting up the number of times each
1253 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1255 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1256 ++n
; /* same word again */
1258 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1259 word
= xstrndup(k
.data
, wl
= k
.size
);
1267 case DB_LOCK_DEADLOCK
:
1268 error(0, "error querying search database: %s", db_strerror(err
));
1271 fatal(0, "error querying search database: %s", db_strerror(err
));
1273 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1275 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1276 byte_xasprintf(&str
, "Top %d search words:", nse
);
1277 vector_append(v
, str
);
1278 for(i
= 0; i
< nse
; ++i
) {
1279 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1280 vector_append(v
, str
);
1285 #define SI(what) statinfo_##what, \
1286 sizeof statinfo_##what / sizeof (struct statinfo)
1288 /* return a list of database stats */
1289 char **trackdb_stats(int *nstatsp
) {
1295 tid
= trackdb_begin_transaction();
1297 vector_append(&v
, (char *)"Tracks database stats:");
1298 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1299 vector_append(&v
, (char *)"");
1300 vector_append(&v
, (char *)"Search database stats:");
1301 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1302 vector_append(&v
, (char *)"");
1303 vector_append(&v
, (char *)"Prefs database stats:");
1304 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1305 vector_append(&v
, (char *)"");
1306 if(search_league(&v
, 10, tid
)) goto fail
;
1307 vector_terminate(&v
);
1310 trackdb_abort_transaction(tid
);
1312 trackdb_commit_transaction(tid
);
1313 if(nstatsp
) *nstatsp
= v
.nvec
;
1317 struct stats_details
{
1318 void (*done
)(char *data
, void *u
);
1320 int exited
; /* subprocess exited */
1321 int closed
; /* pipe close */
1322 int wstat
; /* wait status from subprocess */
1323 struct dynstr data
[1]; /* data read from pipe */
1326 static void stats_complete(struct stats_details
*d
) {
1329 if(!(d
->exited
&& d
->closed
))
1331 byte_xasprintf(&s
, "\n"
1333 "track lookup cache hits: %lu\n"
1334 "track lookup cache misses: %lu\n",
1336 cache_files_misses
);
1337 dynstr_append_string(d
->data
, s
);
1338 dynstr_terminate(d
->data
);
1339 d
->done(d
->data
->vec
, d
->u
);
1342 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1343 pid_t
attribute((unused
)) pid
,
1345 const struct rusage
attribute((unused
)) *rusage
,
1347 struct stats_details
*const d
= u
;
1351 error(0, "disorder-stats %s", wstat(status
));
1356 static int stats_read(ev_source
attribute((unused
)) *ev
,
1362 struct stats_details
*const d
= u
;
1364 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1365 ev_reader_consume(reader
, bytes
);
1372 static int stats_error(ev_source
attribute((unused
)) *ev
,
1375 struct stats_details
*const d
= u
;
1377 error(errno_value
, "error reading from pipe to disorder-stats");
1383 void trackdb_stats_subprocess(ev_source
*ev
,
1384 void (*done
)(char *data
, void *u
),
1388 struct stats_details
*d
= xmalloc(sizeof *d
);
1390 dynstr_init(d
->data
);
1394 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1396 ev_child(ev
, pid
, 0, stats_finished
, d
);
1397 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1400 /** @brief Parse a track name part preference
1401 * @param name Preference name
1402 * @param partp Where to store part name
1403 * @param contextp Where to store context name
1404 * @return 0 on success, non-0 if parse fails
1406 static int trackdb__parse_namepref(const char *name
,
1410 static const char prefix
[] = "trackname_";
1412 if(strncmp(name
, prefix
, strlen(prefix
)))
1413 return -1; /* not trackname_* at all */
1414 name
+= strlen(prefix
);
1415 /* There had better be a _ between context and part */
1416 c
= strchr(name
, '_');
1419 /* Context is first in the pref name even though most APIs have the part
1420 * first. Confusing; sorry. */
1421 *contextp
= xstrndup(name
, c
- name
);
1423 /* There had better NOT be a second _ */
1426 *partp
= xstrdup(c
);
1430 /** @brief Compute the default value for a track preference
1431 * @param track Track name
1432 * @param name Preference name
1433 * @return Default value or 0 if none/not known
1435 static const char *trackdb__default(const char *track
, const char *name
) {
1436 char *context
, *part
;
1438 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1439 /* We can work out the default for a trackname_ pref */
1440 return trackname_part(track
, context
, part
);
1441 } else if(!strcmp(name
, "weight")) {
1442 /* We know the default weight */
1444 } else if(!strcmp(name
, "pick_at_random")) {
1445 /* By default everything is eligible for picking at random */
1447 } else if(!strcmp(name
, "tags")) {
1448 /* By default everything no track has any tags */
1454 /* set a pref (remove if value=0) */
1455 int trackdb_set(const char *track
,
1457 const char *value
) {
1458 struct kvp
*t
, *p
, *a
;
1461 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1464 /* If the value matches the default then unset instead, to keep the database
1465 * tidy. Older versions did not have this feature so your database may yet
1466 * have some default values stored in it. */
1468 def
= trackdb__default(track
, name
);
1469 if(def
&& !strcmp(value
, def
))
1474 tid
= trackdb_begin_transaction();
1475 if((err
= gettrackdata(track
, &t
, &p
, 0,
1476 0, tid
)) == DB_LOCK_DEADLOCK
)
1478 if(err
== DB_NOTFOUND
) break;
1479 if(name
[0] == '_') {
1480 if(kvp_set(&t
, name
, value
))
1481 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1484 /* get the old alias name */
1485 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1486 /* get the old tags */
1487 if(!strcmp(name
, "tags"))
1488 oldtags
= parsetags(kvp_get(p
, "tags"));
1490 if(kvp_set(&p
, name
, value
))
1491 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1493 /* compute the new alias name */
1494 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1495 /* check whether alias has changed */
1496 if(!(oldalias
== newalias
1497 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1498 /* adjust alias records to fit change */
1500 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1504 kvp_set(&a
, "_alias_for", track
);
1505 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1508 /* check whether tags have changed */
1509 if(!strcmp(name
, "tags")) {
1510 newtags
= parsetags(value
);
1511 while(*oldtags
|| *newtags
) {
1512 if(*oldtags
&& *newtags
) {
1513 cmp
= strcmp(*oldtags
, *newtags
);
1515 /* keeping this tag */
1519 /* old tag fits into a gap in the new list, so delete old */
1522 /* new tag fits into a gap in the old list, so insert new */
1524 } else if(*oldtags
) {
1525 /* we've run out of new tags, so remaining old ones are to be
1528 if(trackdb_delkeydata(trackdb_tagsdb
,
1529 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1533 /* we've run out of old tags, so remainig new ones are to be
1536 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1545 trackdb_abort_transaction(tid
);
1547 trackdb_commit_transaction(tid
);
1548 return err
== 0 ?
0 : -1;
1552 const char *trackdb_get(const char *track
,
1554 return kvp_get(trackdb_get_all(track
), name
);
1557 /* get all prefs as a 0-terminated array */
1558 struct kvp
*trackdb_get_all(const char *track
) {
1559 struct kvp
*t
, *p
, **pp
;
1563 tid
= trackdb_begin_transaction();
1564 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1568 trackdb_abort_transaction(tid
);
1570 trackdb_commit_transaction(tid
);
1571 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1578 const char *trackdb_resolve(const char *track
) {
1583 tid
= trackdb_begin_transaction();
1584 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1588 trackdb_abort_transaction(tid
);
1590 trackdb_commit_transaction(tid
);
1594 int trackdb_isalias(const char *track
) {
1595 const char *actual
= trackdb_resolve(track
);
1597 return strcmp(actual
, track
);
1600 /* test whether a track exists (perhaps an alias) */
1601 int trackdb_exists(const char *track
) {
1606 tid
= trackdb_begin_transaction();
1607 /* unusually, here we want the return value */
1608 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1612 trackdb_abort_transaction(tid
);
1614 trackdb_commit_transaction(tid
);
1618 /* return the list of tags */
1619 char **trackdb_alltags(void) {
1624 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1628 /** @brief List all the keys in @p db
1629 * @param db Database
1630 * @param v Vector to store keys in
1631 * @param tid Transaction ID
1632 * @return 0 or DB_LOCK_DEADLOCK
1634 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1637 DBC
*const c
= trackdb_opencursor(db
, tid
);
1640 memset(&k
, 0, sizeof k
);
1641 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1642 vector_append(v
, xstrndup(k
.data
, k
.size
));
1646 case DB_LOCK_DEADLOCK
:
1649 fatal(0, "c->c_get: %s", db_strerror(e
));
1651 if((e
= trackdb_closecursor(c
)))
1653 vector_terminate(v
);
1657 /* return 1 iff sorted tag lists A and B have at least one member in common */
1658 int tag_intersection(char **a
, char **b
) {
1661 /* Same sort of logic as trackdb_set() above */
1663 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1664 else if(cmp
< 0) ++a
;
1670 static pid_t choose_pid
= -1;
1671 static int choose_fd
;
1672 static random_callback
*choose_callback
;
1673 static struct dynstr choose_output
;
1674 static unsigned choose_complete
;
1675 static int choose_status
;
1676 #define CHOOSE_RUNNING 1
1677 #define CHOOSE_READING 2
1679 static void choose_finished(ev_source
*ev
, unsigned which
) {
1680 choose_complete
|= which
;
1681 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1684 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1685 dynstr_terminate(&choose_output
);
1686 choose_callback(ev
, xstrdup(choose_output
.vec
));
1688 choose_callback(ev
, 0);
1691 /** @brief Called when @c disorder-choose terminates */
1692 static int choose_exited(ev_source
*ev
,
1693 pid_t
attribute((unused
)) pid
,
1695 const struct rusage
attribute((unused
)) *rusage
,
1696 void attribute((unused
)) *u
) {
1698 error(0, "disorder-choose %s", wstat(status
));
1699 choose_status
= status
;
1700 choose_finished(ev
, CHOOSE_RUNNING
);
1704 /** @brief Called with data from @c disorder-choose pipe */
1705 static int choose_readable(ev_source
*ev
,
1710 void attribute((unused
)) *u
) {
1711 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1712 ev_reader_consume(reader
, bytes
);
1714 choose_finished(ev
, CHOOSE_READING
);
1718 static int choose_read_error(ev_source
*ev
,
1720 void attribute((unused
)) *u
) {
1721 error(errno_value
, "error reading disorder-choose pipe");
1722 choose_finished(ev
, CHOOSE_READING
);
1726 /** @brief Request a random track
1727 * @param ev Event source
1728 * @param callback Called with random track or NULL
1729 * @return 0 if a request was initiated, else -1
1731 * Initiates a random track choice. @p callback will later be called back with
1732 * the choice (or NULL on error). If a choice is already underway then -1 is
1733 * returned and there will be no additional callback.
1735 * The caller shouldn't assume that the track returned actually exists (it
1736 * might be removed between the choice and the callback, or between being added
1737 * to the queue and being played).
1739 int trackdb_request_random(ev_source
*ev
,
1740 random_callback
*callback
) {
1743 if(choose_pid
!= -1)
1744 return -1; /* don't run concurrent chooses */
1747 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1750 choose_callback
= callback
;
1751 choose_output
.nvec
= 0;
1752 choose_complete
= 0;
1753 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1754 "disorder-choose reader"); /* owns p[0] */
1755 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1759 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1760 * from the prefs. */
1761 static const char *getpart(const char *track
,
1762 const char *context
,
1764 const struct kvp
*p
,
1769 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1770 if((result
= kvp_get(p
, pref
)))
1773 result
= trackname_part(track
, context
, part
);
1774 assert(result
!= 0);
1778 /* get a track name part, like trackname_part(), but taking the database into
1780 const char *trackdb_getpart(const char *track
,
1781 const char *context
,
1789 /* construct the full pref */
1790 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1792 tid
= trackdb_begin_transaction();
1793 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1797 trackdb_abort_transaction(tid
);
1799 trackdb_commit_transaction(tid
);
1800 return getpart(actual
, context
, part
, p
, &used_db
);
1803 /* get the raw path name for @track@ (might be an alias) */
1804 const char *trackdb_rawpath(const char *track
) {
1810 tid
= trackdb_begin_transaction();
1811 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1815 trackdb_abort_transaction(tid
);
1817 trackdb_commit_transaction(tid
);
1818 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1822 /* trackdb_list **************************************************************/
1824 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1825 * readable at some point */
1827 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1828 * If RE is a null pointer then it matches everything. */
1829 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1837 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1838 case PCRE_ERROR_NOMATCH
: return 0;
1841 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1848 static int do_list(struct vector
*v
, const char *dir
,
1849 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1855 size_t l
, last_dir_len
= 0;
1856 char *last_dir
= 0, *track
;
1860 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1863 /* find the first key >= dir */
1864 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1865 /* keep going while we're dealing with <dir/anything> */
1868 && ((char *)k
.data
)[dl
] == '/'
1869 && !memcmp(k
.data
, dir
, dl
)) {
1870 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1872 /* we have <dir/component/anything>, so <dir/component> is a directory */
1873 l
= ptr
- (char *)k
.data
;
1874 if(what
& trackdb_directories
)
1876 && l
== last_dir_len
1877 && !memcmp(last_dir
, k
.data
, l
))) {
1878 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1879 if(track_matches(dl
, k
.data
, l
, re
))
1880 vector_append(v
, last_dir
);
1883 /* found a plain file */
1884 if((what
& trackdb_files
)) {
1885 track
= xstrndup(k
.data
, k
.size
);
1886 if((err
= trackdb_getdata(trackdb_prefsdb
,
1887 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1889 /* There's an awkward question here...
1891 * If a track shares a directory with its alias then we could
1892 * do one of three things:
1893 * - report both. Looks ridiculuous in most UIs.
1894 * - report just the alias. Remarkably inconvenient to write
1896 * - report just the real name. Ugly if the UI doesn't prettify
1897 * names via the name parts.
1900 /* If this file is an alias for a track in the same directory then we
1902 struct kvp
*t
= kvp_urldecode(d
.data
, d
.size
);
1903 const char *alias_target
= kvp_get(t
, "_alias_for");
1905 && !strcmp(d_dirname(alias_target
),
1907 if(track_matches(dl
, k
.data
, k
.size
, re
))
1908 vector_append(v
, track
);
1910 /* if this file has an alias in the same directory then we skip it */
1912 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1914 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1915 if(track_matches(dl
, k
.data
, k
.size
, re
))
1916 vector_append(v
, track
);
1920 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1928 case DB_LOCK_DEADLOCK
:
1929 error(0, "error querying database: %s", db_strerror(err
));
1932 fatal(0, "error querying database: %s", db_strerror(err
));
1935 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1939 /* return the directories or files below @dir@ */
1940 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1948 tid
= trackdb_begin_transaction();
1951 if(do_list(&v
, dir
, what
, re
, tid
))
1954 for(n
= 0; n
< config
->collection
.n
; ++n
)
1955 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1960 trackdb_abort_transaction(tid
);
1962 trackdb_commit_transaction(tid
);
1963 vector_terminate(&v
);
1969 /* If S is tag:something, return something. Else return 0. */
1970 static const char *checktag(const char *s
) {
1971 if(!strncmp(s
, "tag:", 4))
1977 /* return a list of tracks containing all of the words given. If you
1978 * ask for only stopwords you get no tracks. */
1979 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1980 const char **w
, *best
= 0, *tag
;
1981 char **twords
, **tags
;
1983 int i
, j
, n
, err
, what
;
1993 *ntracks
= 0; /* for early returns */
1994 /* normalize all the words */
1995 w
= xmalloc(nwordlist
* sizeof (char *));
1996 istag
= xmalloc_noptr(nwordlist
);
1997 for(n
= 0; n
< nwordlist
; ++n
) {
2001 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
2002 if(checktag(w
[n
])) {
2003 ++ntags
; /* count up tags */
2004 /* Normalize the tag */
2005 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2008 /* Normalize the search term by removing combining characters */
2009 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2011 nw32
= remove_combining_chars(w32
, nw32
);
2012 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2017 /* find the longest non-stopword */
2018 for(n
= 0; n
< nwordlist
; ++n
)
2019 if(!istag
[n
] && !stopword(w
[n
]))
2020 if(!best
|| strlen(w
[n
]) > strlen(best
))
2022 /* TODO: we should at least in principal be able to identify the word or tag
2023 * with the least matches in log time, and choose that as our primary search
2025 if(ntags
&& !best
) {
2026 /* Only tags are listed. We limit to the first and narrow down with the
2028 best
= istag
[0] ? w
[0] : 0;
2029 db
= trackdb_tagsdb
;
2032 /* We can limit to some word. */
2033 db
= trackdb_searchdb
;
2036 /* Only stopwords */
2042 tid
= trackdb_begin_transaction();
2043 /* find all the tracks that have that word */
2048 cursor
= trackdb_opencursor(db
, tid
);
2049 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2050 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2057 case DB_LOCK_DEADLOCK
:
2058 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2061 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2063 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2065 /* do a naive search over that (hopefuly fairly small) list of tracks */
2067 for(n
= 0; n
< v
.nvec
; ++n
) {
2068 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2071 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2074 twords
= track_to_words(v
.vec
[n
], p
);
2075 tags
= parsetags(kvp_get(p
, "tags"));
2076 for(i
= 0; i
< nwordlist
; ++i
) {
2079 /* Track must have this tag */
2080 for(j
= 0; tags
[j
]; ++j
)
2081 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2082 if(!tags
[j
]) break; /* tag not found */
2084 /* Track must contain this word */
2085 for(j
= 0; twords
[j
]; ++j
)
2086 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2087 if(!twords
[j
]) break; /* word not found */
2090 if(i
>= nwordlist
) /* all words found */
2091 vector_append(&u
, v
.vec
[n
]);
2095 trackdb_closecursor(cursor
);
2097 trackdb_abort_transaction(tid
);
2098 info("retrying search");
2100 trackdb_commit_transaction(tid
);
2101 vector_terminate(&u
);
2107 /* trackdb_scan **************************************************************/
2109 int trackdb_scan(const char *root
,
2110 int (*callback
)(const char *track
,
2119 const size_t root_len
= root ?
strlen(root
) : 0;
2121 struct kvp
*data
, *prefs
;
2124 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2126 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2129 memset(&k
, 0, sizeof k
);
2130 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2135 || (k
.size
> root_len
2136 && !strncmp(k
.data
, root
, root_len
)
2137 && ((char *)k
.data
)[root_len
] == '/')) {
2138 data
= kvp_urldecode(d
.data
, d
.size
);
2139 if(kvp_get(data
, "_path")) {
2140 track
= xstrndup(k
.data
, k
.size
);
2141 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2142 * do a lookup for every single track. In fact this is quite quick:
2143 * with around 10,000 tracks a complete scan is around 0.3s on my
2144 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2145 * linear walk as we already do over trackdb_tracksdb, and probably get
2146 * even higher performance. That would require upgrade logic to
2147 * translate old databases though.
2149 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2150 prepare_data(&pd
), 0)) {
2152 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2157 case DB_LOCK_DEADLOCK
:
2158 error(0, "getting prefs: %s", db_strerror(err
));
2159 trackdb_closecursor(cursor
);
2162 fatal(0, "getting prefs: %s", db_strerror(err
));
2164 /* Advance to the next track before the callback so that the callback
2165 * may safely delete the track */
2166 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2167 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2172 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2176 trackdb_closecursor(cursor
);
2183 case DB_LOCK_DEADLOCK
:
2184 error(0, "c->c_get: %s", db_strerror(err
));
2187 fatal(0, "c->c_get: %s", db_strerror(err
));
2191 /* trackdb_rescan ************************************************************/
2193 /** @brief Node in the list of rescan-complete callbacks */
2194 struct rescanned_node
{
2195 struct rescanned_node
*next
;
2196 void (*rescanned
)(void *ru
);
2200 /** @brief List of rescan-complete callbacks */
2201 static struct rescanned_node
*rescanned_list
;
2203 /** @brief Add a rescan completion callback */
2204 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2207 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2208 n
->next
= rescanned_list
;
2209 n
->rescanned
= rescanned
;
2215 /* called when the rescanner terminates */
2216 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2219 const struct rusage
attribute((unused
)) *rusage
,
2220 void attribute((unused
)) *u
) {
2221 if(pid
== rescan_pid
) rescan_pid
= -1;
2223 error(0, RESCAN
": %s", wstat(status
));
2225 D((RESCAN
" terminated: %s", wstat(status
)));
2226 /* Our cache of file lookups is out of date now */
2227 cache_clean(&cache_files_type
);
2228 eventlog("rescanned", (char *)0);
2229 /* Call rescanned callbacks */
2230 while(rescanned_list
) {
2231 void (*rescanned
)(void *u_
) = rescanned_list
->rescanned
;
2232 void *ru
= rescanned_list
->ru
;
2234 rescanned_list
= rescanned_list
->next
;
2240 /** @brief Initiate a rescan
2241 * @param ev Event loop or 0 to block
2242 * @param recheck 1 to recheck lengths, 0 to suppress check
2243 * @param rescanned Called on completion (if not NULL)
2244 * @param u Passed to @p rescanned
2246 void trackdb_rescan(ev_source
*ev
, int recheck
,
2247 void (*rescanned
)(void *ru
),
2251 if(rescan_pid
!= -1) {
2252 trackdb_add_rescanned(rescanned
, ru
);
2253 error(0, "rescan already underway");
2256 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2257 recheck ?
"--check" : "--no-check",
2259 trackdb_add_rescanned(rescanned
, ru
);
2261 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2262 D(("started rescanner"));
2264 /* This is the first rescan, we block until it is complete */
2265 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2267 reap_rescan(0, rescan_pid
, w
, 0, 0);
2271 int trackdb_rescan_cancel(void) {
2272 if(rescan_pid
== -1) return 0;
2273 if(kill(rescan_pid
, SIGTERM
) < 0)
2274 fatal(errno
, "error killing rescanner");
2279 /** @brief Return true if a rescan is underway */
2280 int trackdb_rescan_underway(void) {
2281 return rescan_pid
!= -1;
2284 /* global prefs **************************************************************/
2286 void trackdb_set_global(const char *name
,
2294 tid
= trackdb_begin_transaction();
2295 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2297 trackdb_abort_transaction(tid
);
2299 trackdb_commit_transaction(tid
);
2300 /* log important state changes */
2301 if(!strcmp(name
, "playing")) {
2302 state
= !value
|| !strcmp(value
, "yes");
2303 info("playing %s by %s",
2304 state ?
"enabled" : "disabled",
2306 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2308 if(!strcmp(name
, "random-play")) {
2309 state
= !value
|| !strcmp(value
, "yes");
2310 info("random play %s by %s",
2311 state ?
"enabled" : "disabled",
2313 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2317 int trackdb_set_global_tid(const char *name
,
2323 memset(&k
, 0, sizeof k
);
2324 memset(&d
, 0, sizeof d
);
2325 k
.data
= (void *)name
;
2326 k
.size
= strlen(name
);
2328 d
.data
= (void *)value
;
2329 d
.size
= strlen(value
);
2332 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2334 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2335 if(err
== DB_LOCK_DEADLOCK
) return err
;
2337 fatal(0, "error updating database: %s", db_strerror(err
));
2341 const char *trackdb_get_global(const char *name
) {
2347 tid
= trackdb_begin_transaction();
2348 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2350 trackdb_abort_transaction(tid
);
2352 trackdb_commit_transaction(tid
);
2356 int trackdb_get_global_tid(const char *name
,
2362 memset(&k
, 0, sizeof k
);
2363 k
.data
= (void *)name
;
2364 k
.size
= strlen(name
);
2365 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2366 prepare_data(&d
), 0)) {
2368 *rp
= xstrndup(d
.data
, d
.size
);
2373 case DB_LOCK_DEADLOCK
:
2376 fatal(0, "error reading database: %s", db_strerror(err
));
2380 /** @brief Retrieve the most recently added tracks
2381 * @param ntracksp Where to put count, or 0
2382 * @param maxtracks Maximum number of tracks to retrieve
2383 * @return null-terminated array of track names
2385 * The most recently added track is first in the array.
2387 char **trackdb_new(int *ntracksp
,
2393 tid
= trackdb_begin_transaction();
2394 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2397 trackdb_abort_transaction(tid
);
2399 trackdb_commit_transaction(tid
);
2403 /** @brief Retrieve the most recently added tracks
2404 * @param ntracksp Where to put count, or 0
2405 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2406 * @param tid Transaction ID
2407 * @return null-terminated array of track names, or NULL on deadlock
2409 * The most recently added track is first in the array.
2411 * TODO: exclude tracks that have been deleted again.
2414 static char **trackdb_new_tid(int *ntracksp
,
2420 struct vector tracks
[1];
2422 vector_init(tracks
);
2423 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2424 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2425 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2426 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2428 case 0: /* hit maxtracks */
2429 case DB_NOTFOUND
: /* ran out of tracks */
2431 case DB_LOCK_DEADLOCK
:
2432 trackdb_closecursor(c
);
2435 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2437 if((err
= trackdb_closecursor(c
)))
2438 return 0; /* deadlock */
2439 vector_terminate(tracks
);
2441 *ntracksp
= tracks
->nvec
;
2445 /** @brief Expire noticed.db
2446 * @param earliest Earliest timestamp to keep
2448 void trackdb_expire_noticed(time_t earliest
) {
2452 tid
= trackdb_begin_transaction();
2453 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2455 trackdb_abort_transaction(tid
);
2457 trackdb_commit_transaction(tid
);
2460 /** @brief Expire noticed.db
2461 * @param earliest Earliest timestamp to keep
2462 * @param tid Transaction ID
2463 * @return 0 or DB_LOCK_DEADLOCK
2465 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2473 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2474 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2476 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2477 if(when
>= earliest
)
2479 if((err
= c
->c_del(c
, 0))) {
2480 if(err
!= DB_LOCK_DEADLOCK
)
2481 fatal(0, "error deleting expired noticed.db entry: %s",
2487 if(err
== DB_NOTFOUND
)
2489 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2490 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2492 if((err
= trackdb_closecursor(c
))) {
2493 if(err
!= DB_LOCK_DEADLOCK
)
2494 fatal(0, "error closing cursor: %s", db_strerror(err
));
2498 info("expired %d tracks from noticed.db", count
);
2502 /* tidying up ****************************************************************/
2504 void trackdb_gc(void) {
2508 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2509 config
->checkpoint_kbyte
,
2510 config
->checkpoint_min
,
2512 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2513 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2514 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2515 /* This makes catastrophic recovery impossible. However, the user can still
2516 * preserve the important data by using disorder-dump to snapshot their
2517 * prefs, and later to restore it. This is likely to have much small
2518 * long-term storage requirements than record the db logfiles. */
2521 /* user database *************************************************************/
2523 /** @brief Return true if @p user is trusted */
2524 static int trusted(const char *user
) {
2527 for(n
= 0; (n
< config
->trust
.n
2528 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2530 return n
< config
->trust
.n
;
2533 /** @brief Return non-zero for a valid username
2535 * Currently we only allow the letters and digits in ASCII. We could be more
2536 * liberal than this but it is a nice simple test. It is critical that
2537 * semicolons are never allowed.
2539 static int valid_username(const char *user
) {
2543 const uint8_t c
= *user
++;
2544 /* For now we are very strict */
2545 if((c
>= 'a' && c
<= 'z')
2546 || (c
>= 'A' && c
<= 'Z')
2547 || (c
>= '0' && c
<= '9'))
2555 /** @brief Add a user */
2556 static int create_user(const char *user
,
2557 const char *password
,
2560 const char *confirmation
,
2566 /* sanity check user */
2567 if(!valid_username(user
)) {
2568 error(0, "invalid username '%s'", user
);
2571 if(parse_rights(rights
, 0, 1)) {
2572 error(0, "invalid rights string");
2575 /* data for this user */
2577 kvp_set(&k
, "password", password
);
2578 kvp_set(&k
, "rights", rights
);
2580 kvp_set(&k
, "email", email
);
2582 kvp_set(&k
, "confirmation", confirmation
);
2583 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2584 kvp_set(&k
, "created", s
);
2585 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2588 /** @brief Add one pre-existing user */
2589 static int one_old_user(const char *user
, const char *password
,
2593 /* www-data doesn't get added */
2594 if(!strcmp(user
, "www-data")) {
2595 info("not adding www-data to user database");
2599 if(!strcmp(user
, "root"))
2601 else if(trusted(user
)) {
2604 parse_rights(config
->default_rights
, &r
, 1);
2605 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2606 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2607 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2608 rights
= rights_string(r
);
2610 rights
= config
->default_rights
;
2611 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2612 tid
, DB_NOOVERWRITE
);
2615 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2618 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2619 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2622 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2625 error(0, "user %s already exists, delete 'allow' directive",
2626 config
->allow
.s
[n
].s
[0]);
2627 /* This won't ever become fatal - eventually 'allow' will be
2630 case DB_LOCK_DEADLOCK
:
2631 return DB_LOCK_DEADLOCK
;
2637 /** @brief Read old 'allow' directives and copy them to the users database */
2638 void trackdb_old_users(void) {
2642 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2645 /** @brief Create a root user in the user database if there is none */
2646 void trackdb_create_root(void) {
2651 /* Choose a new root password */
2652 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2653 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2654 /* Create the root user if it does not exist */
2655 WITH_TRANSACTION(create_user("root", pw
, "all",
2656 0/*email*/, 0/*confirmation*/,
2657 tid
, DB_NOOVERWRITE
));
2659 info("created root user");
2662 /** @brief Find a user's password from the database
2663 * @param user Username
2664 * @return Password or NULL
2666 * Only works if running as a user that can read the database!
2668 * If the user exists but has no password, "" is returned.
2670 const char *trackdb_get_password(const char *user
) {
2673 const char *password
;
2675 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2678 password
= kvp_get(k
, "password");
2679 return password ? password
: "";
2682 /** @brief Add a new user
2683 * @param user Username
2684 * @param password Password or NULL
2685 * @param rights Initial rights
2686 * @param email Email address or NULL
2687 * @param confirmation Confirmation string or NULL
2688 * @return 0 on success, non-0 on error
2690 int trackdb_adduser(const char *user
,
2691 const char *password
,
2694 const char *confirmation
) {
2697 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2698 tid
, DB_NOOVERWRITE
));
2700 error(0, "cannot create user '%s' because they already exist", user
);
2704 info("created user '%s' with rights '%s' and email address '%s'",
2705 user
, rights
, email
);
2707 info("created user '%s' with rights '%s'", user
, rights
);
2708 eventlog("user_add", user
, (char *)0);
2713 /** @brief Delete a user
2714 * @param user User to delete
2715 * @return 0 on success, non-0 if the user didn't exist anyway
2717 int trackdb_deluser(const char *user
) {
2720 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2722 error(0, "cannot delete user '%s' because they do not exist", user
);
2725 info("deleted user '%s'", user
);
2726 eventlog("user_delete", user
, (char *)0);
2730 /** @brief Get user information
2731 * @param user User to query
2732 * @return Linked list of user information or NULL if user does not exist
2734 * Every user has at least a @c rights entry so NULL can be used to mean no
2737 struct kvp
*trackdb_getuserinfo(const char *user
) {
2741 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2748 /** @brief Edit user information
2749 * @param user User to edit
2750 * @param key Key to change
2751 * @param value Value to set, or NULL to remove
2752 * @param tid Transaction ID
2753 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2755 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2756 const char *value
, DB_TXN
*tid
) {
2760 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2762 if(!kvp_set(&k
, key
, value
))
2763 return 0; /* no change */
2764 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2767 /** @brief Edit user information
2768 * @param user User to edit
2769 * @param key Key to change
2770 * @param value Value to set, or NULL to remove
2771 * @return 0 on success, non-0 on error
2773 int trackdb_edituserinfo(const char *user
,
2774 const char *key
, const char *value
) {
2777 if(!strcmp(key
, "rights")) {
2779 error(0, "cannot remove 'rights' key from user '%s'", user
);
2782 if(parse_rights(value
, 0, 1)) {
2783 error(0, "invalid rights string");
2786 } else if(!strcmp(key
, "email")) {
2788 if(!email_valid(value
)) {
2789 error(0, "invalid email address '%s' for user '%s'", value
, user
);
2793 value
= 0; /* no email -> remove key */
2794 } else if(!strcmp(key
, "created")) {
2795 error(0, "cannot change creation date for user '%s'", user
);
2797 } else if(strcmp(key
, "password")
2798 && !strcmp(key
, "confirmation")) {
2799 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2802 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2804 error(0, "unknown user '%s'", user
);
2807 eventlog("user_edit", user
, key
, (char *)0);
2812 /** @brief List all users
2813 * @return NULL-terminated list of users
2815 char **trackdb_listusers(void) {
2820 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2824 /** @brief Confirm a user registration
2825 * @param user Username
2826 * @param confirmation Confirmation string
2827 * @param rightsp Where to put user rights
2828 * @param tid Transaction ID
2829 * @return 0 on success, non-0 on error
2831 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2832 rights_type
*rightsp
,
2834 const char *stored_confirmation
;
2839 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2841 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2842 error(0, "already confirmed user '%s'", user
);
2843 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2846 if(!(rights
= kvp_get(k
, "rights"))) {
2847 error(0, "no rights for unconfirmed user '%s'", user
);
2850 if(parse_rights(rights
, rightsp
, 1))
2852 if(strcmp(confirmation
, stored_confirmation
)) {
2853 error(0, "wrong confirmation string for user '%s'", user
);
2857 kvp_set(&k
, "confirmation", 0);
2858 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2861 /** @brief Confirm a user registration
2862 * @param user Username
2863 * @param confirmation Confirmation string
2864 * @param rightsp Where to put user rights
2865 * @return 0 on success, non-0 on error
2867 int trackdb_confirm(const char *user
, const char *confirmation
,
2868 rights_type
*rightsp
) {
2871 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2874 info("registration confirmed for user '%s'", user
);
2875 eventlog("user_confirm", user
, (char *)0);
2878 error(0, "confirmation for nonexistent user '%s'", user
);
2880 default: /* already reported */
2890 indent-tabs-mode:nil