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 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU 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, see <http://www.gnu.org/licenses/>.
18 /** @file lib/trackdb.c
19 * @brief Track database
21 * This file is getting in desparate need of splitting up...
27 #include <sys/socket.h>
33 #include <sys/resource.h>
35 #include <arpa/inet.h>
47 #include "configuration.h"
52 #include "trackname.h"
53 #include "trackdb-int.h"
63 #define RESCAN "disorder-rescan"
64 #define DEADLOCK "disorder-deadlock"
66 static const char *getpart(const char *track
,
71 static char **trackdb_new_tid(int *ntracksp
,
74 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
75 static char *normalize_tag(const char *s
, size_t ns
);
77 const struct cache_type cache_files_type
= { 86400 };
78 unsigned long cache_files_hits
, cache_files_misses
;
80 /** @brief Set by trackdb_open() */
81 int trackdb_existing_database
;
83 /* setup and teardown ********************************************************/
85 static const char *home
; /* home had better not change */
86 DB_ENV
*trackdb_env
; /* db environment */
88 /** @brief The tracks database
89 * - Keys are UTF-8(NFC(unicode(path name)))
90 * - Values are encoded key-value pairs
91 * - Data is reconstructable data about tracks that currently exist
95 /** @brief The preferences database
97 * - Keys are UTF-8(NFC(unicode(path name)))
98 * - Values are encoded key-value pairs
99 * - Data is user data about tracks (that might not exist any more)
100 * and cannot be reconstructed
104 /** @brief The search database
106 * - Keys are UTF-8(NFKC(casefold(search term)))
107 * - Values are UTF-8(NFC(unicode(path name)))
108 * - There can be more than one value per key
109 * - Presence of key,value means that path matches the search terms
110 * - Only tracks fond in @ref trackdb_tracksdb are represented here
111 * - This database can be reconstructed, it contains no user data
113 DB
*trackdb_searchdb
;
115 /** @brief The tags database
117 * - Keys are UTF-8(NFKC(casefold(tag)))
118 * - Values are UTF-8(NFC(unicode(path name)))
119 * - There can be more than one value per key
120 * - Presence of key,value means that path matches the tag
121 * - This is always in sync with the tags preference
122 * - This database can be reconstructed, it contains no user data
124 DB
*trackdb_tagsdb
; /* the tags database */
126 /** @brief The global preferences database
127 * - Keys are UTF-8(NFC(preference))
128 * - Values are global preference values
129 * - Data is user data and cannot be reconstructed
131 DB
*trackdb_globaldb
; /* global preferences */
133 /** @brief The noticed database
134 * - Keys are 64-bit big-endian timestamps
135 * - Values are UTF-8(NFC(unicode(path name)))
136 * - There can be more than one value per key
137 * - Presence of key,value means that path was added at the given time
138 * - Data cannot be reconstructed (but isn't THAT important)
140 DB
*trackdb_noticeddb
; /* when track noticed */
142 /** @brief The schedule database
144 * - Keys are ID strings, generated at random
145 * - Values are encoded key-value pairs
146 * - There can be more than one value per key
147 * - Data cannot be reconstructed
149 * See @ref server/schedule.c for further information.
151 DB
*trackdb_scheduledb
;
153 /** @brief The user database
154 * - Keys are usernames
155 * - Values are encoded key-value pairs
156 * - Data is user data and cannot be reconstructed
160 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
161 static pid_t rescan_pid
= -1; /* rescanner PID */
162 static int initialized
, opened
; /* state */
164 /* comparison function for keys */
165 static int compare(DB
attribute((unused
)) *db_
,
166 const DBT
*a
, const DBT
*b
) {
167 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
170 /** @brief Test whether the track database can be read
171 * @return 1 if it can, 0 if it cannot
173 int trackdb_readable(void) {
176 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
177 return access(usersdb
, R_OK
) == 0;
180 /** @brief Open database environment
181 * @param flags Flags word
183 * Flags should be one of:
184 * - @ref TRACKDB_NO_RECOVER
185 * - @ref TRACKDB_NORMAL_RECOVER
186 * - @ref TRACKDB_FATAL_RECOVER
187 * - @ref TRACKDB_MAY_CREATE
189 void trackdb_init(int flags
) {
191 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
192 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
195 assert(initialized
== 0);
198 if(strcmp(home
, config
->home
))
199 fatal(0, "cannot change db home without server restart");
203 if(flags
& TRACKDB_MAY_CREATE
) {
209 /* Remove world/group permissions on any regular files already in the
210 * database directory. Actually we don't care about all of them but it's
211 * easier to just do the lot. This can be revisited if it's a serious
212 * practical inconvenience for anyone.
214 * The socket, not being a regular file, is excepted.
216 if(!(dp
= opendir(config
->home
)))
217 fatal(errno
, "error reading %s", config
->home
);
218 while((de
= readdir(dp
))) {
219 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
220 if(lstat(p
, &st
) == 0
221 && S_ISREG(st
.st_mode
)
222 && (st
.st_mode
& 077)) {
223 if(chmod(p
, st
.st_mode
& 07700) < 0)
224 fatal(errno
, "cannot chmod %s", p
);
231 /* create environment */
232 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
234 if((err
= trackdb_env
->set_alloc(trackdb_env
,
235 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
236 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
237 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
238 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
239 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
240 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
241 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
247 |recover_type
[recover
],
249 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
250 trackdb_env
->set_errpfx(trackdb_env
, "DB");
251 trackdb_env
->set_errfile(trackdb_env
, stderr
);
252 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
253 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
254 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
255 D(("initialized database environment"));
258 /* called when deadlock manager terminates */
259 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
260 pid_t
attribute((unused
)) pid
,
262 const struct rusage
attribute((unused
)) *rusage
,
263 void attribute((unused
)) *u
) {
264 db_deadlock_pid
= -1;
266 fatal(0, "deadlock manager unexpectedly terminated: %s",
269 D(("deadlock manager terminated: %s", wstat(status
)));
273 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
277 const char *args
[1024], **argp
, *a
;
281 *argp
++ = "--config";
282 *argp
++ = configfile
;
283 *argp
++ = debugging ?
"--debug" : "--no-debug";
284 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
286 while((a
= va_arg(ap
, const char *)))
290 /* If we're in the background then trap subprocess stdout/stderr */
291 if(!(pid
= xfork())) {
294 ev_signal_atfork(ev
);
295 signal(SIGPIPE
, SIG_DFL
);
300 /* ensure we don't leak privilege anywhere */
301 if(setuid(geteuid()) < 0)
302 fatal(errno
, "error calling setuid");
303 /* If we were negatively niced, undo it. We don't bother checking for
304 * error, it's not that important. */
305 setpriority(PRIO_PROCESS
, 0, 0);
306 execvp(prog
, (char **)args
);
307 fatal(errno
, "error invoking %s", prog
);
312 /* start deadlock manager */
313 void trackdb_master(ev_source
*ev
) {
314 assert(db_deadlock_pid
== -1);
315 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
316 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
317 D(("started deadlock manager"));
320 /* close environment */
321 void trackdb_deinit(void) {
325 assert(initialized
== 1);
328 /* close the environment */
329 if((err
= trackdb_env
->close(trackdb_env
, 0)))
330 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
332 if(rescan_pid
!= -1) {
333 /* shut down the rescanner */
334 if(kill(rescan_pid
, SIGTERM
) < 0)
335 fatal(errno
, "error killing rescanner");
336 /* wait for the rescanner to finish */
337 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
341 /* TODO kill any stats subprocesses */
343 /* finally terminate the deadlock manager */
344 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
345 fatal(errno
, "error killing deadlock manager");
346 db_deadlock_pid
= -1;
348 D(("deinitialized database environment"));
351 /* open a specific database */
352 static DB
*open_db(const char *path
,
360 D(("open %s", path
));
361 path
= config_get_file(path
);
362 if((err
= db_create(&db
, trackdb_env
, 0)))
363 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
365 if((err
= db
->set_flags(db
, dbflags
)))
366 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
367 if(dbtype
== DB_BTREE
)
368 if((err
= db
->set_bt_compare(db
, compare
)))
369 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
370 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
371 openflags
| DB_AUTO_COMMIT
, mode
))) {
372 if((openflags
& DB_CREATE
) || errno
!= ENOENT
) {
373 if((err2
= db
->close(db
, 0)))
374 error(0, "db->close: %s", db_strerror(err2
));
376 trackdb_env
->close(trackdb_env
,0);
378 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
386 /** @brief Open track databases
387 * @param flags Flags flags word
389 * @p flags should have one of:
390 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
391 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
392 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
394 * - @p TRACKDB_READ_ONLY, read only access
396 void trackdb_open(int flags
) {
399 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
404 /* check the database version first */
405 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
406 if(trackdb_globaldb
) {
407 /* This is an existing database */
411 s
= trackdb_get_global("_dbversion");
412 /* Close the database again, we'll open it property below */
413 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
414 fatal(0, "error closing global.db: %s", db_strerror(err
));
415 trackdb_globaldb
= 0;
416 /* Convert version string to an integer */
417 oldversion
= s ?
atol(s
) : 1;
418 if(oldversion
> config
->dbversion
) {
419 /* Database is from the future; we never allow this. */
420 fatal(0, "this version of DisOrder is too old for database version %ld",
423 if(oldversion
< config
->dbversion
) {
424 /* Database version is out of date */
425 switch(flags
& TRACKDB_UPGRADE_MASK
) {
426 case TRACKDB_NO_UPGRADE
:
427 /* This database needs upgrading but this is not permitted */
428 fatal(0, "database needs upgrading from %ld to %ld",
429 oldversion
, config
->dbversion
);
430 case TRACKDB_CAN_UPGRADE
:
431 /* This database needs upgrading */
432 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
433 oldversion
, config
->dbversion
);
434 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
435 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
438 fatal(0, "disorder-dbupgrade %s", wstat(err
));
439 info("disorder-dbupgrade succeeded");
441 case TRACKDB_OPEN_FOR_UPGRADE
:
447 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
448 /* This doesn't make any sense */
449 fatal(0, "database is already at current version");
451 trackdb_existing_database
= 1;
453 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
454 /* Cannot upgrade a new database */
455 fatal(0, "cannot upgrade a database that does not exist");
457 /* This is a brand new database */
458 trackdb_existing_database
= 0;
460 /* open the databases */
461 if(!(trackdb_usersdb
= open_db("users.db",
462 0, DB_HASH
, dbflags
, 0600)))
463 fatal(0, "cannot open users.db");
464 trackdb_tracksdb
= open_db("tracks.db",
465 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
466 trackdb_searchdb
= open_db("search.db",
467 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
468 trackdb_tagsdb
= open_db("tags.db",
469 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
470 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
471 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
472 trackdb_noticeddb
= open_db("noticed.db",
473 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
474 trackdb_scheduledb
= open_db("schedule.db", 0, DB_HASH
, dbflags
, 0666);
475 if(!trackdb_existing_database
) {
476 /* Stash the database version */
479 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
480 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
481 trackdb_set_global("_dbversion", buf
, 0);
483 D(("opened databases"));
486 /* close track databases */
487 void trackdb_close(void) {
493 #define CLOSE(N, V) do { \
494 if(V && (err = V->close(V, 0))) \
495 fatal(0, "error closing %s: %s", N, db_strerror(err)); \
498 CLOSE("tracks.db", trackdb_tracksdb
);
499 CLOSE("search.db", trackdb_searchdb
);
500 CLOSE("tags.db", trackdb_tagsdb
);
501 CLOSE("prefs.db", trackdb_prefsdb
);
502 CLOSE("global.db", trackdb_globaldb
);
503 CLOSE("noticed.db", trackdb_noticeddb
);
504 CLOSE("schedule.db", trackdb_scheduledb
);
505 CLOSE("users.db", trackdb_usersdb
);
506 D(("closed databases"));
509 /* generic db routines *******************************************************/
511 /** @brief Fetch and decode a database entry
513 * @param track Track name
514 * @param kp Where to put decoded list (or NULL if you don't care)
515 * @param tid Owning transaction
516 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
518 int trackdb_getdata(DB
*db
,
525 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
526 prepare_data(&data
), 0)) {
529 *kp
= kvp_urldecode(data
.data
, data
.size
);
535 case DB_LOCK_DEADLOCK
:
536 error(0, "error querying database: %s", db_strerror(err
));
539 fatal(0, "error querying database: %s", db_strerror(err
));
543 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
544 * DB_LOCK_DEADLOCK. */
545 int trackdb_putdata(DB
*db
,
553 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
554 encode_data(&data
, k
), flags
)) {
558 case DB_LOCK_DEADLOCK
:
559 error(0, "error updating database: %s", db_strerror(err
));
562 fatal(0, "error updating database: %s", db_strerror(err
));
566 /** @brief Delete a database entry
568 * @param track Key to delete
569 * @param tid Transaction ID
570 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
572 int trackdb_delkey(DB
*db
,
578 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
582 case DB_LOCK_DEADLOCK
:
583 error(0, "error updating database: %s", db_strerror(err
));
586 fatal(0, "error updating database: %s", db_strerror(err
));
590 /* open a database cursor */
591 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
595 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
597 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
602 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
603 int trackdb_closecursor(DBC
*c
) {
607 switch(err
= c
->c_close(c
)) {
610 case DB_LOCK_DEADLOCK
:
611 error(0, "error closing cursor: %s", db_strerror(err
));
614 fatal(0, "error closing cursor: %s", db_strerror(err
));
618 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
619 int trackdb_delkeydata(DB
*db
,
627 c
= trackdb_opencursor(db
, tid
);
628 switch(err
= c
->c_get(c
, make_key(&key
, word
),
629 make_key(&data
, track
), DB_GET_BOTH
)) {
631 switch(err
= c
->c_del(c
, 0)) {
637 case DB_LOCK_DEADLOCK
:
638 error(0, "error updating database: %s", db_strerror(err
));
641 fatal(0, "c->c_del: %s", db_strerror(err
));
646 case DB_LOCK_DEADLOCK
:
647 error(0, "error updating database: %s", db_strerror(err
));
650 fatal(0, "c->c_get: %s", db_strerror(err
));
652 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
656 /* start a transaction */
657 DB_TXN
*trackdb_begin_transaction(void) {
661 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
662 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
666 /* abort transaction */
667 void trackdb_abort_transaction(DB_TXN
*tid
) {
671 if((err
= tid
->abort(tid
)))
672 fatal(0, "tid->abort: %s", db_strerror(err
));
675 /* commit transaction */
676 void trackdb_commit_transaction(DB_TXN
*tid
) {
679 if((err
= tid
->commit(tid
, 0)))
680 fatal(0, "tid->commit: %s", db_strerror(err
));
683 /* search/tags shared code ***************************************************/
685 /* comparison function used by dedupe() */
686 static int wordcmp(const void *a
, const void *b
) {
687 return strcmp(*(const char **)a
, *(const char **)b
);
690 /* sort and de-dupe VEC */
691 static char **dedupe(char **vec
, int nvec
) {
694 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
698 for(n
= 1; n
< nvec
; ++n
)
699 if(strcmp(vec
[n
], vec
[m
- 1]))
706 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
707 static int register_word(DB
*db
, const char *what
,
708 const char *track
, const char *word
,
713 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
714 make_key(&data
, track
), DB_NODUPDATA
)) {
718 case DB_LOCK_DEADLOCK
:
719 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
722 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
726 /* search primitives *********************************************************/
728 /* return true iff NAME is a trackname_display_ pref */
729 static int is_display_pref(const char *name
) {
730 static const char prefix
[] = "trackname_display_";
731 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
734 /** @brief Word_Break property tailor that treats underscores as spaces */
735 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
739 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
740 return unicode_Word_Break_Other
;
744 /** @brief Remove all combining characters in-place
745 * @param s Pointer to start of string
746 * @param ns Length of string
747 * @return New, possiblby reduced, length
749 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
750 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
753 const uint32_t c
= *s
++;
754 if(!utf32_combining_class(c
))
760 /** @brief Normalize and split a string using a given tailoring */
761 static void word_split(struct vector
*v
,
763 unicode_property_tailor
*pt
) {
765 uint32_t *t32
, **w32
;
767 /* Convert to UTF-32 */
768 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
770 /* Erase case distinctions */
771 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
773 /* Drop combining characters */
774 nt32
= remove_combining_chars(t32
, nt32
);
775 /* Split into words, treating _ as a space */
776 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
777 /* Convert words back to UTF-8 and append to result */
778 for(i
= 0; i
< nw
; ++i
)
779 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
782 /** @brief Normalize a tag
784 * @param ns Length of tag
785 * @return Normalized string or NULL on error
787 * The return value will be:
789 * - have no leading or trailing space
790 * - have no combining characters
791 * - all spacing between words will be a single U+0020 SPACE
793 static char *normalize_tag(const char *s
, size_t ns
) {
794 uint32_t *s32
, **w32
;
795 size_t ns32
, nw32
, i
;
798 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
800 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
802 ns32
= remove_combining_chars(s32
, ns32
);
803 /* Split into words, no Word_Break tailoring */
804 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
805 /* Compose back into a string */
807 for(i
= 0; i
< nw32
; ++i
) {
809 dynstr_append(d
, ' ');
810 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
816 /* compute the words of a track name */
817 static char **track_to_words(const char *track
,
818 const struct kvp
*p
) {
820 const char *rootless
= track_rootless(track
);
823 rootless
= track
; /* bodge */
825 rootless
= strip_extension(rootless
);
826 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
827 for(; p
; p
= p
->next
)
828 if(is_display_pref(p
->name
))
829 word_split(&v
, p
->value
, 0);
830 vector_terminate(&v
);
831 return dedupe(v
.vec
, v
.nvec
);
834 /* return nonzero iff WORD is a stopword */
835 static int stopword(const char *word
) {
838 for(n
= 0; n
< config
->stopword
.n
839 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
841 return n
< config
->stopword
.n
;
844 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
845 static int register_search_word(const char *track
, const char *word
,
847 if(stopword(word
)) return 0;
848 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
851 /* Tags **********************************************************************/
853 /* Return nonzero if C is a valid tag character */
854 static int tagchar(int c
) {
863 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
864 char **parsetags(const char *s
) {
870 /* skip initial separators */
871 while(*s
&& (!tagchar(*s
) || *s
== ' '))
874 /* find the extent of the tag */
876 while(*s
&& tagchar(*s
))
878 /* strip trailing spaces */
879 while(s
> t
&& s
[-1] == ' ')
881 /* add tag to list */
882 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
883 /* skip intermediate and trailing separators */
884 while(*s
&& (!tagchar(*s
) || *s
== ' '))
888 vector_terminate(&v
);
889 return dedupe(v
.vec
, v
.nvec
);
892 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
893 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
894 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
897 /* aliases *******************************************************************/
899 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
900 * there is no alias sets *aliasp to 0. */
901 static int compute_alias(char **aliasp
,
906 const char *s
= config
->alias
, *t
, *expansion
, *part
;
907 int c
, used_db
= 0, slash_prefix
, err
;
909 const char *const root
= find_track_root(track
);
912 /* Bodge for tracks with no root */
917 dynstr_append_string(&d
, root
);
918 while((c
= (unsigned char)*s
++)) {
920 dynstr_append(&d
, c
);
923 if((slash_prefix
= (*s
== '/')))
926 assert(t
!= 0); /* validated at startup */
927 part
= xstrndup(s
, t
- s
);
928 expansion
= getpart(track
, "display", part
, p
, &used_db
);
930 if(slash_prefix
) dynstr_append(&d
, '/');
931 dynstr_append_string(&d
, expansion
);
933 s
= t
+ 1; /* skip {part} */
935 /* only admit to the alias if we used the db... */
940 dynstr_terminate(&d
);
941 /* ...and the answer differs from the original... */
942 if(!strcmp(track
, d
.vec
)) {
946 /* ...and there isn't already a different track with that name (including as
948 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
950 if((s
= kvp_get(at
, "_alias_for"))
951 && !strcmp(s
, track
)) {
963 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
964 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
965 * Always sets the return values, even if only to null pointers. */
966 static int gettrackdata(const char *track
,
969 const char **actualp
,
971 #define GTD_NOALIAS 0x0001
974 const char *actual
= track
;
975 struct kvp
*t
= 0, *p
= 0;
977 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
978 if((actual
= kvp_get(t
, "_alias_for"))) {
979 if(flags
& GTD_NOALIAS
) {
980 error(0, "alias passed to gettrackdata where real path required");
983 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
988 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
993 if(actualp
) *actualp
= actual
;
999 /* trackdb_notice() **********************************************************/
1001 /** @brief notice a possibly new track
1002 * @return @c DB_NOTFOUND if new, 0 if already known
1004 int trackdb_notice(const char *track
,
1010 tid
= trackdb_begin_transaction();
1011 err
= trackdb_notice_tid(track
, path
, tid
);
1012 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1015 trackdb_abort_transaction(tid
);
1017 trackdb_commit_transaction(tid
);
1021 /** @brief notice a possibly new track
1022 * @param track NFC UTF-8 track name
1023 * @param path Raw path name
1024 * @param tid Transaction ID
1025 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1027 int trackdb_notice_tid(const char *track
,
1031 struct kvp
*t
, *a
, *p
;
1033 char *alias
, **w
, *noticed
;
1036 /* notice whether the tracks.db entry changes */
1038 /* get any existing tracks entry */
1039 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1041 ret
= err
; /* 0 or DB_NOTFOUND */
1042 /* this is a real track */
1043 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1044 t_changed
+= kvp_set(&t
, "_path", path
);
1046 if(ret
== DB_NOTFOUND
) {
1047 /* It's a new track; record the time */
1048 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1049 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1051 /* if we have an alias record it in the database */
1052 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1054 /* won't overwrite someone else's alias as compute_alias() checks */
1055 D(("%s: alias %s", track
, alias
));
1057 kvp_set(&a
, "_alias_for", track
);
1058 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1060 /* update search.db */
1061 w
= track_to_words(track
, p
);
1062 for(n
= 0; w
[n
]; ++n
)
1063 if((err
= register_search_word(track
, w
[n
], tid
)))
1065 /* update tags.db */
1066 w
= parsetags(kvp_get(p
, "tags"));
1067 for(n
= 0; w
[n
]; ++n
)
1068 if((err
= register_tag(track
, w
[n
], tid
)))
1070 /* only store the tracks.db entry if it has changed */
1071 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1073 if(ret
== DB_NOTFOUND
) {
1074 uint32_t timestamp
[2];
1077 timestamp
[0] = htonl((uint64_t)now
>> 32);
1078 timestamp
[1] = htonl((uint32_t)now
);
1079 memset(&key
, 0, sizeof key
);
1080 key
.data
= timestamp
;
1081 key
.size
= sizeof timestamp
;
1082 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1083 make_key(&data
, track
), 0)) {
1085 case DB_LOCK_DEADLOCK
: return err
;
1086 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1092 /* trackdb_obsolete() ********************************************************/
1094 /* obsolete a track */
1095 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1100 if((err
= gettrackdata(track
, 0, &p
, 0,
1101 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1103 else if(err
== DB_NOTFOUND
) return 0;
1104 /* compute the alias, if any, and delete it */
1105 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1107 /* if the alias points to some other track then compute_alias won't
1109 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1110 && err
!= DB_NOTFOUND
)
1113 /* update search.db */
1114 w
= track_to_words(track
, p
);
1115 for(n
= 0; w
[n
]; ++n
)
1116 if(trackdb_delkeydata(trackdb_searchdb
,
1117 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1119 /* update tags.db */
1120 w
= parsetags(kvp_get(p
, "tags"));
1121 for(n
= 0; w
[n
]; ++n
)
1122 if(trackdb_delkeydata(trackdb_tagsdb
,
1123 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1125 /* update tracks.db */
1126 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1128 /* We don't delete the prefs, so they survive temporary outages of the
1129 * (possibly virtual) track filesystem */
1133 /* trackdb_stats() ***********************************************************/
1135 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1136 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1138 static const struct statinfo
{
1141 } statinfo_hash
[] = {
1157 }, statinfo_btree
[] = {
1178 /* look up stats for DB */
1179 static int get_stats(struct vector
*v
,
1181 const struct statinfo
*si
,
1190 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1193 case DB_LOCK_DEADLOCK
:
1194 error(0, "error querying database: %s", db_strerror(err
));
1197 fatal(0, "error querying database: %s", db_strerror(err
));
1199 for(n
= 0; n
< nsi
; ++n
) {
1200 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1201 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1202 vector_append(v
, str
);
1208 /** @brief One entry in the search league */
1209 struct search_entry
{
1214 /** @brief Add a word to the search league
1215 * @param se Pointer to search league
1216 * @param count Maximum size for search league
1217 * @param nse Current size of search league
1218 * @param word New word, or NULL
1219 * @param n How often @p word appears
1220 * @return New size of search league
1222 static int register_search_entry(struct search_entry
*se
,
1229 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1230 /* Find the starting point */
1235 /* Find the insertion point */
1236 while(i
> 0 && n
> se
[i
- 1].n
)
1238 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1245 /* find the top COUNT words in the search database */
1246 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1247 struct search_entry
*se
;
1250 int err
, n
= 0, nse
= 0, i
;
1255 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1256 se
= xmalloc(count
* sizeof *se
);
1257 /* Walk across the whole database counting up the number of times each
1259 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1261 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1262 ++n
; /* same word again */
1264 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1265 word
= xstrndup(k
.data
, wl
= k
.size
);
1273 case DB_LOCK_DEADLOCK
:
1274 error(0, "error querying search database: %s", db_strerror(err
));
1277 fatal(0, "error querying search database: %s", db_strerror(err
));
1279 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1281 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1282 byte_xasprintf(&str
, "Top %d search words:", nse
);
1283 vector_append(v
, str
);
1284 for(i
= 0; i
< nse
; ++i
) {
1285 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1286 vector_append(v
, str
);
1291 #define SI(what) statinfo_##what, \
1292 sizeof statinfo_##what / sizeof (struct statinfo)
1294 /* return a list of database stats */
1295 char **trackdb_stats(int *nstatsp
) {
1301 tid
= trackdb_begin_transaction();
1303 vector_append(&v
, (char *)"Tracks database stats:");
1304 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1305 vector_append(&v
, (char *)"");
1306 vector_append(&v
, (char *)"Search database stats:");
1307 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1308 vector_append(&v
, (char *)"");
1309 vector_append(&v
, (char *)"Prefs database stats:");
1310 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1311 vector_append(&v
, (char *)"");
1312 if(search_league(&v
, 10, tid
)) goto fail
;
1313 vector_terminate(&v
);
1316 trackdb_abort_transaction(tid
);
1318 trackdb_commit_transaction(tid
);
1319 if(nstatsp
) *nstatsp
= v
.nvec
;
1323 struct stats_details
{
1324 void (*done
)(char *data
, void *u
);
1326 int exited
; /* subprocess exited */
1327 int closed
; /* pipe close */
1328 int wstat
; /* wait status from subprocess */
1329 struct dynstr data
[1]; /* data read from pipe */
1332 static void stats_complete(struct stats_details
*d
) {
1335 if(!(d
->exited
&& d
->closed
))
1337 byte_xasprintf(&s
, "\n"
1339 "track lookup cache hits: %lu\n"
1340 "track lookup cache misses: %lu\n",
1342 cache_files_misses
);
1343 dynstr_append_string(d
->data
, s
);
1344 dynstr_terminate(d
->data
);
1345 d
->done(d
->data
->vec
, d
->u
);
1348 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1349 pid_t
attribute((unused
)) pid
,
1351 const struct rusage
attribute((unused
)) *rusage
,
1353 struct stats_details
*const d
= u
;
1357 error(0, "disorder-stats %s", wstat(status
));
1362 static int stats_read(ev_source
attribute((unused
)) *ev
,
1368 struct stats_details
*const d
= u
;
1370 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1371 ev_reader_consume(reader
, bytes
);
1378 static int stats_error(ev_source
attribute((unused
)) *ev
,
1381 struct stats_details
*const d
= u
;
1383 error(errno_value
, "error reading from pipe to disorder-stats");
1389 void trackdb_stats_subprocess(ev_source
*ev
,
1390 void (*done
)(char *data
, void *u
),
1394 struct stats_details
*d
= xmalloc(sizeof *d
);
1396 dynstr_init(d
->data
);
1400 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1402 ev_child(ev
, pid
, 0, stats_finished
, d
);
1403 if(!ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
,
1404 "disorder-stats reader"))
1405 fatal(0, "ev_reader_new for disorder-stats reader failed");
1408 /** @brief Parse a track name part preference
1409 * @param name Preference name
1410 * @param partp Where to store part name
1411 * @param contextp Where to store context name
1412 * @return 0 on success, non-0 if parse fails
1414 static int trackdb__parse_namepref(const char *name
,
1418 static const char prefix
[] = "trackname_";
1420 if(strncmp(name
, prefix
, strlen(prefix
)))
1421 return -1; /* not trackname_* at all */
1422 name
+= strlen(prefix
);
1423 /* There had better be a _ between context and part */
1424 c
= strchr(name
, '_');
1427 /* Context is first in the pref name even though most APIs have the part
1428 * first. Confusing; sorry. */
1429 *contextp
= xstrndup(name
, c
- name
);
1431 /* There had better NOT be a second _ */
1434 *partp
= xstrdup(c
);
1438 /** @brief Compute the default value for a track preference
1439 * @param track Track name
1440 * @param name Preference name
1441 * @return Default value or 0 if none/not known
1443 static const char *trackdb__default(const char *track
, const char *name
) {
1444 char *context
, *part
;
1446 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1447 /* We can work out the default for a trackname_ pref */
1448 return trackname_part(track
, context
, part
);
1449 } else if(!strcmp(name
, "weight")) {
1450 /* We know the default weight */
1452 } else if(!strcmp(name
, "pick_at_random")) {
1453 /* By default everything is eligible for picking at random */
1455 } else if(!strcmp(name
, "tags")) {
1456 /* By default everything no track has any tags */
1462 /* set a pref (remove if value=0) */
1463 int trackdb_set(const char *track
,
1465 const char *value
) {
1466 struct kvp
*t
, *p
, *a
;
1469 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1472 /* If the value matches the default then unset instead, to keep the database
1473 * tidy. Older versions did not have this feature so your database may yet
1474 * have some default values stored in it. */
1476 def
= trackdb__default(track
, name
);
1477 if(def
&& !strcmp(value
, def
))
1482 tid
= trackdb_begin_transaction();
1483 if((err
= gettrackdata(track
, &t
, &p
, 0,
1484 0, tid
)) == DB_LOCK_DEADLOCK
)
1486 if(err
== DB_NOTFOUND
) break;
1487 if(name
[0] == '_') {
1488 if(kvp_set(&t
, name
, value
))
1489 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1492 /* get the old alias name */
1493 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1494 /* get the old tags */
1495 if(!strcmp(name
, "tags"))
1496 oldtags
= parsetags(kvp_get(p
, "tags"));
1498 if(kvp_set(&p
, name
, value
))
1499 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1501 /* compute the new alias name */
1502 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1503 /* check whether alias has changed */
1504 if(!(oldalias
== newalias
1505 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1506 /* adjust alias records to fit change */
1508 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1512 kvp_set(&a
, "_alias_for", track
);
1513 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1516 /* check whether tags have changed */
1517 if(!strcmp(name
, "tags")) {
1518 newtags
= parsetags(value
);
1519 while(*oldtags
|| *newtags
) {
1520 if(*oldtags
&& *newtags
) {
1521 cmp
= strcmp(*oldtags
, *newtags
);
1523 /* keeping this tag */
1527 /* old tag fits into a gap in the new list, so delete old */
1530 /* new tag fits into a gap in the old list, so insert new */
1532 } else if(*oldtags
) {
1533 /* we've run out of new tags, so remaining old ones are to be
1536 if(trackdb_delkeydata(trackdb_tagsdb
,
1537 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1541 /* we've run out of old tags, so remainig new ones are to be
1544 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1553 trackdb_abort_transaction(tid
);
1555 trackdb_commit_transaction(tid
);
1556 return err
== 0 ?
0 : -1;
1560 const char *trackdb_get(const char *track
,
1562 return kvp_get(trackdb_get_all(track
), name
);
1565 /* get all prefs as a 0-terminated array */
1566 struct kvp
*trackdb_get_all(const char *track
) {
1567 struct kvp
*t
, *p
, **pp
;
1571 tid
= trackdb_begin_transaction();
1572 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1576 trackdb_abort_transaction(tid
);
1578 trackdb_commit_transaction(tid
);
1579 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1586 const char *trackdb_resolve(const char *track
) {
1591 tid
= trackdb_begin_transaction();
1592 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1596 trackdb_abort_transaction(tid
);
1598 trackdb_commit_transaction(tid
);
1602 int trackdb_isalias(const char *track
) {
1603 const char *actual
= trackdb_resolve(track
);
1605 return strcmp(actual
, track
);
1608 /* test whether a track exists (perhaps an alias) */
1609 int trackdb_exists(const char *track
) {
1614 tid
= trackdb_begin_transaction();
1615 /* unusually, here we want the return value */
1616 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1620 trackdb_abort_transaction(tid
);
1622 trackdb_commit_transaction(tid
);
1626 /* return the list of tags */
1627 char **trackdb_alltags(void) {
1632 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1636 /** @brief List all the keys in @p db
1637 * @param db Database
1638 * @param v Vector to store keys in
1639 * @param tid Transaction ID
1640 * @return 0 or DB_LOCK_DEADLOCK
1642 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1645 DBC
*const c
= trackdb_opencursor(db
, tid
);
1648 memset(&k
, 0, sizeof k
);
1649 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1650 vector_append(v
, xstrndup(k
.data
, k
.size
));
1654 case DB_LOCK_DEADLOCK
:
1657 fatal(0, "c->c_get: %s", db_strerror(e
));
1659 if((e
= trackdb_closecursor(c
)))
1661 vector_terminate(v
);
1665 /* return 1 iff sorted tag lists A and B have at least one member in common */
1666 int tag_intersection(char **a
, char **b
) {
1669 /* Same sort of logic as trackdb_set() above */
1671 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1672 else if(cmp
< 0) ++a
;
1678 static pid_t choose_pid
= -1;
1679 static int choose_fd
;
1680 static random_callback
*choose_callback
;
1681 static struct dynstr choose_output
;
1682 static unsigned choose_complete
;
1683 static int choose_status
;
1684 #define CHOOSE_RUNNING 1
1685 #define CHOOSE_READING 2
1687 static void choose_finished(ev_source
*ev
, unsigned which
) {
1688 choose_complete
|= which
;
1689 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1692 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1693 dynstr_terminate(&choose_output
);
1694 choose_callback(ev
, xstrdup(choose_output
.vec
));
1696 choose_callback(ev
, 0);
1699 /** @brief Called when @c disorder-choose terminates */
1700 static int choose_exited(ev_source
*ev
,
1701 pid_t
attribute((unused
)) pid
,
1703 const struct rusage
attribute((unused
)) *rusage
,
1704 void attribute((unused
)) *u
) {
1706 error(0, "disorder-choose %s", wstat(status
));
1707 choose_status
= status
;
1708 choose_finished(ev
, CHOOSE_RUNNING
);
1712 /** @brief Called with data from @c disorder-choose pipe */
1713 static int choose_readable(ev_source
*ev
,
1718 void attribute((unused
)) *u
) {
1719 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1720 ev_reader_consume(reader
, bytes
);
1722 choose_finished(ev
, CHOOSE_READING
);
1726 static int choose_read_error(ev_source
*ev
,
1728 void attribute((unused
)) *u
) {
1729 error(errno_value
, "error reading disorder-choose pipe");
1730 choose_finished(ev
, CHOOSE_READING
);
1734 /** @brief Request a random track
1735 * @param ev Event source
1736 * @param callback Called with random track or NULL
1737 * @return 0 if a request was initiated, else -1
1739 * Initiates a random track choice. @p callback will later be called back with
1740 * the choice (or NULL on error). If a choice is already underway then -1 is
1741 * returned and there will be no additional callback.
1743 * The caller shouldn't assume that the track returned actually exists (it
1744 * might be removed between the choice and the callback, or between being added
1745 * to the queue and being played).
1747 int trackdb_request_random(ev_source
*ev
,
1748 random_callback
*callback
) {
1751 if(choose_pid
!= -1)
1752 return -1; /* don't run concurrent chooses */
1755 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1758 choose_callback
= callback
;
1759 choose_output
.nvec
= 0;
1760 choose_complete
= 0;
1761 if(!ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1762 "disorder-choose reader")) /* owns p[0] */
1763 fatal(0, "ev_reader_new for disorder-choose reader failed");
1764 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1768 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1769 * from the prefs. */
1770 static const char *getpart(const char *track
,
1771 const char *context
,
1773 const struct kvp
*p
,
1778 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1779 if((result
= kvp_get(p
, pref
)))
1782 result
= trackname_part(track
, context
, part
);
1783 assert(result
!= 0);
1787 /* get a track name part, like trackname_part(), but taking the database into
1789 const char *trackdb_getpart(const char *track
,
1790 const char *context
,
1798 /* construct the full pref */
1799 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1801 tid
= trackdb_begin_transaction();
1802 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1806 trackdb_abort_transaction(tid
);
1808 trackdb_commit_transaction(tid
);
1809 return getpart(actual
, context
, part
, p
, &used_db
);
1812 /* get the raw path name for @track@ (might be an alias) */
1813 const char *trackdb_rawpath(const char *track
) {
1819 tid
= trackdb_begin_transaction();
1820 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1824 trackdb_abort_transaction(tid
);
1826 trackdb_commit_transaction(tid
);
1827 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1831 /* trackdb_list **************************************************************/
1833 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1834 * readable at some point */
1836 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1837 * If RE is a null pointer then it matches everything. */
1838 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1846 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1847 case PCRE_ERROR_NOMATCH
: return 0;
1850 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1857 static int do_list(struct vector
*v
, const char *dir
,
1858 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1864 size_t l
, last_dir_len
= 0;
1865 char *last_dir
= 0, *track
;
1869 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1872 /* find the first key >= dir */
1873 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1874 /* keep going while we're dealing with <dir/anything> */
1877 && ((char *)k
.data
)[dl
] == '/'
1878 && !memcmp(k
.data
, dir
, dl
)) {
1879 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1881 /* we have <dir/component/anything>, so <dir/component> is a directory */
1882 l
= ptr
- (char *)k
.data
;
1883 if(what
& trackdb_directories
)
1885 && l
== last_dir_len
1886 && !memcmp(last_dir
, k
.data
, l
))) {
1887 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1888 if(track_matches(dl
, k
.data
, l
, re
))
1889 vector_append(v
, last_dir
);
1892 /* found a plain file */
1893 if((what
& trackdb_files
)) {
1894 track
= xstrndup(k
.data
, k
.size
);
1895 if((err
= trackdb_getdata(trackdb_prefsdb
,
1896 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1898 /* There's an awkward question here...
1900 * If a track shares a directory with its alias then we could
1901 * do one of three things:
1902 * - report both. Looks ridiculuous in most UIs.
1903 * - report just the alias. Remarkably inconvenient to write
1905 * - report just the real name. Ugly if the UI doesn't prettify
1906 * names via the name parts.
1909 /* If this file is an alias for a track in the same directory then we
1911 struct kvp
*t
= kvp_urldecode(d
.data
, d
.size
);
1912 const char *alias_target
= kvp_get(t
, "_alias_for");
1914 && !strcmp(d_dirname(alias_target
),
1916 if(track_matches(dl
, k
.data
, k
.size
, re
))
1917 vector_append(v
, track
);
1919 /* if this file has an alias in the same directory then we skip it */
1921 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1923 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1924 if(track_matches(dl
, k
.data
, k
.size
, re
))
1925 vector_append(v
, track
);
1929 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1937 case DB_LOCK_DEADLOCK
:
1938 error(0, "error querying database: %s", db_strerror(err
));
1941 fatal(0, "error querying database: %s", db_strerror(err
));
1944 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1948 /* return the directories or files below @dir@ */
1949 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1957 tid
= trackdb_begin_transaction();
1960 if(do_list(&v
, dir
, what
, re
, tid
))
1963 for(n
= 0; n
< config
->collection
.n
; ++n
)
1964 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1969 trackdb_abort_transaction(tid
);
1971 trackdb_commit_transaction(tid
);
1972 vector_terminate(&v
);
1978 /* If S is tag:something, return something. Else return 0. */
1979 static const char *checktag(const char *s
) {
1980 if(!strncmp(s
, "tag:", 4))
1986 /* return a list of tracks containing all of the words given. If you
1987 * ask for only stopwords you get no tracks. */
1988 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1989 const char **w
, *best
= 0, *tag
;
1990 char **twords
, **tags
;
1992 int i
, j
, n
, err
, what
;
2002 *ntracks
= 0; /* for early returns */
2003 /* normalize all the words */
2004 w
= xmalloc(nwordlist
* sizeof (char *));
2005 istag
= xmalloc_noptr(nwordlist
);
2006 for(n
= 0; n
< nwordlist
; ++n
) {
2010 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
2011 if(checktag(w
[n
])) {
2012 ++ntags
; /* count up tags */
2013 /* Normalize the tag */
2014 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2017 /* Normalize the search term by removing combining characters */
2018 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2020 nw32
= remove_combining_chars(w32
, nw32
);
2021 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2026 /* find the longest non-stopword */
2027 for(n
= 0; n
< nwordlist
; ++n
)
2028 if(!istag
[n
] && !stopword(w
[n
]))
2029 if(!best
|| strlen(w
[n
]) > strlen(best
))
2031 /* TODO: we should at least in principal be able to identify the word or tag
2032 * with the least matches in log time, and choose that as our primary search
2034 if(ntags
&& !best
) {
2035 /* Only tags are listed. We limit to the first and narrow down with the
2037 best
= istag
[0] ? w
[0] : 0;
2038 db
= trackdb_tagsdb
;
2041 /* We can limit to some word. */
2042 db
= trackdb_searchdb
;
2045 /* Only stopwords */
2051 tid
= trackdb_begin_transaction();
2052 /* find all the tracks that have that word */
2057 cursor
= trackdb_opencursor(db
, tid
);
2058 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2059 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2066 case DB_LOCK_DEADLOCK
:
2067 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2070 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2072 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2074 /* do a naive search over that (hopefuly fairly small) list of tracks */
2076 for(n
= 0; n
< v
.nvec
; ++n
) {
2077 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2080 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2083 twords
= track_to_words(v
.vec
[n
], p
);
2084 tags
= parsetags(kvp_get(p
, "tags"));
2085 for(i
= 0; i
< nwordlist
; ++i
) {
2088 /* Track must have this tag */
2089 for(j
= 0; tags
[j
]; ++j
)
2090 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2091 if(!tags
[j
]) break; /* tag not found */
2093 /* Track must contain this word */
2094 for(j
= 0; twords
[j
]; ++j
)
2095 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2096 if(!twords
[j
]) break; /* word not found */
2099 if(i
>= nwordlist
) /* all words found */
2100 vector_append(&u
, v
.vec
[n
]);
2104 trackdb_closecursor(cursor
);
2106 trackdb_abort_transaction(tid
);
2107 info("retrying search");
2109 trackdb_commit_transaction(tid
);
2110 vector_terminate(&u
);
2116 /* trackdb_scan **************************************************************/
2118 int trackdb_scan(const char *root
,
2119 int (*callback
)(const char *track
,
2128 const size_t root_len
= root ?
strlen(root
) : 0;
2130 struct kvp
*data
, *prefs
;
2133 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2135 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2138 memset(&k
, 0, sizeof k
);
2139 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2144 || (k
.size
> root_len
2145 && !strncmp(k
.data
, root
, root_len
)
2146 && ((char *)k
.data
)[root_len
] == '/')) {
2147 data
= kvp_urldecode(d
.data
, d
.size
);
2148 if(kvp_get(data
, "_path")) {
2149 track
= xstrndup(k
.data
, k
.size
);
2150 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2151 * do a lookup for every single track. In fact this is quite quick:
2152 * with around 10,000 tracks a complete scan is around 0.3s on my
2153 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2154 * linear walk as we already do over trackdb_tracksdb, and probably get
2155 * even higher performance. That would require upgrade logic to
2156 * translate old databases though.
2158 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2159 prepare_data(&pd
), 0)) {
2161 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2166 case DB_LOCK_DEADLOCK
:
2167 error(0, "getting prefs: %s", db_strerror(err
));
2168 trackdb_closecursor(cursor
);
2171 fatal(0, "getting prefs: %s", db_strerror(err
));
2173 /* Advance to the next track before the callback so that the callback
2174 * may safely delete the track */
2175 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2176 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2181 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2185 trackdb_closecursor(cursor
);
2192 case DB_LOCK_DEADLOCK
:
2193 error(0, "c->c_get: %s", db_strerror(err
));
2196 fatal(0, "c->c_get: %s", db_strerror(err
));
2200 /* trackdb_rescan ************************************************************/
2202 /** @brief Node in the list of rescan-complete callbacks */
2203 struct rescanned_node
{
2204 struct rescanned_node
*next
;
2205 void (*rescanned
)(void *ru
);
2209 /** @brief List of rescan-complete callbacks */
2210 static struct rescanned_node
*rescanned_list
;
2212 /** @brief Add a rescan completion callback */
2213 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2216 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2217 n
->next
= rescanned_list
;
2218 n
->rescanned
= rescanned
;
2224 /* called when the rescanner terminates */
2225 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2228 const struct rusage
attribute((unused
)) *rusage
,
2229 void attribute((unused
)) *u
) {
2230 if(pid
== rescan_pid
) rescan_pid
= -1;
2232 error(0, RESCAN
": %s", wstat(status
));
2234 D((RESCAN
" terminated: %s", wstat(status
)));
2235 /* Our cache of file lookups is out of date now */
2236 cache_clean(&cache_files_type
);
2237 eventlog("rescanned", (char *)0);
2238 /* Call rescanned callbacks */
2239 while(rescanned_list
) {
2240 void (*rescanned
)(void *u_
) = rescanned_list
->rescanned
;
2241 void *ru
= rescanned_list
->ru
;
2243 rescanned_list
= rescanned_list
->next
;
2249 /** @brief Initiate a rescan
2250 * @param ev Event loop or 0 to block
2251 * @param recheck 1 to recheck lengths, 0 to suppress check
2252 * @param rescanned Called on completion (if not NULL)
2253 * @param ru Passed to @p rescanned
2255 void trackdb_rescan(ev_source
*ev
, int recheck
,
2256 void (*rescanned
)(void *ru
),
2260 if(rescan_pid
!= -1) {
2261 trackdb_add_rescanned(rescanned
, ru
);
2262 error(0, "rescan already underway");
2265 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2266 recheck ?
"--check" : "--no-check",
2268 trackdb_add_rescanned(rescanned
, ru
);
2270 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2271 D(("started rescanner"));
2273 /* This is the first rescan, we block until it is complete */
2274 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2276 reap_rescan(0, rescan_pid
, w
, 0, 0);
2280 int trackdb_rescan_cancel(void) {
2281 if(rescan_pid
== -1) return 0;
2282 if(kill(rescan_pid
, SIGTERM
) < 0)
2283 fatal(errno
, "error killing rescanner");
2288 /** @brief Return true if a rescan is underway */
2289 int trackdb_rescan_underway(void) {
2290 return rescan_pid
!= -1;
2293 /* global prefs **************************************************************/
2295 void trackdb_set_global(const char *name
,
2303 tid
= trackdb_begin_transaction();
2304 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2306 trackdb_abort_transaction(tid
);
2308 trackdb_commit_transaction(tid
);
2309 /* log important state changes */
2310 if(!strcmp(name
, "playing")) {
2311 state
= !value
|| !strcmp(value
, "yes");
2312 info("playing %s by %s",
2313 state ?
"enabled" : "disabled",
2315 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2317 if(!strcmp(name
, "random-play")) {
2318 state
= !value
|| !strcmp(value
, "yes");
2319 info("random play %s by %s",
2320 state ?
"enabled" : "disabled",
2322 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2326 int trackdb_set_global_tid(const char *name
,
2332 memset(&k
, 0, sizeof k
);
2333 memset(&d
, 0, sizeof d
);
2334 k
.data
= (void *)name
;
2335 k
.size
= strlen(name
);
2337 d
.data
= (void *)value
;
2338 d
.size
= strlen(value
);
2341 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2343 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2344 if(err
== DB_LOCK_DEADLOCK
) return err
;
2346 fatal(0, "error updating database: %s", db_strerror(err
));
2350 const char *trackdb_get_global(const char *name
) {
2356 tid
= trackdb_begin_transaction();
2357 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2359 trackdb_abort_transaction(tid
);
2361 trackdb_commit_transaction(tid
);
2365 int trackdb_get_global_tid(const char *name
,
2371 memset(&k
, 0, sizeof k
);
2372 k
.data
= (void *)name
;
2373 k
.size
= strlen(name
);
2374 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2375 prepare_data(&d
), 0)) {
2377 *rp
= xstrndup(d
.data
, d
.size
);
2382 case DB_LOCK_DEADLOCK
:
2385 fatal(0, "error reading database: %s", db_strerror(err
));
2389 /** @brief Retrieve the most recently added tracks
2390 * @param ntracksp Where to put count, or 0
2391 * @param maxtracks Maximum number of tracks to retrieve
2392 * @return null-terminated array of track names
2394 * The most recently added track is first in the array.
2396 char **trackdb_new(int *ntracksp
,
2402 tid
= trackdb_begin_transaction();
2403 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2406 trackdb_abort_transaction(tid
);
2408 trackdb_commit_transaction(tid
);
2412 /** @brief Retrieve the most recently added tracks
2413 * @param ntracksp Where to put count, or 0
2414 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2415 * @param tid Transaction ID
2416 * @return null-terminated array of track names, or NULL on deadlock
2418 * The most recently added track is first in the array.
2420 static char **trackdb_new_tid(int *ntracksp
,
2426 struct vector tracks
[1];
2427 hash
*h
= hash_new(1);
2429 vector_init(tracks
);
2430 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2431 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2432 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
))) {
2433 char *const track
= xstrndup(d
.data
, d
.size
);
2434 /* Don't add any track more than once */
2435 if(hash_add(h
, track
, "", HASH_INSERT
))
2437 /* See if the track still exists */
2438 err
= trackdb_getdata(trackdb_tracksdb
, track
, NULL
/*kp*/, tid
);
2439 if(err
== DB_NOTFOUND
)
2440 continue; /* It doesn't, skip it */
2441 if(err
== DB_LOCK_DEADLOCK
)
2443 vector_append(tracks
, track
);
2446 case 0: /* hit maxtracks */
2447 case DB_NOTFOUND
: /* ran out of tracks */
2449 case DB_LOCK_DEADLOCK
:
2450 trackdb_closecursor(c
);
2453 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2455 if((err
= trackdb_closecursor(c
)))
2456 return 0; /* deadlock */
2457 vector_terminate(tracks
);
2459 *ntracksp
= tracks
->nvec
;
2463 /** @brief Expire noticed.db
2464 * @param earliest Earliest timestamp to keep
2466 void trackdb_expire_noticed(time_t earliest
) {
2470 tid
= trackdb_begin_transaction();
2471 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2473 trackdb_abort_transaction(tid
);
2475 trackdb_commit_transaction(tid
);
2478 /** @brief Expire noticed.db
2479 * @param earliest Earliest timestamp to keep
2480 * @param tid Transaction ID
2481 * @return 0 or DB_LOCK_DEADLOCK
2483 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2491 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2492 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2494 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2495 if(when
>= earliest
)
2497 if((err
= c
->c_del(c
, 0))) {
2498 if(err
!= DB_LOCK_DEADLOCK
)
2499 fatal(0, "error deleting expired noticed.db entry: %s",
2505 if(err
== DB_NOTFOUND
)
2507 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2508 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2510 if((err
= trackdb_closecursor(c
))) {
2511 if(err
!= DB_LOCK_DEADLOCK
)
2512 fatal(0, "error closing cursor: %s", db_strerror(err
));
2516 info("expired %d tracks from noticed.db", count
);
2520 /* tidying up ****************************************************************/
2522 void trackdb_gc(void) {
2526 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2527 config
->checkpoint_kbyte
,
2528 config
->checkpoint_min
,
2530 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2531 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2532 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2533 /* This makes catastrophic recovery impossible. However, the user can still
2534 * preserve the important data by using disorder-dump to snapshot their
2535 * prefs, and later to restore it. This is likely to have much small
2536 * long-term storage requirements than record the db logfiles. */
2539 /* user database *************************************************************/
2541 /** @brief Return true if @p user is trusted */
2542 static int trusted(const char *user
) {
2545 for(n
= 0; (n
< config
->trust
.n
2546 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2548 return n
< config
->trust
.n
;
2551 /** @brief Return non-zero for a valid username
2553 * Currently we only allow the letters and digits in ASCII. We could be more
2554 * liberal than this but it is a nice simple test. It is critical that
2555 * semicolons are never allowed.
2557 static int valid_username(const char *user
) {
2561 const uint8_t c
= *user
++;
2562 /* For now we are very strict */
2563 if((c
>= 'a' && c
<= 'z')
2564 || (c
>= 'A' && c
<= 'Z')
2565 || (c
>= '0' && c
<= '9'))
2573 /** @brief Add a user */
2574 static int create_user(const char *user
,
2575 const char *password
,
2578 const char *confirmation
,
2584 /* sanity check user */
2585 if(!valid_username(user
)) {
2586 error(0, "invalid username '%s'", user
);
2589 if(parse_rights(rights
, 0, 1)) {
2590 error(0, "invalid rights string");
2593 /* data for this user */
2595 kvp_set(&k
, "password", password
);
2596 kvp_set(&k
, "rights", rights
);
2598 kvp_set(&k
, "email", email
);
2600 kvp_set(&k
, "confirmation", confirmation
);
2601 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2602 kvp_set(&k
, "created", s
);
2603 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2606 /** @brief Add one pre-existing user */
2607 static int one_old_user(const char *user
, const char *password
,
2611 /* www-data doesn't get added */
2612 if(!strcmp(user
, "www-data")) {
2613 info("not adding www-data to user database");
2617 if(!strcmp(user
, "root"))
2619 else if(trusted(user
)) {
2622 parse_rights(config
->default_rights
, &r
, 1);
2623 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2624 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2625 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2626 rights
= rights_string(r
);
2628 rights
= config
->default_rights
;
2629 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2630 tid
, DB_NOOVERWRITE
);
2633 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2636 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2637 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2640 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2643 error(0, "user %s already exists, delete 'allow' directive",
2644 config
->allow
.s
[n
].s
[0]);
2645 /* This won't ever become fatal - eventually 'allow' will be
2648 case DB_LOCK_DEADLOCK
:
2649 return DB_LOCK_DEADLOCK
;
2655 /** @brief Read old 'allow' directives and copy them to the users database */
2656 void trackdb_old_users(void) {
2660 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2663 /** @brief Create a root user in the user database if there is none */
2664 void trackdb_create_root(void) {
2669 /* Choose a new root password */
2670 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2671 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2672 /* Create the root user if it does not exist */
2673 WITH_TRANSACTION(create_user("root", pw
, "all",
2674 0/*email*/, 0/*confirmation*/,
2675 tid
, DB_NOOVERWRITE
));
2677 info("created root user");
2680 /** @brief Find a user's password from the database
2681 * @param user Username
2682 * @return Password or NULL
2684 * Only works if running as a user that can read the database!
2686 * If the user exists but has no password, "" is returned.
2688 const char *trackdb_get_password(const char *user
) {
2691 const char *password
;
2693 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2696 password
= kvp_get(k
, "password");
2697 return password ? password
: "";
2700 /** @brief Add a new user
2701 * @param user Username
2702 * @param password Password or NULL
2703 * @param rights Initial rights
2704 * @param email Email address or NULL
2705 * @param confirmation Confirmation string or NULL
2706 * @return 0 on success, non-0 on error
2708 int trackdb_adduser(const char *user
,
2709 const char *password
,
2712 const char *confirmation
) {
2715 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2716 tid
, DB_NOOVERWRITE
));
2718 error(0, "cannot create user '%s' because they already exist", user
);
2722 info("created user '%s' with rights '%s' and email address '%s'",
2723 user
, rights
, email
);
2725 info("created user '%s' with rights '%s'", user
, rights
);
2726 eventlog("user_add", user
, (char *)0);
2731 /** @brief Delete a user
2732 * @param user User to delete
2733 * @return 0 on success, non-0 if the user didn't exist anyway
2735 int trackdb_deluser(const char *user
) {
2738 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2740 error(0, "cannot delete user '%s' because they do not exist", user
);
2743 info("deleted user '%s'", user
);
2744 eventlog("user_delete", user
, (char *)0);
2748 /** @brief Get user information
2749 * @param user User to query
2750 * @return Linked list of user information or NULL if user does not exist
2752 * Every user has at least a @c rights entry so NULL can be used to mean no
2755 struct kvp
*trackdb_getuserinfo(const char *user
) {
2759 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2766 /** @brief Edit user information
2767 * @param user User to edit
2768 * @param key Key to change
2769 * @param value Value to set, or NULL to remove
2770 * @param tid Transaction ID
2771 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2773 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2774 const char *value
, DB_TXN
*tid
) {
2778 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2780 if(!kvp_set(&k
, key
, value
))
2781 return 0; /* no change */
2782 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2785 /** @brief Edit user information
2786 * @param user User to edit
2787 * @param key Key to change
2788 * @param value Value to set, or NULL to remove
2789 * @return 0 on success, non-0 on error
2791 int trackdb_edituserinfo(const char *user
,
2792 const char *key
, const char *value
) {
2795 if(!strcmp(key
, "rights")) {
2797 error(0, "cannot remove 'rights' key from user '%s'", user
);
2800 if(parse_rights(value
, 0, 1)) {
2801 error(0, "invalid rights string");
2804 } else if(!strcmp(key
, "email")) {
2806 if(!email_valid(value
)) {
2807 error(0, "invalid email address '%s' for user '%s'", value
, user
);
2811 value
= 0; /* no email -> remove key */
2812 } else if(!strcmp(key
, "created")) {
2813 error(0, "cannot change creation date for user '%s'", user
);
2815 } else if(strcmp(key
, "password")
2816 && !strcmp(key
, "confirmation")) {
2817 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2820 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2822 error(0, "unknown user '%s'", user
);
2825 eventlog("user_edit", user
, key
, (char *)0);
2830 /** @brief List all users
2831 * @return NULL-terminated list of users
2833 char **trackdb_listusers(void) {
2838 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2842 /** @brief Confirm a user registration
2843 * @param user Username
2844 * @param confirmation Confirmation string
2845 * @param rightsp Where to put user rights
2846 * @param tid Transaction ID
2847 * @return 0 on success, non-0 on error
2849 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2850 rights_type
*rightsp
,
2852 const char *stored_confirmation
;
2857 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2859 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2860 error(0, "already confirmed user '%s'", user
);
2861 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2864 if(!(rights
= kvp_get(k
, "rights"))) {
2865 error(0, "no rights for unconfirmed user '%s'", user
);
2868 if(parse_rights(rights
, rightsp
, 1))
2870 if(strcmp(confirmation
, stored_confirmation
)) {
2871 error(0, "wrong confirmation string for user '%s'", user
);
2875 kvp_set(&k
, "confirmation", 0);
2876 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2879 /** @brief Confirm a user registration
2880 * @param user Username
2881 * @param confirmation Confirmation string
2882 * @param rightsp Where to put user rights
2883 * @return 0 on success, non-0 on error
2885 int trackdb_confirm(const char *user
, const char *confirmation
,
2886 rights_type
*rightsp
) {
2889 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2892 info("registration confirmed for user '%s'", user
);
2893 eventlog("user_confirm", user
, (char *)0);
2896 error(0, "confirmation for nonexistent user '%s'", user
);
2898 default: /* already reported */
2908 indent-tabs-mode:nil