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 /** @brief Fetch and decode a database entry
514 * @param track Track name
515 * @param kp Where to put decoded list (or NULL if you don't care)
516 * @param tid Owning transaction
517 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
519 int trackdb_getdata(DB
*db
,
526 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
527 prepare_data(&data
), 0)) {
530 *kp
= kvp_urldecode(data
.data
, data
.size
);
536 case DB_LOCK_DEADLOCK
:
537 error(0, "error querying database: %s", db_strerror(err
));
540 fatal(0, "error querying database: %s", db_strerror(err
));
544 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
545 * DB_LOCK_DEADLOCK. */
546 int trackdb_putdata(DB
*db
,
554 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
555 encode_data(&data
, k
), flags
)) {
559 case DB_LOCK_DEADLOCK
:
560 error(0, "error updating database: %s", db_strerror(err
));
563 fatal(0, "error updating database: %s", db_strerror(err
));
567 /** @brief Delete a database entry
569 * @param track Key to delete
570 * @param tid Transaction ID
571 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
573 int trackdb_delkey(DB
*db
,
579 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
583 case DB_LOCK_DEADLOCK
:
584 error(0, "error updating database: %s", db_strerror(err
));
587 fatal(0, "error updating database: %s", db_strerror(err
));
591 /* open a database cursor */
592 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
596 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
598 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
603 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
604 int trackdb_closecursor(DBC
*c
) {
608 switch(err
= c
->c_close(c
)) {
611 case DB_LOCK_DEADLOCK
:
612 error(0, "error closing cursor: %s", db_strerror(err
));
615 fatal(0, "error closing cursor: %s", db_strerror(err
));
619 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
620 int trackdb_delkeydata(DB
*db
,
628 c
= trackdb_opencursor(db
, tid
);
629 switch(err
= c
->c_get(c
, make_key(&key
, word
),
630 make_key(&data
, track
), DB_GET_BOTH
)) {
632 switch(err
= c
->c_del(c
, 0)) {
638 case DB_LOCK_DEADLOCK
:
639 error(0, "error updating database: %s", db_strerror(err
));
642 fatal(0, "c->c_del: %s", db_strerror(err
));
647 case DB_LOCK_DEADLOCK
:
648 error(0, "error updating database: %s", db_strerror(err
));
651 fatal(0, "c->c_get: %s", db_strerror(err
));
653 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
657 /* start a transaction */
658 DB_TXN
*trackdb_begin_transaction(void) {
662 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
663 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
667 /* abort transaction */
668 void trackdb_abort_transaction(DB_TXN
*tid
) {
672 if((err
= tid
->abort(tid
)))
673 fatal(0, "tid->abort: %s", db_strerror(err
));
676 /* commit transaction */
677 void trackdb_commit_transaction(DB_TXN
*tid
) {
680 if((err
= tid
->commit(tid
, 0)))
681 fatal(0, "tid->commit: %s", db_strerror(err
));
684 /* search/tags shared code ***************************************************/
686 /* comparison function used by dedupe() */
687 static int wordcmp(const void *a
, const void *b
) {
688 return strcmp(*(const char **)a
, *(const char **)b
);
691 /* sort and de-dupe VEC */
692 static char **dedupe(char **vec
, int nvec
) {
695 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
699 for(n
= 1; n
< nvec
; ++n
)
700 if(strcmp(vec
[n
], vec
[m
- 1]))
707 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
708 static int register_word(DB
*db
, const char *what
,
709 const char *track
, const char *word
,
714 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
715 make_key(&data
, track
), DB_NODUPDATA
)) {
719 case DB_LOCK_DEADLOCK
:
720 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
723 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
727 /* search primitives *********************************************************/
729 /* return true iff NAME is a trackname_display_ pref */
730 static int is_display_pref(const char *name
) {
731 static const char prefix
[] = "trackname_display_";
732 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
735 /** @brief Word_Break property tailor that treats underscores as spaces */
736 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
740 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
741 return unicode_Word_Break_Other
;
745 /** @brief Remove all combining characters in-place
746 * @param s Pointer to start of string
747 * @param ns Length of string
748 * @return New, possiblby reduced, length
750 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
751 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
754 const uint32_t c
= *s
++;
755 if(!utf32_combining_class(c
))
761 /** @brief Normalize and split a string using a given tailoring */
762 static void word_split(struct vector
*v
,
764 unicode_property_tailor
*pt
) {
766 uint32_t *t32
, **w32
;
768 /* Convert to UTF-32 */
769 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
771 /* Erase case distinctions */
772 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
774 /* Drop combining characters */
775 nt32
= remove_combining_chars(t32
, nt32
);
776 /* Split into words, treating _ as a space */
777 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
778 /* Convert words back to UTF-8 and append to result */
779 for(i
= 0; i
< nw
; ++i
)
780 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
783 /** @brief Normalize a tag
785 * @param ns Length of tag
786 * @return Normalized string or NULL on error
788 * The return value will be:
790 * - have no leading or trailing space
791 * - have no combining characters
792 * - all spacing between words will be a single U+0020 SPACE
794 static char *normalize_tag(const char *s
, size_t ns
) {
795 uint32_t *s32
, **w32
;
796 size_t ns32
, nw32
, i
;
799 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
801 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
803 ns32
= remove_combining_chars(s32
, ns32
);
804 /* Split into words, no Word_Break tailoring */
805 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
806 /* Compose back into a string */
808 for(i
= 0; i
< nw32
; ++i
) {
810 dynstr_append(d
, ' ');
811 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
817 /* compute the words of a track name */
818 static char **track_to_words(const char *track
,
819 const struct kvp
*p
) {
821 const char *rootless
= track_rootless(track
);
824 rootless
= track
; /* bodge */
826 rootless
= strip_extension(rootless
);
827 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
828 for(; p
; p
= p
->next
)
829 if(is_display_pref(p
->name
))
830 word_split(&v
, p
->value
, 0);
831 vector_terminate(&v
);
832 return dedupe(v
.vec
, v
.nvec
);
835 /* return nonzero iff WORD is a stopword */
836 static int stopword(const char *word
) {
839 for(n
= 0; n
< config
->stopword
.n
840 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
842 return n
< config
->stopword
.n
;
845 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
846 static int register_search_word(const char *track
, const char *word
,
848 if(stopword(word
)) return 0;
849 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
852 /* Tags **********************************************************************/
854 /* Return nonzero if C is a valid tag character */
855 static int tagchar(int c
) {
864 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
865 char **parsetags(const char *s
) {
871 /* skip initial separators */
872 while(*s
&& (!tagchar(*s
) || *s
== ' '))
875 /* find the extent of the tag */
877 while(*s
&& tagchar(*s
))
879 /* strip trailing spaces */
880 while(s
> t
&& s
[-1] == ' ')
882 /* add tag to list */
883 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
884 /* skip intermediate and trailing separators */
885 while(*s
&& (!tagchar(*s
) || *s
== ' '))
889 vector_terminate(&v
);
890 return dedupe(v
.vec
, v
.nvec
);
893 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
894 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
895 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
898 /* aliases *******************************************************************/
900 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
901 * there is no alias sets *aliasp to 0. */
902 static int compute_alias(char **aliasp
,
907 const char *s
= config
->alias
, *t
, *expansion
, *part
;
908 int c
, used_db
= 0, slash_prefix
, err
;
910 const char *const root
= find_track_root(track
);
913 /* Bodge for tracks with no root */
918 dynstr_append_string(&d
, root
);
919 while((c
= (unsigned char)*s
++)) {
921 dynstr_append(&d
, c
);
924 if((slash_prefix
= (*s
== '/')))
927 assert(t
!= 0); /* validated at startup */
928 part
= xstrndup(s
, t
- s
);
929 expansion
= getpart(track
, "display", part
, p
, &used_db
);
931 if(slash_prefix
) dynstr_append(&d
, '/');
932 dynstr_append_string(&d
, expansion
);
934 s
= t
+ 1; /* skip {part} */
936 /* only admit to the alias if we used the db... */
941 dynstr_terminate(&d
);
942 /* ...and the answer differs from the original... */
943 if(!strcmp(track
, d
.vec
)) {
947 /* ...and there isn't already a different track with that name (including as
949 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
951 if((s
= kvp_get(at
, "_alias_for"))
952 && !strcmp(s
, track
)) {
964 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
965 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
966 * Always sets the return values, even if only to null pointers. */
967 static int gettrackdata(const char *track
,
970 const char **actualp
,
972 #define GTD_NOALIAS 0x0001
975 const char *actual
= track
;
976 struct kvp
*t
= 0, *p
= 0;
978 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
979 if((actual
= kvp_get(t
, "_alias_for"))) {
980 if(flags
& GTD_NOALIAS
) {
981 error(0, "alias passed to gettrackdata where real path required");
984 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
989 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
994 if(actualp
) *actualp
= actual
;
1000 /* trackdb_notice() **********************************************************/
1002 /** @brief notice a possibly new track
1003 * @return @c DB_NOTFOUND if new, 0 if already known
1005 int trackdb_notice(const char *track
,
1011 tid
= trackdb_begin_transaction();
1012 err
= trackdb_notice_tid(track
, path
, tid
);
1013 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1016 trackdb_abort_transaction(tid
);
1018 trackdb_commit_transaction(tid
);
1022 /** @brief notice a possibly new track
1023 * @param track NFC UTF-8 track name
1024 * @param path Raw path name
1025 * @param tid Transaction ID
1026 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1028 int trackdb_notice_tid(const char *track
,
1032 struct kvp
*t
, *a
, *p
;
1034 char *alias
, **w
, *noticed
;
1037 /* notice whether the tracks.db entry changes */
1039 /* get any existing tracks entry */
1040 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1042 ret
= err
; /* 0 or DB_NOTFOUND */
1043 /* this is a real track */
1044 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1045 t_changed
+= kvp_set(&t
, "_path", path
);
1047 if(ret
== DB_NOTFOUND
) {
1048 /* It's a new track; record the time */
1049 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1050 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1052 /* if we have an alias record it in the database */
1053 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1055 /* won't overwrite someone else's alias as compute_alias() checks */
1056 D(("%s: alias %s", track
, alias
));
1058 kvp_set(&a
, "_alias_for", track
);
1059 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1061 /* update search.db */
1062 w
= track_to_words(track
, p
);
1063 for(n
= 0; w
[n
]; ++n
)
1064 if((err
= register_search_word(track
, w
[n
], tid
)))
1066 /* update tags.db */
1067 w
= parsetags(kvp_get(p
, "tags"));
1068 for(n
= 0; w
[n
]; ++n
)
1069 if((err
= register_tag(track
, w
[n
], tid
)))
1071 /* only store the tracks.db entry if it has changed */
1072 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1074 if(ret
== DB_NOTFOUND
) {
1075 uint32_t timestamp
[2];
1078 timestamp
[0] = htonl((uint64_t)now
>> 32);
1079 timestamp
[1] = htonl((uint32_t)now
);
1080 memset(&key
, 0, sizeof key
);
1081 key
.data
= timestamp
;
1082 key
.size
= sizeof timestamp
;
1083 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1084 make_key(&data
, track
), 0)) {
1086 case DB_LOCK_DEADLOCK
: return err
;
1087 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1093 /* trackdb_obsolete() ********************************************************/
1095 /* obsolete a track */
1096 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1101 if((err
= gettrackdata(track
, 0, &p
, 0,
1102 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1104 else if(err
== DB_NOTFOUND
) return 0;
1105 /* compute the alias, if any, and delete it */
1106 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1108 /* if the alias points to some other track then compute_alias won't
1110 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1111 && err
!= DB_NOTFOUND
)
1114 /* update search.db */
1115 w
= track_to_words(track
, p
);
1116 for(n
= 0; w
[n
]; ++n
)
1117 if(trackdb_delkeydata(trackdb_searchdb
,
1118 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1120 /* update tags.db */
1121 w
= parsetags(kvp_get(p
, "tags"));
1122 for(n
= 0; w
[n
]; ++n
)
1123 if(trackdb_delkeydata(trackdb_tagsdb
,
1124 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1126 /* update tracks.db */
1127 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1129 /* We don't delete the prefs, so they survive temporary outages of the
1130 * (possibly virtual) track filesystem */
1134 /* trackdb_stats() ***********************************************************/
1136 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1137 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1139 static const struct statinfo
{
1142 } statinfo_hash
[] = {
1158 }, statinfo_btree
[] = {
1179 /* look up stats for DB */
1180 static int get_stats(struct vector
*v
,
1182 const struct statinfo
*si
,
1191 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1194 case DB_LOCK_DEADLOCK
:
1195 error(0, "error querying database: %s", db_strerror(err
));
1198 fatal(0, "error querying database: %s", db_strerror(err
));
1200 for(n
= 0; n
< nsi
; ++n
) {
1201 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1202 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1203 vector_append(v
, str
);
1209 /** @brief One entry in the search league */
1210 struct search_entry
{
1215 /** @brief Add a word to the search league
1216 * @param se Pointer to search league
1217 * @param count Maximum size for search league
1218 * @param nse Current size of search league
1219 * @param word New word, or NULL
1220 * @param n How often @p word appears
1221 * @return New size of search league
1223 static int register_search_entry(struct search_entry
*se
,
1230 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1231 /* Find the starting point */
1236 /* Find the insertion point */
1237 while(i
> 0 && n
> se
[i
- 1].n
)
1239 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1246 /* find the top COUNT words in the search database */
1247 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1248 struct search_entry
*se
;
1251 int err
, n
= 0, nse
= 0, i
;
1256 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1257 se
= xmalloc(count
* sizeof *se
);
1258 /* Walk across the whole database counting up the number of times each
1260 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1262 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1263 ++n
; /* same word again */
1265 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1266 word
= xstrndup(k
.data
, wl
= k
.size
);
1274 case DB_LOCK_DEADLOCK
:
1275 error(0, "error querying search database: %s", db_strerror(err
));
1278 fatal(0, "error querying search database: %s", db_strerror(err
));
1280 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1282 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1283 byte_xasprintf(&str
, "Top %d search words:", nse
);
1284 vector_append(v
, str
);
1285 for(i
= 0; i
< nse
; ++i
) {
1286 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1287 vector_append(v
, str
);
1292 #define SI(what) statinfo_##what, \
1293 sizeof statinfo_##what / sizeof (struct statinfo)
1295 /* return a list of database stats */
1296 char **trackdb_stats(int *nstatsp
) {
1302 tid
= trackdb_begin_transaction();
1304 vector_append(&v
, (char *)"Tracks database stats:");
1305 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1306 vector_append(&v
, (char *)"");
1307 vector_append(&v
, (char *)"Search database stats:");
1308 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1309 vector_append(&v
, (char *)"");
1310 vector_append(&v
, (char *)"Prefs database stats:");
1311 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1312 vector_append(&v
, (char *)"");
1313 if(search_league(&v
, 10, tid
)) goto fail
;
1314 vector_terminate(&v
);
1317 trackdb_abort_transaction(tid
);
1319 trackdb_commit_transaction(tid
);
1320 if(nstatsp
) *nstatsp
= v
.nvec
;
1324 struct stats_details
{
1325 void (*done
)(char *data
, void *u
);
1327 int exited
; /* subprocess exited */
1328 int closed
; /* pipe close */
1329 int wstat
; /* wait status from subprocess */
1330 struct dynstr data
[1]; /* data read from pipe */
1333 static void stats_complete(struct stats_details
*d
) {
1336 if(!(d
->exited
&& d
->closed
))
1338 byte_xasprintf(&s
, "\n"
1340 "track lookup cache hits: %lu\n"
1341 "track lookup cache misses: %lu\n",
1343 cache_files_misses
);
1344 dynstr_append_string(d
->data
, s
);
1345 dynstr_terminate(d
->data
);
1346 d
->done(d
->data
->vec
, d
->u
);
1349 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1350 pid_t
attribute((unused
)) pid
,
1352 const struct rusage
attribute((unused
)) *rusage
,
1354 struct stats_details
*const d
= u
;
1358 error(0, "disorder-stats %s", wstat(status
));
1363 static int stats_read(ev_source
attribute((unused
)) *ev
,
1369 struct stats_details
*const d
= u
;
1371 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1372 ev_reader_consume(reader
, bytes
);
1379 static int stats_error(ev_source
attribute((unused
)) *ev
,
1382 struct stats_details
*const d
= u
;
1384 error(errno_value
, "error reading from pipe to disorder-stats");
1390 void trackdb_stats_subprocess(ev_source
*ev
,
1391 void (*done
)(char *data
, void *u
),
1395 struct stats_details
*d
= xmalloc(sizeof *d
);
1397 dynstr_init(d
->data
);
1401 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1403 ev_child(ev
, pid
, 0, stats_finished
, d
);
1404 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1407 /** @brief Parse a track name part preference
1408 * @param name Preference name
1409 * @param partp Where to store part name
1410 * @param contextp Where to store context name
1411 * @return 0 on success, non-0 if parse fails
1413 static int trackdb__parse_namepref(const char *name
,
1417 static const char prefix
[] = "trackname_";
1419 if(strncmp(name
, prefix
, strlen(prefix
)))
1420 return -1; /* not trackname_* at all */
1421 name
+= strlen(prefix
);
1422 /* There had better be a _ between context and part */
1423 c
= strchr(name
, '_');
1426 /* Context is first in the pref name even though most APIs have the part
1427 * first. Confusing; sorry. */
1428 *contextp
= xstrndup(name
, c
- name
);
1430 /* There had better NOT be a second _ */
1433 *partp
= xstrdup(c
);
1437 /** @brief Compute the default value for a track preference
1438 * @param track Track name
1439 * @param name Preference name
1440 * @return Default value or 0 if none/not known
1442 static const char *trackdb__default(const char *track
, const char *name
) {
1443 char *context
, *part
;
1445 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1446 /* We can work out the default for a trackname_ pref */
1447 return trackname_part(track
, context
, part
);
1448 } else if(!strcmp(name
, "weight")) {
1449 /* We know the default weight */
1451 } else if(!strcmp(name
, "pick_at_random")) {
1452 /* By default everything is eligible for picking at random */
1454 } else if(!strcmp(name
, "tags")) {
1455 /* By default everything no track has any tags */
1461 /* set a pref (remove if value=0) */
1462 int trackdb_set(const char *track
,
1464 const char *value
) {
1465 struct kvp
*t
, *p
, *a
;
1468 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1471 /* If the value matches the default then unset instead, to keep the database
1472 * tidy. Older versions did not have this feature so your database may yet
1473 * have some default values stored in it. */
1475 def
= trackdb__default(track
, name
);
1476 if(def
&& !strcmp(value
, def
))
1481 tid
= trackdb_begin_transaction();
1482 if((err
= gettrackdata(track
, &t
, &p
, 0,
1483 0, tid
)) == DB_LOCK_DEADLOCK
)
1485 if(err
== DB_NOTFOUND
) break;
1486 if(name
[0] == '_') {
1487 if(kvp_set(&t
, name
, value
))
1488 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1491 /* get the old alias name */
1492 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1493 /* get the old tags */
1494 if(!strcmp(name
, "tags"))
1495 oldtags
= parsetags(kvp_get(p
, "tags"));
1497 if(kvp_set(&p
, name
, value
))
1498 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1500 /* compute the new alias name */
1501 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1502 /* check whether alias has changed */
1503 if(!(oldalias
== newalias
1504 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1505 /* adjust alias records to fit change */
1507 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1511 kvp_set(&a
, "_alias_for", track
);
1512 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1515 /* check whether tags have changed */
1516 if(!strcmp(name
, "tags")) {
1517 newtags
= parsetags(value
);
1518 while(*oldtags
|| *newtags
) {
1519 if(*oldtags
&& *newtags
) {
1520 cmp
= strcmp(*oldtags
, *newtags
);
1522 /* keeping this tag */
1526 /* old tag fits into a gap in the new list, so delete old */
1529 /* new tag fits into a gap in the old list, so insert new */
1531 } else if(*oldtags
) {
1532 /* we've run out of new tags, so remaining old ones are to be
1535 if(trackdb_delkeydata(trackdb_tagsdb
,
1536 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1540 /* we've run out of old tags, so remainig new ones are to be
1543 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1552 trackdb_abort_transaction(tid
);
1554 trackdb_commit_transaction(tid
);
1555 return err
== 0 ?
0 : -1;
1559 const char *trackdb_get(const char *track
,
1561 return kvp_get(trackdb_get_all(track
), name
);
1564 /* get all prefs as a 0-terminated array */
1565 struct kvp
*trackdb_get_all(const char *track
) {
1566 struct kvp
*t
, *p
, **pp
;
1570 tid
= trackdb_begin_transaction();
1571 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1575 trackdb_abort_transaction(tid
);
1577 trackdb_commit_transaction(tid
);
1578 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1585 const char *trackdb_resolve(const char *track
) {
1590 tid
= trackdb_begin_transaction();
1591 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1595 trackdb_abort_transaction(tid
);
1597 trackdb_commit_transaction(tid
);
1601 int trackdb_isalias(const char *track
) {
1602 const char *actual
= trackdb_resolve(track
);
1604 return strcmp(actual
, track
);
1607 /* test whether a track exists (perhaps an alias) */
1608 int trackdb_exists(const char *track
) {
1613 tid
= trackdb_begin_transaction();
1614 /* unusually, here we want the return value */
1615 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1619 trackdb_abort_transaction(tid
);
1621 trackdb_commit_transaction(tid
);
1625 /* return the list of tags */
1626 char **trackdb_alltags(void) {
1631 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1635 /** @brief List all the keys in @p db
1636 * @param db Database
1637 * @param v Vector to store keys in
1638 * @param tid Transaction ID
1639 * @return 0 or DB_LOCK_DEADLOCK
1641 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1644 DBC
*const c
= trackdb_opencursor(db
, tid
);
1647 memset(&k
, 0, sizeof k
);
1648 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1649 vector_append(v
, xstrndup(k
.data
, k
.size
));
1653 case DB_LOCK_DEADLOCK
:
1656 fatal(0, "c->c_get: %s", db_strerror(e
));
1658 if((e
= trackdb_closecursor(c
)))
1660 vector_terminate(v
);
1664 /* return 1 iff sorted tag lists A and B have at least one member in common */
1665 int tag_intersection(char **a
, char **b
) {
1668 /* Same sort of logic as trackdb_set() above */
1670 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1671 else if(cmp
< 0) ++a
;
1677 static pid_t choose_pid
= -1;
1678 static int choose_fd
;
1679 static random_callback
*choose_callback
;
1680 static struct dynstr choose_output
;
1681 static unsigned choose_complete
;
1682 static int choose_status
;
1683 #define CHOOSE_RUNNING 1
1684 #define CHOOSE_READING 2
1686 static void choose_finished(ev_source
*ev
, unsigned which
) {
1687 choose_complete
|= which
;
1688 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1691 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1692 dynstr_terminate(&choose_output
);
1693 choose_callback(ev
, xstrdup(choose_output
.vec
));
1695 choose_callback(ev
, 0);
1698 /** @brief Called when @c disorder-choose terminates */
1699 static int choose_exited(ev_source
*ev
,
1700 pid_t
attribute((unused
)) pid
,
1702 const struct rusage
attribute((unused
)) *rusage
,
1703 void attribute((unused
)) *u
) {
1705 error(0, "disorder-choose %s", wstat(status
));
1706 choose_status
= status
;
1707 choose_finished(ev
, CHOOSE_RUNNING
);
1711 /** @brief Called with data from @c disorder-choose pipe */
1712 static int choose_readable(ev_source
*ev
,
1717 void attribute((unused
)) *u
) {
1718 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1719 ev_reader_consume(reader
, bytes
);
1721 choose_finished(ev
, CHOOSE_READING
);
1725 static int choose_read_error(ev_source
*ev
,
1727 void attribute((unused
)) *u
) {
1728 error(errno_value
, "error reading disorder-choose pipe");
1729 choose_finished(ev
, CHOOSE_READING
);
1733 /** @brief Request a random track
1734 * @param ev Event source
1735 * @param callback Called with random track or NULL
1736 * @return 0 if a request was initiated, else -1
1738 * Initiates a random track choice. @p callback will later be called back with
1739 * the choice (or NULL on error). If a choice is already underway then -1 is
1740 * returned and there will be no additional callback.
1742 * The caller shouldn't assume that the track returned actually exists (it
1743 * might be removed between the choice and the callback, or between being added
1744 * to the queue and being played).
1746 int trackdb_request_random(ev_source
*ev
,
1747 random_callback
*callback
) {
1750 if(choose_pid
!= -1)
1751 return -1; /* don't run concurrent chooses */
1754 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1757 choose_callback
= callback
;
1758 choose_output
.nvec
= 0;
1759 choose_complete
= 0;
1760 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1761 "disorder-choose reader"); /* owns p[0] */
1762 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1766 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1767 * from the prefs. */
1768 static const char *getpart(const char *track
,
1769 const char *context
,
1771 const struct kvp
*p
,
1776 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1777 if((result
= kvp_get(p
, pref
)))
1780 result
= trackname_part(track
, context
, part
);
1781 assert(result
!= 0);
1785 /* get a track name part, like trackname_part(), but taking the database into
1787 const char *trackdb_getpart(const char *track
,
1788 const char *context
,
1796 /* construct the full pref */
1797 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1799 tid
= trackdb_begin_transaction();
1800 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1804 trackdb_abort_transaction(tid
);
1806 trackdb_commit_transaction(tid
);
1807 return getpart(actual
, context
, part
, p
, &used_db
);
1810 /* get the raw path name for @track@ (might be an alias) */
1811 const char *trackdb_rawpath(const char *track
) {
1817 tid
= trackdb_begin_transaction();
1818 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1822 trackdb_abort_transaction(tid
);
1824 trackdb_commit_transaction(tid
);
1825 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1829 /* trackdb_list **************************************************************/
1831 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1832 * readable at some point */
1834 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1835 * If RE is a null pointer then it matches everything. */
1836 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1844 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1845 case PCRE_ERROR_NOMATCH
: return 0;
1848 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1855 static int do_list(struct vector
*v
, const char *dir
,
1856 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1862 size_t l
, last_dir_len
= 0;
1863 char *last_dir
= 0, *track
;
1867 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1870 /* find the first key >= dir */
1871 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1872 /* keep going while we're dealing with <dir/anything> */
1875 && ((char *)k
.data
)[dl
] == '/'
1876 && !memcmp(k
.data
, dir
, dl
)) {
1877 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1879 /* we have <dir/component/anything>, so <dir/component> is a directory */
1880 l
= ptr
- (char *)k
.data
;
1881 if(what
& trackdb_directories
)
1883 && l
== last_dir_len
1884 && !memcmp(last_dir
, k
.data
, l
))) {
1885 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1886 if(track_matches(dl
, k
.data
, l
, re
))
1887 vector_append(v
, last_dir
);
1890 /* found a plain file */
1891 if((what
& trackdb_files
)) {
1892 track
= xstrndup(k
.data
, k
.size
);
1893 if((err
= trackdb_getdata(trackdb_prefsdb
,
1894 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1896 /* There's an awkward question here...
1898 * If a track shares a directory with its alias then we could
1899 * do one of three things:
1900 * - report both. Looks ridiculuous in most UIs.
1901 * - report just the alias. Remarkably inconvenient to write
1903 * - report just the real name. Ugly if the UI doesn't prettify
1904 * names via the name parts.
1907 /* If this file is an alias for a track in the same directory then we
1909 struct kvp
*t
= kvp_urldecode(d
.data
, d
.size
);
1910 const char *alias_target
= kvp_get(t
, "_alias_for");
1912 && !strcmp(d_dirname(alias_target
),
1914 if(track_matches(dl
, k
.data
, k
.size
, re
))
1915 vector_append(v
, track
);
1917 /* if this file has an alias in the same directory then we skip it */
1919 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1921 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1922 if(track_matches(dl
, k
.data
, k
.size
, re
))
1923 vector_append(v
, track
);
1927 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1935 case DB_LOCK_DEADLOCK
:
1936 error(0, "error querying database: %s", db_strerror(err
));
1939 fatal(0, "error querying database: %s", db_strerror(err
));
1942 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1946 /* return the directories or files below @dir@ */
1947 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1955 tid
= trackdb_begin_transaction();
1958 if(do_list(&v
, dir
, what
, re
, tid
))
1961 for(n
= 0; n
< config
->collection
.n
; ++n
)
1962 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1967 trackdb_abort_transaction(tid
);
1969 trackdb_commit_transaction(tid
);
1970 vector_terminate(&v
);
1976 /* If S is tag:something, return something. Else return 0. */
1977 static const char *checktag(const char *s
) {
1978 if(!strncmp(s
, "tag:", 4))
1984 /* return a list of tracks containing all of the words given. If you
1985 * ask for only stopwords you get no tracks. */
1986 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1987 const char **w
, *best
= 0, *tag
;
1988 char **twords
, **tags
;
1990 int i
, j
, n
, err
, what
;
2000 *ntracks
= 0; /* for early returns */
2001 /* normalize all the words */
2002 w
= xmalloc(nwordlist
* sizeof (char *));
2003 istag
= xmalloc_noptr(nwordlist
);
2004 for(n
= 0; n
< nwordlist
; ++n
) {
2008 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
2009 if(checktag(w
[n
])) {
2010 ++ntags
; /* count up tags */
2011 /* Normalize the tag */
2012 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2015 /* Normalize the search term by removing combining characters */
2016 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2018 nw32
= remove_combining_chars(w32
, nw32
);
2019 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2024 /* find the longest non-stopword */
2025 for(n
= 0; n
< nwordlist
; ++n
)
2026 if(!istag
[n
] && !stopword(w
[n
]))
2027 if(!best
|| strlen(w
[n
]) > strlen(best
))
2029 /* TODO: we should at least in principal be able to identify the word or tag
2030 * with the least matches in log time, and choose that as our primary search
2032 if(ntags
&& !best
) {
2033 /* Only tags are listed. We limit to the first and narrow down with the
2035 best
= istag
[0] ? w
[0] : 0;
2036 db
= trackdb_tagsdb
;
2039 /* We can limit to some word. */
2040 db
= trackdb_searchdb
;
2043 /* Only stopwords */
2049 tid
= trackdb_begin_transaction();
2050 /* find all the tracks that have that word */
2055 cursor
= trackdb_opencursor(db
, tid
);
2056 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2057 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2064 case DB_LOCK_DEADLOCK
:
2065 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2068 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2070 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2072 /* do a naive search over that (hopefuly fairly small) list of tracks */
2074 for(n
= 0; n
< v
.nvec
; ++n
) {
2075 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2078 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2081 twords
= track_to_words(v
.vec
[n
], p
);
2082 tags
= parsetags(kvp_get(p
, "tags"));
2083 for(i
= 0; i
< nwordlist
; ++i
) {
2086 /* Track must have this tag */
2087 for(j
= 0; tags
[j
]; ++j
)
2088 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2089 if(!tags
[j
]) break; /* tag not found */
2091 /* Track must contain this word */
2092 for(j
= 0; twords
[j
]; ++j
)
2093 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2094 if(!twords
[j
]) break; /* word not found */
2097 if(i
>= nwordlist
) /* all words found */
2098 vector_append(&u
, v
.vec
[n
]);
2102 trackdb_closecursor(cursor
);
2104 trackdb_abort_transaction(tid
);
2105 info("retrying search");
2107 trackdb_commit_transaction(tid
);
2108 vector_terminate(&u
);
2114 /* trackdb_scan **************************************************************/
2116 int trackdb_scan(const char *root
,
2117 int (*callback
)(const char *track
,
2126 const size_t root_len
= root ?
strlen(root
) : 0;
2128 struct kvp
*data
, *prefs
;
2131 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2133 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2136 memset(&k
, 0, sizeof k
);
2137 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2142 || (k
.size
> root_len
2143 && !strncmp(k
.data
, root
, root_len
)
2144 && ((char *)k
.data
)[root_len
] == '/')) {
2145 data
= kvp_urldecode(d
.data
, d
.size
);
2146 if(kvp_get(data
, "_path")) {
2147 track
= xstrndup(k
.data
, k
.size
);
2148 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2149 * do a lookup for every single track. In fact this is quite quick:
2150 * with around 10,000 tracks a complete scan is around 0.3s on my
2151 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2152 * linear walk as we already do over trackdb_tracksdb, and probably get
2153 * even higher performance. That would require upgrade logic to
2154 * translate old databases though.
2156 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2157 prepare_data(&pd
), 0)) {
2159 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2164 case DB_LOCK_DEADLOCK
:
2165 error(0, "getting prefs: %s", db_strerror(err
));
2166 trackdb_closecursor(cursor
);
2169 fatal(0, "getting prefs: %s", db_strerror(err
));
2171 /* Advance to the next track before the callback so that the callback
2172 * may safely delete the track */
2173 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2174 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2179 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2183 trackdb_closecursor(cursor
);
2190 case DB_LOCK_DEADLOCK
:
2191 error(0, "c->c_get: %s", db_strerror(err
));
2194 fatal(0, "c->c_get: %s", db_strerror(err
));
2198 /* trackdb_rescan ************************************************************/
2200 /** @brief Node in the list of rescan-complete callbacks */
2201 struct rescanned_node
{
2202 struct rescanned_node
*next
;
2203 void (*rescanned
)(void *ru
);
2207 /** @brief List of rescan-complete callbacks */
2208 static struct rescanned_node
*rescanned_list
;
2210 /** @brief Add a rescan completion callback */
2211 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2214 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2215 n
->next
= rescanned_list
;
2216 n
->rescanned
= rescanned
;
2222 /* called when the rescanner terminates */
2223 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2226 const struct rusage
attribute((unused
)) *rusage
,
2227 void attribute((unused
)) *u
) {
2228 if(pid
== rescan_pid
) rescan_pid
= -1;
2230 error(0, RESCAN
": %s", wstat(status
));
2232 D((RESCAN
" terminated: %s", wstat(status
)));
2233 /* Our cache of file lookups is out of date now */
2234 cache_clean(&cache_files_type
);
2235 eventlog("rescanned", (char *)0);
2236 /* Call rescanned callbacks */
2237 while(rescanned_list
) {
2238 void (*rescanned
)(void *u_
) = rescanned_list
->rescanned
;
2239 void *ru
= rescanned_list
->ru
;
2241 rescanned_list
= rescanned_list
->next
;
2247 /** @brief Initiate a rescan
2248 * @param ev Event loop or 0 to block
2249 * @param recheck 1 to recheck lengths, 0 to suppress check
2250 * @param rescanned Called on completion (if not NULL)
2251 * @param u Passed to @p rescanned
2253 void trackdb_rescan(ev_source
*ev
, int recheck
,
2254 void (*rescanned
)(void *ru
),
2258 if(rescan_pid
!= -1) {
2259 trackdb_add_rescanned(rescanned
, ru
);
2260 error(0, "rescan already underway");
2263 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2264 recheck ?
"--check" : "--no-check",
2266 trackdb_add_rescanned(rescanned
, ru
);
2268 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2269 D(("started rescanner"));
2271 /* This is the first rescan, we block until it is complete */
2272 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2274 reap_rescan(0, rescan_pid
, w
, 0, 0);
2278 int trackdb_rescan_cancel(void) {
2279 if(rescan_pid
== -1) return 0;
2280 if(kill(rescan_pid
, SIGTERM
) < 0)
2281 fatal(errno
, "error killing rescanner");
2286 /** @brief Return true if a rescan is underway */
2287 int trackdb_rescan_underway(void) {
2288 return rescan_pid
!= -1;
2291 /* global prefs **************************************************************/
2293 void trackdb_set_global(const char *name
,
2301 tid
= trackdb_begin_transaction();
2302 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2304 trackdb_abort_transaction(tid
);
2306 trackdb_commit_transaction(tid
);
2307 /* log important state changes */
2308 if(!strcmp(name
, "playing")) {
2309 state
= !value
|| !strcmp(value
, "yes");
2310 info("playing %s by %s",
2311 state ?
"enabled" : "disabled",
2313 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2315 if(!strcmp(name
, "random-play")) {
2316 state
= !value
|| !strcmp(value
, "yes");
2317 info("random play %s by %s",
2318 state ?
"enabled" : "disabled",
2320 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2324 int trackdb_set_global_tid(const char *name
,
2330 memset(&k
, 0, sizeof k
);
2331 memset(&d
, 0, sizeof d
);
2332 k
.data
= (void *)name
;
2333 k
.size
= strlen(name
);
2335 d
.data
= (void *)value
;
2336 d
.size
= strlen(value
);
2339 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2341 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2342 if(err
== DB_LOCK_DEADLOCK
) return err
;
2344 fatal(0, "error updating database: %s", db_strerror(err
));
2348 const char *trackdb_get_global(const char *name
) {
2354 tid
= trackdb_begin_transaction();
2355 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2357 trackdb_abort_transaction(tid
);
2359 trackdb_commit_transaction(tid
);
2363 int trackdb_get_global_tid(const char *name
,
2369 memset(&k
, 0, sizeof k
);
2370 k
.data
= (void *)name
;
2371 k
.size
= strlen(name
);
2372 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2373 prepare_data(&d
), 0)) {
2375 *rp
= xstrndup(d
.data
, d
.size
);
2380 case DB_LOCK_DEADLOCK
:
2383 fatal(0, "error reading database: %s", db_strerror(err
));
2387 /** @brief Retrieve the most recently added tracks
2388 * @param ntracksp Where to put count, or 0
2389 * @param maxtracks Maximum number of tracks to retrieve
2390 * @return null-terminated array of track names
2392 * The most recently added track is first in the array.
2394 char **trackdb_new(int *ntracksp
,
2400 tid
= trackdb_begin_transaction();
2401 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2404 trackdb_abort_transaction(tid
);
2406 trackdb_commit_transaction(tid
);
2410 /** @brief Retrieve the most recently added tracks
2411 * @param ntracksp Where to put count, or 0
2412 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2413 * @param tid Transaction ID
2414 * @return null-terminated array of track names, or NULL on deadlock
2416 * The most recently added track is first in the array.
2418 static char **trackdb_new_tid(int *ntracksp
,
2424 struct vector tracks
[1];
2425 hash
*h
= hash_new(1);
2427 vector_init(tracks
);
2428 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2429 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2430 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
))) {
2431 char *const track
= xstrndup(d
.data
, d
.size
);
2432 /* Don't add any track more than once */
2433 if(hash_add(h
, track
, "", HASH_INSERT
))
2435 /* See if the track still exists */
2436 err
= trackdb_getdata(trackdb_tracksdb
, track
, NULL
/*kp*/, tid
);
2437 if(err
== DB_NOTFOUND
)
2438 continue; /* It doesn't, skip it */
2439 if(err
== DB_LOCK_DEADLOCK
)
2441 vector_append(tracks
, track
);
2444 case 0: /* hit maxtracks */
2445 case DB_NOTFOUND
: /* ran out of tracks */
2447 case DB_LOCK_DEADLOCK
:
2448 trackdb_closecursor(c
);
2451 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2453 if((err
= trackdb_closecursor(c
)))
2454 return 0; /* deadlock */
2455 vector_terminate(tracks
);
2457 *ntracksp
= tracks
->nvec
;
2461 /** @brief Expire noticed.db
2462 * @param earliest Earliest timestamp to keep
2464 void trackdb_expire_noticed(time_t earliest
) {
2468 tid
= trackdb_begin_transaction();
2469 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2471 trackdb_abort_transaction(tid
);
2473 trackdb_commit_transaction(tid
);
2476 /** @brief Expire noticed.db
2477 * @param earliest Earliest timestamp to keep
2478 * @param tid Transaction ID
2479 * @return 0 or DB_LOCK_DEADLOCK
2481 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2489 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2490 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2492 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2493 if(when
>= earliest
)
2495 if((err
= c
->c_del(c
, 0))) {
2496 if(err
!= DB_LOCK_DEADLOCK
)
2497 fatal(0, "error deleting expired noticed.db entry: %s",
2503 if(err
== DB_NOTFOUND
)
2505 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2506 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2508 if((err
= trackdb_closecursor(c
))) {
2509 if(err
!= DB_LOCK_DEADLOCK
)
2510 fatal(0, "error closing cursor: %s", db_strerror(err
));
2514 info("expired %d tracks from noticed.db", count
);
2518 /* tidying up ****************************************************************/
2520 void trackdb_gc(void) {
2524 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2525 config
->checkpoint_kbyte
,
2526 config
->checkpoint_min
,
2528 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2529 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2530 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2531 /* This makes catastrophic recovery impossible. However, the user can still
2532 * preserve the important data by using disorder-dump to snapshot their
2533 * prefs, and later to restore it. This is likely to have much small
2534 * long-term storage requirements than record the db logfiles. */
2537 /* user database *************************************************************/
2539 /** @brief Return true if @p user is trusted */
2540 static int trusted(const char *user
) {
2543 for(n
= 0; (n
< config
->trust
.n
2544 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2546 return n
< config
->trust
.n
;
2549 /** @brief Return non-zero for a valid username
2551 * Currently we only allow the letters and digits in ASCII. We could be more
2552 * liberal than this but it is a nice simple test. It is critical that
2553 * semicolons are never allowed.
2555 static int valid_username(const char *user
) {
2559 const uint8_t c
= *user
++;
2560 /* For now we are very strict */
2561 if((c
>= 'a' && c
<= 'z')
2562 || (c
>= 'A' && c
<= 'Z')
2563 || (c
>= '0' && c
<= '9'))
2571 /** @brief Add a user */
2572 static int create_user(const char *user
,
2573 const char *password
,
2576 const char *confirmation
,
2582 /* sanity check user */
2583 if(!valid_username(user
)) {
2584 error(0, "invalid username '%s'", user
);
2587 if(parse_rights(rights
, 0, 1)) {
2588 error(0, "invalid rights string");
2591 /* data for this user */
2593 kvp_set(&k
, "password", password
);
2594 kvp_set(&k
, "rights", rights
);
2596 kvp_set(&k
, "email", email
);
2598 kvp_set(&k
, "confirmation", confirmation
);
2599 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2600 kvp_set(&k
, "created", s
);
2601 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2604 /** @brief Add one pre-existing user */
2605 static int one_old_user(const char *user
, const char *password
,
2609 /* www-data doesn't get added */
2610 if(!strcmp(user
, "www-data")) {
2611 info("not adding www-data to user database");
2615 if(!strcmp(user
, "root"))
2617 else if(trusted(user
)) {
2620 parse_rights(config
->default_rights
, &r
, 1);
2621 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2622 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2623 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2624 rights
= rights_string(r
);
2626 rights
= config
->default_rights
;
2627 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2628 tid
, DB_NOOVERWRITE
);
2631 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2634 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2635 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2638 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2641 error(0, "user %s already exists, delete 'allow' directive",
2642 config
->allow
.s
[n
].s
[0]);
2643 /* This won't ever become fatal - eventually 'allow' will be
2646 case DB_LOCK_DEADLOCK
:
2647 return DB_LOCK_DEADLOCK
;
2653 /** @brief Read old 'allow' directives and copy them to the users database */
2654 void trackdb_old_users(void) {
2658 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2661 /** @brief Create a root user in the user database if there is none */
2662 void trackdb_create_root(void) {
2667 /* Choose a new root password */
2668 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2669 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2670 /* Create the root user if it does not exist */
2671 WITH_TRANSACTION(create_user("root", pw
, "all",
2672 0/*email*/, 0/*confirmation*/,
2673 tid
, DB_NOOVERWRITE
));
2675 info("created root user");
2678 /** @brief Find a user's password from the database
2679 * @param user Username
2680 * @return Password or NULL
2682 * Only works if running as a user that can read the database!
2684 * If the user exists but has no password, "" is returned.
2686 const char *trackdb_get_password(const char *user
) {
2689 const char *password
;
2691 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2694 password
= kvp_get(k
, "password");
2695 return password ? password
: "";
2698 /** @brief Add a new user
2699 * @param user Username
2700 * @param password Password or NULL
2701 * @param rights Initial rights
2702 * @param email Email address or NULL
2703 * @param confirmation Confirmation string or NULL
2704 * @return 0 on success, non-0 on error
2706 int trackdb_adduser(const char *user
,
2707 const char *password
,
2710 const char *confirmation
) {
2713 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2714 tid
, DB_NOOVERWRITE
));
2716 error(0, "cannot create user '%s' because they already exist", user
);
2720 info("created user '%s' with rights '%s' and email address '%s'",
2721 user
, rights
, email
);
2723 info("created user '%s' with rights '%s'", user
, rights
);
2724 eventlog("user_add", user
, (char *)0);
2729 /** @brief Delete a user
2730 * @param user User to delete
2731 * @return 0 on success, non-0 if the user didn't exist anyway
2733 int trackdb_deluser(const char *user
) {
2736 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2738 error(0, "cannot delete user '%s' because they do not exist", user
);
2741 info("deleted user '%s'", user
);
2742 eventlog("user_delete", user
, (char *)0);
2746 /** @brief Get user information
2747 * @param user User to query
2748 * @return Linked list of user information or NULL if user does not exist
2750 * Every user has at least a @c rights entry so NULL can be used to mean no
2753 struct kvp
*trackdb_getuserinfo(const char *user
) {
2757 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2764 /** @brief Edit user information
2765 * @param user User to edit
2766 * @param key Key to change
2767 * @param value Value to set, or NULL to remove
2768 * @param tid Transaction ID
2769 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2771 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2772 const char *value
, DB_TXN
*tid
) {
2776 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2778 if(!kvp_set(&k
, key
, value
))
2779 return 0; /* no change */
2780 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2783 /** @brief Edit user information
2784 * @param user User to edit
2785 * @param key Key to change
2786 * @param value Value to set, or NULL to remove
2787 * @return 0 on success, non-0 on error
2789 int trackdb_edituserinfo(const char *user
,
2790 const char *key
, const char *value
) {
2793 if(!strcmp(key
, "rights")) {
2795 error(0, "cannot remove 'rights' key from user '%s'", user
);
2798 if(parse_rights(value
, 0, 1)) {
2799 error(0, "invalid rights string");
2802 } else if(!strcmp(key
, "email")) {
2804 if(!email_valid(value
)) {
2805 error(0, "invalid email address '%s' for user '%s'", value
, user
);
2809 value
= 0; /* no email -> remove key */
2810 } else if(!strcmp(key
, "created")) {
2811 error(0, "cannot change creation date for user '%s'", user
);
2813 } else if(strcmp(key
, "password")
2814 && !strcmp(key
, "confirmation")) {
2815 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2818 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2820 error(0, "unknown user '%s'", user
);
2823 eventlog("user_edit", user
, key
, (char *)0);
2828 /** @brief List all users
2829 * @return NULL-terminated list of users
2831 char **trackdb_listusers(void) {
2836 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2840 /** @brief Confirm a user registration
2841 * @param user Username
2842 * @param confirmation Confirmation string
2843 * @param rightsp Where to put user rights
2844 * @param tid Transaction ID
2845 * @return 0 on success, non-0 on error
2847 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2848 rights_type
*rightsp
,
2850 const char *stored_confirmation
;
2855 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2857 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2858 error(0, "already confirmed user '%s'", user
);
2859 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2862 if(!(rights
= kvp_get(k
, "rights"))) {
2863 error(0, "no rights for unconfirmed user '%s'", user
);
2866 if(parse_rights(rights
, rightsp
, 1))
2868 if(strcmp(confirmation
, stored_confirmation
)) {
2869 error(0, "wrong confirmation string for user '%s'", user
);
2873 kvp_set(&k
, "confirmation", 0);
2874 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2877 /** @brief Confirm a user registration
2878 * @param user Username
2879 * @param confirmation Confirmation string
2880 * @param rightsp Where to put user rights
2881 * @return 0 on success, non-0 on error
2883 int trackdb_confirm(const char *user
, const char *confirmation
,
2884 rights_type
*rightsp
) {
2887 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2890 info("registration confirmed for user '%s'", user
);
2891 eventlog("user_confirm", user
, (char *)0);
2894 error(0, "confirmation for nonexistent user '%s'", user
);
2896 default: /* already reported */
2906 indent-tabs-mode:nil