2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/trackdb.c
21 * @brief Track database
23 * This file is getting in desparate need of splitting up...
32 #include <sys/socket.h>
39 #include <sys/resource.h>
41 #include <arpa/inet.h>
54 #include "configuration.h"
59 #include "trackname.h"
60 #include "trackdb-int.h"
69 #define RESCAN "disorder-rescan"
70 #define DEADLOCK "disorder-deadlock"
72 static const char *getpart(const char *track
,
77 static char **trackdb_new_tid(int *ntracksp
,
80 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
81 static char *normalize_tag(const char *s
, size_t ns
);
83 const struct cache_type cache_files_type
= { 86400 };
84 unsigned long cache_files_hits
, cache_files_misses
;
86 /** @brief Set by trackdb_open() */
87 int trackdb_existing_database
;
89 /* setup and teardown ********************************************************/
91 static const char *home
; /* home had better not change */
92 DB_ENV
*trackdb_env
; /* db environment */
94 /** @brief The tracks database
95 * - Keys are UTF-8(NFC(unicode(path name)))
96 * - Values are encoded key-value pairs
97 * - Data is reconstructable data about tracks that currently exist
101 /** @brief The preferences database
103 * - Keys are UTF-8(NFC(unicode(path name)))
104 * - Values are encoded key-value pairs
105 * - Data is user data about tracks (that might not exist any more)
106 * and cannot be reconstructed
110 /** @brief The search database
112 * - Keys are UTF-8(NFKC(casefold(search term)))
113 * - Values are UTF-8(NFC(unicode(path name)))
114 * - There can be more than one value per key
115 * - Presence of key,value means that path matches the search terms
116 * - Only tracks fond in @ref trackdb_tracksdb are represented here
117 * - This database can be reconstructed, it contains no user data
119 DB
*trackdb_searchdb
;
121 /** @brief The tags database
123 * - Keys are UTF-8(NFKC(casefold(tag)))
124 * - Values are UTF-8(NFC(unicode(path name)))
125 * - There can be more than one value per key
126 * - Presence of key,value means that path matches the tag
127 * - This is always in sync with the tags preference
128 * - This database can be reconstructed, it contains no user data
130 DB
*trackdb_tagsdb
; /* the tags database */
132 /** @brief The global preferences database
133 * - Keys are UTF-8(NFC(preference))
134 * - Values are global preference values
135 * - Data is user data and cannot be reconstructed
137 DB
*trackdb_globaldb
; /* global preferences */
139 /** @brief The noticed database
140 * - Keys are 64-bit big-endian timestamps
141 * - Values are UTF-8(NFC(unicode(path name)))
142 * - There can be more than one value per key
143 * - Presence of key,value means that path was added at the given time
144 * - Data cannot be reconstructed (but isn't THAT important)
146 DB
*trackdb_noticeddb
; /* when track noticed */
148 /** @brief The schedule database
150 * - Keys are ID strings, generated at random
151 * - Values are encoded key-value pairs
152 * - There can be more than one value per key
153 * - Data cannot be reconstructed
155 * See @ref server/schedule.c for further information.
157 DB
*trackdb_scheduledb
;
159 /** @brief The user database
160 * - Keys are usernames
161 * - Values are encoded key-value pairs
162 * - Data is user data and cannot be reconstructed
166 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
167 static pid_t rescan_pid
= -1; /* rescanner PID */
168 static int initialized
, opened
; /* state */
170 /* comparison function for keys */
171 static int compare(DB
attribute((unused
)) *db_
,
172 const DBT
*a
, const DBT
*b
) {
173 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
176 /** @brief Test whether the track database can be read
177 * @return 1 if it can, 0 if it cannot
179 int trackdb_readable(void) {
182 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
183 return access(usersdb
, R_OK
) == 0;
186 /** @brief Open database environment
187 * @param flags Flags word
189 * Flags should be one of:
190 * - @ref TRACKDB_NO_RECOVER
191 * - @ref TRACKDB_NORMAL_RECOVER
192 * - @ref TRACKDB_FATAL_RECOVER
193 * - @ref TRACKDB_MAY_CREATE
195 void trackdb_init(int flags
) {
197 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
198 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
201 assert(initialized
== 0);
204 if(strcmp(home
, config
->home
))
205 fatal(0, "cannot change db home without server restart");
209 if(flags
& TRACKDB_MAY_CREATE
) {
215 /* Remove world/group permissions on any regular files already in the
216 * database directory. Actually we don't care about all of them but it's
217 * easier to just do the lot. This can be revisited if it's a serious
218 * practical inconvenience for anyone.
220 * The socket, not being a regular file, is excepted.
222 if(!(dp
= opendir(config
->home
)))
223 fatal(errno
, "error reading %s", config
->home
);
224 while((de
= readdir(dp
))) {
225 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
226 if(lstat(p
, &st
) == 0
227 && S_ISREG(st
.st_mode
)
228 && (st
.st_mode
& 077)) {
229 if(chmod(p
, st
.st_mode
& 07700) < 0)
230 fatal(errno
, "cannot chmod %s", p
);
237 /* create environment */
238 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
240 if((err
= trackdb_env
->set_alloc(trackdb_env
,
241 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
242 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
243 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
244 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
245 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
246 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
247 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
253 |recover_type
[recover
],
255 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
256 trackdb_env
->set_errpfx(trackdb_env
, "DB");
257 trackdb_env
->set_errfile(trackdb_env
, stderr
);
258 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
259 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
260 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
261 D(("initialized database environment"));
264 /* called when deadlock manager terminates */
265 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
266 pid_t
attribute((unused
)) pid
,
268 const struct rusage
attribute((unused
)) *rusage
,
269 void attribute((unused
)) *u
) {
270 db_deadlock_pid
= -1;
272 fatal(0, "deadlock manager unexpectedly terminated: %s",
275 D(("deadlock manager terminated: %s", wstat(status
)));
279 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
283 const char *args
[1024], **argp
, *a
;
287 *argp
++ = "--config";
288 *argp
++ = configfile
;
289 *argp
++ = debugging ?
"--debug" : "--no-debug";
290 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
292 while((a
= va_arg(ap
, const char *)))
296 /* If we're in the background then trap subprocess stdout/stderr */
297 if(!(pid
= xfork())) {
300 ev_signal_atfork(ev
);
301 signal(SIGPIPE
, SIG_DFL
);
306 /* ensure we don't leak privilege anywhere */
307 if(setuid(geteuid()) < 0)
308 fatal(errno
, "error calling setuid");
309 /* If we were negatively niced, undo it. We don't bother checking for
310 * error, it's not that important. */
311 setpriority(PRIO_PROCESS
, 0, 0);
312 execvp(prog
, (char **)args
);
313 fatal(errno
, "error invoking %s", prog
);
318 /* start deadlock manager */
319 void trackdb_master(ev_source
*ev
) {
320 assert(db_deadlock_pid
== -1);
321 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
322 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
323 D(("started deadlock manager"));
326 /* close environment */
327 void trackdb_deinit(void) {
331 assert(initialized
== 1);
334 /* close the environment */
335 if((err
= trackdb_env
->close(trackdb_env
, 0)))
336 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
338 if(rescan_pid
!= -1) {
339 /* shut down the rescanner */
340 if(kill(rescan_pid
, SIGTERM
) < 0)
341 fatal(errno
, "error killing rescanner");
342 /* wait for the rescanner to finish */
343 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
347 /* TODO kill any stats subprocesses */
349 /* finally terminate the deadlock manager */
350 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
351 fatal(errno
, "error killing deadlock manager");
352 db_deadlock_pid
= -1;
354 D(("deinitialized database environment"));
357 /* open a specific database */
358 static DB
*open_db(const char *path
,
366 D(("open %s", path
));
367 path
= config_get_file(path
);
368 if((err
= db_create(&db
, trackdb_env
, 0)))
369 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
371 if((err
= db
->set_flags(db
, dbflags
)))
372 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
373 if(dbtype
== DB_BTREE
)
374 if((err
= db
->set_bt_compare(db
, compare
)))
375 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
376 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
377 openflags
| DB_AUTO_COMMIT
, mode
))) {
378 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
379 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 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
494 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
495 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
496 fatal(0, "error closing search.db: %s", db_strerror(err
));
497 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
498 fatal(0, "error closing tags.db: %s", db_strerror(err
));
499 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
500 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
501 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
502 fatal(0, "error closing global.db: %s", db_strerror(err
));
503 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
504 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
505 if((err
= trackdb_scheduledb
->close(trackdb_scheduledb
, 0)))
506 fatal(0, "error closing schedule.db: %s", db_strerror(err
));
507 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
508 fatal(0, "error closing users.db: %s", db_strerror(err
));
509 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
510 trackdb_tagsdb
= trackdb_globaldb
= 0;
511 D(("closed databases"));
514 /* generic db routines *******************************************************/
516 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
517 * 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)) {
528 *kp
= kvp_urldecode(data
.data
, data
.size
);
533 case DB_LOCK_DEADLOCK
:
534 error(0, "error querying database: %s", db_strerror(err
));
537 fatal(0, "error querying database: %s", db_strerror(err
));
541 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
542 * DB_LOCK_DEADLOCK. */
543 int trackdb_putdata(DB
*db
,
551 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
552 encode_data(&data
, k
), flags
)) {
556 case DB_LOCK_DEADLOCK
:
557 error(0, "error updating database: %s", db_strerror(err
));
560 fatal(0, "error updating database: %s", db_strerror(err
));
564 /** @brief Delete a database entry
566 * @param track Key to delete
567 * @param tid Transaction ID
568 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
570 int trackdb_delkey(DB
*db
,
576 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
580 case DB_LOCK_DEADLOCK
:
581 error(0, "error updating database: %s", db_strerror(err
));
584 fatal(0, "error updating database: %s", db_strerror(err
));
588 /* open a database cursor */
589 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
593 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
595 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
600 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
601 int trackdb_closecursor(DBC
*c
) {
605 switch(err
= c
->c_close(c
)) {
608 case DB_LOCK_DEADLOCK
:
609 error(0, "error closing cursor: %s", db_strerror(err
));
612 fatal(0, "error closing cursor: %s", db_strerror(err
));
616 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
617 int trackdb_delkeydata(DB
*db
,
625 c
= trackdb_opencursor(db
, tid
);
626 switch(err
= c
->c_get(c
, make_key(&key
, word
),
627 make_key(&data
, track
), DB_GET_BOTH
)) {
629 switch(err
= c
->c_del(c
, 0)) {
635 case DB_LOCK_DEADLOCK
:
636 error(0, "error updating database: %s", db_strerror(err
));
639 fatal(0, "c->c_del: %s", db_strerror(err
));
644 case DB_LOCK_DEADLOCK
:
645 error(0, "error updating database: %s", db_strerror(err
));
648 fatal(0, "c->c_get: %s", db_strerror(err
));
650 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
654 /* start a transaction */
655 DB_TXN
*trackdb_begin_transaction(void) {
659 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
660 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
664 /* abort transaction */
665 void trackdb_abort_transaction(DB_TXN
*tid
) {
669 if((err
= tid
->abort(tid
)))
670 fatal(0, "tid->abort: %s", db_strerror(err
));
673 /* commit transaction */
674 void trackdb_commit_transaction(DB_TXN
*tid
) {
677 if((err
= tid
->commit(tid
, 0)))
678 fatal(0, "tid->commit: %s", db_strerror(err
));
681 /* search/tags shared code ***************************************************/
683 /* comparison function used by dedupe() */
684 static int wordcmp(const void *a
, const void *b
) {
685 return strcmp(*(const char **)a
, *(const char **)b
);
688 /* sort and de-dupe VEC */
689 static char **dedupe(char **vec
, int nvec
) {
692 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
696 for(n
= 1; n
< nvec
; ++n
)
697 if(strcmp(vec
[n
], vec
[m
- 1]))
704 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
705 static int register_word(DB
*db
, const char *what
,
706 const char *track
, const char *word
,
711 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
712 make_key(&data
, track
), DB_NODUPDATA
)) {
716 case DB_LOCK_DEADLOCK
:
717 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
720 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
724 /* search primitives *********************************************************/
726 /* return true iff NAME is a trackname_display_ pref */
727 static int is_display_pref(const char *name
) {
728 static const char prefix
[] = "trackname_display_";
729 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
732 /** @brief Word_Break property tailor that treats underscores as spaces */
733 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
737 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
738 return unicode_Word_Break_Other
;
742 /** @brief Remove all combining characters in-place
743 * @param s Pointer to start of string
744 * @param ns Length of string
745 * @return New, possiblby reduced, length
747 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
748 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
751 const uint32_t c
= *s
++;
752 if(!utf32_combining_class(c
))
758 /** @brief Normalize and split a string using a given tailoring */
759 static void word_split(struct vector
*v
,
761 unicode_property_tailor
*pt
) {
763 uint32_t *t32
, **w32
;
765 /* Convert to UTF-32 */
766 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
768 /* Erase case distinctions */
769 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
771 /* Drop combining characters */
772 nt32
= remove_combining_chars(t32
, nt32
);
773 /* Split into words, treating _ as a space */
774 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
775 /* Convert words back to UTF-8 and append to result */
776 for(i
= 0; i
< nw
; ++i
)
777 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
780 /** @brief Normalize a tag
782 * @param ns Length of tag
783 * @return Normalized string or NULL on error
785 * The return value will be:
787 * - have no leading or trailing space
788 * - have no combining characters
789 * - all spacing between words will be a single U+0020 SPACE
791 static char *normalize_tag(const char *s
, size_t ns
) {
792 uint32_t *s32
, **w32
;
793 size_t ns32
, nw32
, i
;
796 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
798 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
800 ns32
= remove_combining_chars(s32
, ns32
);
801 /* Split into words, no Word_Break tailoring */
802 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
803 /* Compose back into a string */
805 for(i
= 0; i
< nw32
; ++i
) {
807 dynstr_append(d
, ' ');
808 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
814 /* compute the words of a track name */
815 static char **track_to_words(const char *track
,
816 const struct kvp
*p
) {
818 const char *rootless
= track_rootless(track
);
821 rootless
= track
; /* bodge */
823 rootless
= strip_extension(rootless
);
824 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
825 for(; p
; p
= p
->next
)
826 if(is_display_pref(p
->name
))
827 word_split(&v
, p
->value
, 0);
828 vector_terminate(&v
);
829 return dedupe(v
.vec
, v
.nvec
);
832 /* return nonzero iff WORD is a stopword */
833 static int stopword(const char *word
) {
836 for(n
= 0; n
< config
->stopword
.n
837 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
839 return n
< config
->stopword
.n
;
842 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
843 static int register_search_word(const char *track
, const char *word
,
845 if(stopword(word
)) return 0;
846 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
849 /* Tags **********************************************************************/
851 /* Return nonzero if C is a valid tag character */
852 static int tagchar(int c
) {
861 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
862 char **parsetags(const char *s
) {
868 /* skip initial separators */
869 while(*s
&& (!tagchar(*s
) || *s
== ' '))
872 /* find the extent of the tag */
874 while(*s
&& tagchar(*s
))
876 /* strip trailing spaces */
877 while(s
> t
&& s
[-1] == ' ')
879 /* add tag to list */
880 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
881 /* skip intermediate and trailing separators */
882 while(*s
&& (!tagchar(*s
) || *s
== ' '))
886 vector_terminate(&v
);
887 return dedupe(v
.vec
, v
.nvec
);
890 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
891 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
892 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
895 /* aliases *******************************************************************/
897 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
898 * there is no alias sets *aliasp to 0. */
899 static int compute_alias(char **aliasp
,
904 const char *s
= config
->alias
, *t
, *expansion
, *part
;
905 int c
, used_db
= 0, slash_prefix
, err
;
907 const char *const root
= find_track_root(track
);
910 /* Bodge for tracks with no root */
915 dynstr_append_string(&d
, root
);
916 while((c
= (unsigned char)*s
++)) {
918 dynstr_append(&d
, c
);
921 if((slash_prefix
= (*s
== '/')))
924 assert(t
!= 0); /* validated at startup */
925 part
= xstrndup(s
, t
- s
);
926 expansion
= getpart(track
, "display", part
, p
, &used_db
);
928 if(slash_prefix
) dynstr_append(&d
, '/');
929 dynstr_append_string(&d
, expansion
);
931 s
= t
+ 1; /* skip {part} */
933 /* only admit to the alias if we used the db... */
938 dynstr_terminate(&d
);
939 /* ...and the answer differs from the original... */
940 if(!strcmp(track
, d
.vec
)) {
944 /* ...and there isn't already a different track with that name (including as
946 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
948 if((s
= kvp_get(at
, "_alias_for"))
949 && !strcmp(s
, track
)) {
961 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
962 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
963 * Always sets the return values, even if only to null pointers. */
964 static int gettrackdata(const char *track
,
967 const char **actualp
,
969 #define GTD_NOALIAS 0x0001
972 const char *actual
= track
;
973 struct kvp
*t
= 0, *p
= 0;
975 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
976 if((actual
= kvp_get(t
, "_alias_for"))) {
977 if(flags
& GTD_NOALIAS
) {
978 error(0, "alias passed to gettrackdata where real path required");
981 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
986 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
991 if(actualp
) *actualp
= actual
;
997 /* trackdb_notice() **********************************************************/
999 /** @brief notice a possibly new track
1000 * @return @c DB_NOTFOUND if new, 0 if already known
1002 int trackdb_notice(const char *track
,
1008 tid
= trackdb_begin_transaction();
1009 err
= trackdb_notice_tid(track
, path
, tid
);
1010 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1013 trackdb_abort_transaction(tid
);
1015 trackdb_commit_transaction(tid
);
1019 /** @brief notice a possibly new track
1020 * @param track NFC UTF-8 track name
1021 * @param path Raw path name
1022 * @param tid Transaction ID
1023 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1025 int trackdb_notice_tid(const char *track
,
1029 struct kvp
*t
, *a
, *p
;
1031 char *alias
, **w
, *noticed
;
1034 /* notice whether the tracks.db entry changes */
1036 /* get any existing tracks entry */
1037 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1039 ret
= err
; /* 0 or DB_NOTFOUND */
1040 /* this is a real track */
1041 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1042 t_changed
+= kvp_set(&t
, "_path", path
);
1044 if(ret
== DB_NOTFOUND
) {
1045 /* It's a new track; record the time */
1046 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1047 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1049 /* if we have an alias record it in the database */
1050 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1052 /* won't overwrite someone else's alias as compute_alias() checks */
1053 D(("%s: alias %s", track
, alias
));
1055 kvp_set(&a
, "_alias_for", track
);
1056 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1058 /* update search.db */
1059 w
= track_to_words(track
, p
);
1060 for(n
= 0; w
[n
]; ++n
)
1061 if((err
= register_search_word(track
, w
[n
], tid
)))
1063 /* update tags.db */
1064 w
= parsetags(kvp_get(p
, "tags"));
1065 for(n
= 0; w
[n
]; ++n
)
1066 if((err
= register_tag(track
, w
[n
], tid
)))
1068 /* only store the tracks.db entry if it has changed */
1069 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1071 if(ret
== DB_NOTFOUND
) {
1072 uint32_t timestamp
[2];
1075 timestamp
[0] = htonl((uint64_t)now
>> 32);
1076 timestamp
[1] = htonl((uint32_t)now
);
1077 memset(&key
, 0, sizeof key
);
1078 key
.data
= timestamp
;
1079 key
.size
= sizeof timestamp
;
1080 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1081 make_key(&data
, track
), 0)) {
1083 case DB_LOCK_DEADLOCK
: return err
;
1084 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1090 /* trackdb_obsolete() ********************************************************/
1092 /* obsolete a track */
1093 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1098 if((err
= gettrackdata(track
, 0, &p
, 0,
1099 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1101 else if(err
== DB_NOTFOUND
) return 0;
1102 /* compute the alias, if any, and delete it */
1103 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1105 /* if the alias points to some other track then compute_alias won't
1107 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1108 && err
!= DB_NOTFOUND
)
1111 /* update search.db */
1112 w
= track_to_words(track
, p
);
1113 for(n
= 0; w
[n
]; ++n
)
1114 if(trackdb_delkeydata(trackdb_searchdb
,
1115 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1117 /* update tags.db */
1118 w
= parsetags(kvp_get(p
, "tags"));
1119 for(n
= 0; w
[n
]; ++n
)
1120 if(trackdb_delkeydata(trackdb_tagsdb
,
1121 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1123 /* update tracks.db */
1124 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1126 /* We don't delete the prefs, so they survive temporary outages of the
1127 * (possibly virtual) track filesystem */
1131 /* trackdb_stats() ***********************************************************/
1133 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1134 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1136 static const struct statinfo
{
1139 } statinfo_hash
[] = {
1155 }, statinfo_btree
[] = {
1176 /* look up stats for DB */
1177 static int get_stats(struct vector
*v
,
1179 const struct statinfo
*si
,
1188 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1191 case DB_LOCK_DEADLOCK
:
1192 error(0, "error querying database: %s", db_strerror(err
));
1195 fatal(0, "error querying database: %s", db_strerror(err
));
1197 for(n
= 0; n
< nsi
; ++n
) {
1198 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1199 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1200 vector_append(v
, str
);
1206 /** @brief One entry in the search league */
1207 struct search_entry
{
1212 /** @brief Add a word to the search league
1213 * @param se Pointer to search league
1214 * @param count Maximum size for search league
1215 * @param nse Current size of search league
1216 * @param word New word, or NULL
1217 * @param n How often @p word appears
1218 * @return New size of search league
1220 static int register_search_entry(struct search_entry
*se
,
1227 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1228 /* Find the starting point */
1233 /* Find the insertion point */
1234 while(i
> 0 && n
> se
[i
- 1].n
)
1236 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1243 /* find the top COUNT words in the search database */
1244 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1245 struct search_entry
*se
;
1248 int err
, n
= 0, nse
= 0, i
;
1253 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1254 se
= xmalloc(count
* sizeof *se
);
1255 /* Walk across the whole database counting up the number of times each
1257 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1259 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1260 ++n
; /* same word again */
1262 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1263 word
= xstrndup(k
.data
, wl
= k
.size
);
1271 case DB_LOCK_DEADLOCK
:
1272 error(0, "error querying search database: %s", db_strerror(err
));
1275 fatal(0, "error querying search database: %s", db_strerror(err
));
1277 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1279 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1280 byte_xasprintf(&str
, "Top %d search words:", nse
);
1281 vector_append(v
, str
);
1282 for(i
= 0; i
< nse
; ++i
) {
1283 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1284 vector_append(v
, str
);
1289 #define SI(what) statinfo_##what, \
1290 sizeof statinfo_##what / sizeof (struct statinfo)
1292 /* return a list of database stats */
1293 char **trackdb_stats(int *nstatsp
) {
1299 tid
= trackdb_begin_transaction();
1301 vector_append(&v
, (char *)"Tracks database stats:");
1302 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1303 vector_append(&v
, (char *)"");
1304 vector_append(&v
, (char *)"Search database stats:");
1305 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1306 vector_append(&v
, (char *)"");
1307 vector_append(&v
, (char *)"Prefs database stats:");
1308 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1309 vector_append(&v
, (char *)"");
1310 if(search_league(&v
, 10, tid
)) goto fail
;
1311 vector_terminate(&v
);
1314 trackdb_abort_transaction(tid
);
1316 trackdb_commit_transaction(tid
);
1317 if(nstatsp
) *nstatsp
= v
.nvec
;
1321 struct stats_details
{
1322 void (*done
)(char *data
, void *u
);
1324 int exited
; /* subprocess exited */
1325 int closed
; /* pipe close */
1326 int wstat
; /* wait status from subprocess */
1327 struct dynstr data
[1]; /* data read from pipe */
1330 static void stats_complete(struct stats_details
*d
) {
1333 if(!(d
->exited
&& d
->closed
))
1335 byte_xasprintf(&s
, "\n"
1337 "track lookup cache hits: %lu\n"
1338 "track lookup cache misses: %lu\n",
1340 cache_files_misses
);
1341 dynstr_append_string(d
->data
, s
);
1342 dynstr_terminate(d
->data
);
1343 d
->done(d
->data
->vec
, d
->u
);
1346 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1347 pid_t
attribute((unused
)) pid
,
1349 const struct rusage
attribute((unused
)) *rusage
,
1351 struct stats_details
*const d
= u
;
1355 error(0, "disorder-stats %s", wstat(status
));
1360 static int stats_read(ev_source
attribute((unused
)) *ev
,
1366 struct stats_details
*const d
= u
;
1368 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1369 ev_reader_consume(reader
, bytes
);
1376 static int stats_error(ev_source
attribute((unused
)) *ev
,
1379 struct stats_details
*const d
= u
;
1381 error(errno_value
, "error reading from pipe to disorder-stats");
1387 void trackdb_stats_subprocess(ev_source
*ev
,
1388 void (*done
)(char *data
, void *u
),
1392 struct stats_details
*d
= xmalloc(sizeof *d
);
1394 dynstr_init(d
->data
);
1398 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1400 ev_child(ev
, pid
, 0, stats_finished
, d
);
1401 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1404 /** @brief Parse a track name part preference
1405 * @param name Preference name
1406 * @param partp Where to store part name
1407 * @param contextp Where to store context name
1408 * @return 0 on success, non-0 if parse fails
1410 static int trackdb__parse_namepref(const char *name
,
1414 static const char prefix
[] = "trackname_";
1416 if(strncmp(name
, prefix
, strlen(prefix
)))
1417 return -1; /* not trackname_* at all */
1418 name
+= strlen(prefix
);
1419 /* There had better be a _ between context and part */
1420 c
= strchr(name
, '_');
1423 /* Context is first in the pref name even though most APIs have the part
1424 * first. Confusing; sorry. */
1425 *contextp
= xstrndup(name
, c
- name
);
1427 /* There had better NOT be a second _ */
1430 *partp
= xstrdup(c
);
1434 /** @brief Compute the default value for a track preference
1435 * @param track Track name
1436 * @param name Preference name
1437 * @return Default value or 0 if none/not known
1439 static const char *trackdb__default(const char *track
, const char *name
) {
1440 char *context
, *part
;
1442 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1443 /* We can work out the default for a trackname_ pref */
1444 return trackname_part(track
, context
, part
);
1445 } else if(!strcmp(name
, "weight")) {
1446 /* We know the default weight */
1448 } else if(!strcmp(name
, "pick_at_random")) {
1449 /* By default everything is eligible for picking at random */
1451 } else if(!strcmp(name
, "tags")) {
1452 /* By default everything no track has any tags */
1458 /* set a pref (remove if value=0) */
1459 int trackdb_set(const char *track
,
1461 const char *value
) {
1462 struct kvp
*t
, *p
, *a
;
1465 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1468 /* If the value matches the default then unset instead, to keep the database
1469 * tidy. Older versions did not have this feature so your database may yet
1470 * have some default values stored in it. */
1472 def
= trackdb__default(track
, name
);
1473 if(def
&& !strcmp(value
, def
))
1478 tid
= trackdb_begin_transaction();
1479 if((err
= gettrackdata(track
, &t
, &p
, 0,
1480 0, tid
)) == DB_LOCK_DEADLOCK
)
1482 if(err
== DB_NOTFOUND
) break;
1483 if(name
[0] == '_') {
1484 if(kvp_set(&t
, name
, value
))
1485 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1488 /* get the old alias name */
1489 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1490 /* get the old tags */
1491 if(!strcmp(name
, "tags"))
1492 oldtags
= parsetags(kvp_get(p
, "tags"));
1494 if(kvp_set(&p
, name
, value
))
1495 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1497 /* compute the new alias name */
1498 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1499 /* check whether alias has changed */
1500 if(!(oldalias
== newalias
1501 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1502 /* adjust alias records to fit change */
1504 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1508 kvp_set(&a
, "_alias_for", track
);
1509 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1512 /* check whether tags have changed */
1513 if(!strcmp(name
, "tags")) {
1514 newtags
= parsetags(value
);
1515 while(*oldtags
|| *newtags
) {
1516 if(*oldtags
&& *newtags
) {
1517 cmp
= strcmp(*oldtags
, *newtags
);
1519 /* keeping this tag */
1523 /* old tag fits into a gap in the new list, so delete old */
1526 /* new tag fits into a gap in the old list, so insert new */
1528 } else if(*oldtags
) {
1529 /* we've run out of new tags, so remaining old ones are to be
1532 if(trackdb_delkeydata(trackdb_tagsdb
,
1533 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1537 /* we've run out of old tags, so remainig new ones are to be
1540 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1549 trackdb_abort_transaction(tid
);
1551 trackdb_commit_transaction(tid
);
1552 return err
== 0 ?
0 : -1;
1556 const char *trackdb_get(const char *track
,
1558 return kvp_get(trackdb_get_all(track
), name
);
1561 /* get all prefs as a 0-terminated array */
1562 struct kvp
*trackdb_get_all(const char *track
) {
1563 struct kvp
*t
, *p
, **pp
;
1567 tid
= trackdb_begin_transaction();
1568 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1572 trackdb_abort_transaction(tid
);
1574 trackdb_commit_transaction(tid
);
1575 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1582 const char *trackdb_resolve(const char *track
) {
1587 tid
= trackdb_begin_transaction();
1588 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1592 trackdb_abort_transaction(tid
);
1594 trackdb_commit_transaction(tid
);
1598 int trackdb_isalias(const char *track
) {
1599 const char *actual
= trackdb_resolve(track
);
1601 return strcmp(actual
, track
);
1604 /* test whether a track exists (perhaps an alias) */
1605 int trackdb_exists(const char *track
) {
1610 tid
= trackdb_begin_transaction();
1611 /* unusually, here we want the return value */
1612 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1616 trackdb_abort_transaction(tid
);
1618 trackdb_commit_transaction(tid
);
1622 /* return the list of tags */
1623 char **trackdb_alltags(void) {
1628 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1632 /** @brief List all the keys in @p db
1633 * @param db Database
1634 * @param v Vector to store keys in
1635 * @param tid Transaction ID
1636 * @return 0 or DB_LOCK_DEADLOCK
1638 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1641 DBC
*const c
= trackdb_opencursor(db
, tid
);
1644 memset(&k
, 0, sizeof k
);
1645 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1646 vector_append(v
, xstrndup(k
.data
, k
.size
));
1650 case DB_LOCK_DEADLOCK
:
1653 fatal(0, "c->c_get: %s", db_strerror(e
));
1655 if((e
= trackdb_closecursor(c
)))
1657 vector_terminate(v
);
1661 /* return 1 iff sorted tag lists A and B have at least one member in common */
1662 int tag_intersection(char **a
, char **b
) {
1665 /* Same sort of logic as trackdb_set() above */
1667 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1668 else if(cmp
< 0) ++a
;
1674 static pid_t choose_pid
= -1;
1675 static int choose_fd
;
1676 static random_callback
*choose_callback
;
1677 static struct dynstr choose_output
;
1678 static unsigned choose_complete
;
1679 static int choose_status
;
1680 #define CHOOSE_RUNNING 1
1681 #define CHOOSE_READING 2
1683 static void choose_finished(ev_source
*ev
, unsigned which
) {
1684 choose_complete
|= which
;
1685 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1688 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1689 dynstr_terminate(&choose_output
);
1690 choose_callback(ev
, xstrdup(choose_output
.vec
));
1692 choose_callback(ev
, 0);
1695 /** @brief Called when @c disorder-choose terminates */
1696 static int choose_exited(ev_source
*ev
,
1697 pid_t
attribute((unused
)) pid
,
1699 const struct rusage
attribute((unused
)) *rusage
,
1700 void attribute((unused
)) *u
) {
1702 error(0, "disorder-choose %s", wstat(status
));
1703 choose_status
= status
;
1704 choose_finished(ev
, CHOOSE_RUNNING
);
1708 /** @brief Called with data from @c disorder-choose pipe */
1709 static int choose_readable(ev_source
*ev
,
1714 void attribute((unused
)) *u
) {
1715 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1716 ev_reader_consume(reader
, bytes
);
1718 choose_finished(ev
, CHOOSE_READING
);
1722 static int choose_read_error(ev_source
*ev
,
1724 void attribute((unused
)) *u
) {
1725 error(errno_value
, "error reading disorder-choose pipe");
1726 choose_finished(ev
, CHOOSE_READING
);
1730 /** @brief Request a random track
1731 * @param ev Event source
1732 * @param callback Called with random track or NULL
1733 * @return 0 if a request was initiated, else -1
1735 * Initiates a random track choice. @p callback will later be called back with
1736 * the choice (or NULL on error). If a choice is already underway then -1 is
1737 * returned and there will be no additional callback.
1739 * The caller shouldn't assume that the track returned actually exists (it
1740 * might be removed between the choice and the callback, or between being added
1741 * to the queue and being played).
1743 int trackdb_request_random(ev_source
*ev
,
1744 random_callback
*callback
) {
1747 if(choose_pid
!= -1)
1748 return -1; /* don't run concurrent chooses */
1751 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1754 choose_callback
= callback
;
1755 choose_output
.nvec
= 0;
1756 choose_complete
= 0;
1757 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1758 "disorder-choose reader"); /* owns p[0] */
1759 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1763 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1764 * from the prefs. */
1765 static const char *getpart(const char *track
,
1766 const char *context
,
1768 const struct kvp
*p
,
1773 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1774 if((result
= kvp_get(p
, pref
)))
1777 result
= trackname_part(track
, context
, part
);
1778 assert(result
!= 0);
1782 /* get a track name part, like trackname_part(), but taking the database into
1784 const char *trackdb_getpart(const char *track
,
1785 const char *context
,
1793 /* construct the full pref */
1794 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1796 tid
= trackdb_begin_transaction();
1797 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1801 trackdb_abort_transaction(tid
);
1803 trackdb_commit_transaction(tid
);
1804 return getpart(actual
, context
, part
, p
, &used_db
);
1807 /* get the raw path name for @track@ (might be an alias) */
1808 const char *trackdb_rawpath(const char *track
) {
1814 tid
= trackdb_begin_transaction();
1815 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1819 trackdb_abort_transaction(tid
);
1821 trackdb_commit_transaction(tid
);
1822 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1826 /* trackdb_list **************************************************************/
1828 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1829 * readable at some point */
1831 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1832 * If RE is a null pointer then it matches everything. */
1833 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1841 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1842 case PCRE_ERROR_NOMATCH
: return 0;
1845 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1852 static int do_list(struct vector
*v
, const char *dir
,
1853 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1859 size_t l
, last_dir_len
= 0;
1860 char *last_dir
= 0, *track
, *alias
;
1864 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1867 /* find the first key >= dir */
1868 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1869 /* keep going while we're dealing with <dir/anything> */
1872 && ((char *)k
.data
)[dl
] == '/'
1873 && !memcmp(k
.data
, dir
, dl
)) {
1874 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1876 /* we have <dir/component/anything>, so <dir/component> is a directory */
1877 l
= ptr
- (char *)k
.data
;
1878 if(what
& trackdb_directories
)
1880 && l
== last_dir_len
1881 && !memcmp(last_dir
, k
.data
, l
))) {
1882 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1883 if(track_matches(dl
, k
.data
, l
, re
))
1884 vector_append(v
, last_dir
);
1887 /* found a plain file */
1888 if((what
& trackdb_files
)) {
1889 track
= xstrndup(k
.data
, k
.size
);
1890 if((err
= trackdb_getdata(trackdb_prefsdb
,
1891 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1893 /* if this file has an alias in the same directory then we skip it */
1894 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1896 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1897 if(track_matches(dl
, k
.data
, k
.size
, re
))
1898 vector_append(v
, track
);
1901 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1909 case DB_LOCK_DEADLOCK
:
1910 error(0, "error querying database: %s", db_strerror(err
));
1913 fatal(0, "error querying database: %s", db_strerror(err
));
1916 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1920 /* return the directories or files below @dir@ */
1921 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1929 tid
= trackdb_begin_transaction();
1932 if(do_list(&v
, dir
, what
, re
, tid
))
1935 for(n
= 0; n
< config
->collection
.n
; ++n
)
1936 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1941 trackdb_abort_transaction(tid
);
1943 trackdb_commit_transaction(tid
);
1944 vector_terminate(&v
);
1950 /* If S is tag:something, return something. Else return 0. */
1951 static const char *checktag(const char *s
) {
1952 if(!strncmp(s
, "tag:", 4))
1958 /* return a list of tracks containing all of the words given. If you
1959 * ask for only stopwords you get no tracks. */
1960 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1961 const char **w
, *best
= 0, *tag
;
1962 char **twords
, **tags
;
1964 int i
, j
, n
, err
, what
;
1974 *ntracks
= 0; /* for early returns */
1975 /* normalize all the words */
1976 w
= xmalloc(nwordlist
* sizeof (char *));
1977 istag
= xmalloc_noptr(nwordlist
);
1978 for(n
= 0; n
< nwordlist
; ++n
) {
1982 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1983 if(checktag(w
[n
])) {
1984 ++ntags
; /* count up tags */
1985 /* Normalize the tag */
1986 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
1989 /* Normalize the search term by removing combining characters */
1990 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1992 nw32
= remove_combining_chars(w32
, nw32
);
1993 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1998 /* find the longest non-stopword */
1999 for(n
= 0; n
< nwordlist
; ++n
)
2000 if(!istag
[n
] && !stopword(w
[n
]))
2001 if(!best
|| strlen(w
[n
]) > strlen(best
))
2003 /* TODO: we should at least in principal be able to identify the word or tag
2004 * with the least matches in log time, and choose that as our primary search
2006 if(ntags
&& !best
) {
2007 /* Only tags are listed. We limit to the first and narrow down with the
2009 best
= istag
[0] ? w
[0] : 0;
2010 db
= trackdb_tagsdb
;
2013 /* We can limit to some word. */
2014 db
= trackdb_searchdb
;
2017 /* Only stopwords */
2023 tid
= trackdb_begin_transaction();
2024 /* find all the tracks that have that word */
2029 cursor
= trackdb_opencursor(db
, tid
);
2030 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2031 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2038 case DB_LOCK_DEADLOCK
:
2039 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2042 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2044 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2046 /* do a naive search over that (hopefuly fairly small) list of tracks */
2048 for(n
= 0; n
< v
.nvec
; ++n
) {
2049 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2052 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2055 twords
= track_to_words(v
.vec
[n
], p
);
2056 tags
= parsetags(kvp_get(p
, "tags"));
2057 for(i
= 0; i
< nwordlist
; ++i
) {
2060 /* Track must have this tag */
2061 for(j
= 0; tags
[j
]; ++j
)
2062 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2063 if(!tags
[j
]) break; /* tag not found */
2065 /* Track must contain this word */
2066 for(j
= 0; twords
[j
]; ++j
)
2067 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2068 if(!twords
[j
]) break; /* word not found */
2071 if(i
>= nwordlist
) /* all words found */
2072 vector_append(&u
, v
.vec
[n
]);
2076 trackdb_closecursor(cursor
);
2078 trackdb_abort_transaction(tid
);
2079 info("retrying search");
2081 trackdb_commit_transaction(tid
);
2082 vector_terminate(&u
);
2088 /* trackdb_scan **************************************************************/
2090 int trackdb_scan(const char *root
,
2091 int (*callback
)(const char *track
,
2100 const size_t root_len
= root ?
strlen(root
) : 0;
2102 struct kvp
*data
, *prefs
;
2105 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2107 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2110 memset(&k
, 0, sizeof k
);
2111 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2116 || (k
.size
> root_len
2117 && !strncmp(k
.data
, root
, root_len
)
2118 && ((char *)k
.data
)[root_len
] == '/')) {
2119 data
= kvp_urldecode(d
.data
, d
.size
);
2120 if(kvp_get(data
, "_path")) {
2121 track
= xstrndup(k
.data
, k
.size
);
2122 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2123 * do a lookup for every single track. In fact this is quite quick:
2124 * with around 10,000 tracks a complete scan is around 0.3s on my
2125 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2126 * linear walk as we already do over trackdb_tracksdb, and probably get
2127 * even higher performance. That would require upgrade logic to
2128 * translate old databases though.
2130 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2131 prepare_data(&pd
), 0)) {
2133 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2138 case DB_LOCK_DEADLOCK
:
2139 error(0, "getting prefs: %s", db_strerror(err
));
2140 trackdb_closecursor(cursor
);
2143 fatal(0, "getting prefs: %s", db_strerror(err
));
2145 /* Advance to the next track before the callback so that the callback
2146 * may safely delete the track */
2147 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2148 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2153 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2157 trackdb_closecursor(cursor
);
2164 case DB_LOCK_DEADLOCK
:
2165 error(0, "c->c_get: %s", db_strerror(err
));
2168 fatal(0, "c->c_get: %s", db_strerror(err
));
2172 /* trackdb_rescan ************************************************************/
2174 /** @brief Node in the list of rescan-complete callbacks */
2175 struct rescanned_node
{
2176 struct rescanned_node
*next
;
2177 void (*rescanned
)(void *ru
);
2181 /** @brief List of rescan-complete callbacks */
2182 static struct rescanned_node
*rescanned_list
;
2184 /** @brief Add a rescan completion callback */
2185 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2188 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2189 n
->next
= rescanned_list
;
2190 n
->rescanned
= rescanned
;
2196 /* called when the rescanner terminates */
2197 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2200 const struct rusage
attribute((unused
)) *rusage
,
2201 void attribute((unused
)) *u
) {
2202 if(pid
== rescan_pid
) rescan_pid
= -1;
2204 error(0, RESCAN
": %s", wstat(status
));
2206 D((RESCAN
" terminated: %s", wstat(status
)));
2207 /* Our cache of file lookups is out of date now */
2208 cache_clean(&cache_files_type
);
2209 eventlog("rescanned", (char *)0);
2210 /* Call rescanned callbacks */
2211 while(rescanned_list
) {
2212 void (*rescanned
)(void *u
) = rescanned_list
->rescanned
;
2213 void *ru
= rescanned_list
->ru
;
2215 rescanned_list
= rescanned_list
->next
;
2221 /** @brief Initiate a rescan
2222 * @param ev Event loop or 0 to block
2223 * @param recheck 1 to recheck lengths, 0 to suppress check
2224 * @param rescanned Called on completion (if not NULL)
2225 * @param u Passed to @p rescanned
2227 void trackdb_rescan(ev_source
*ev
, int recheck
,
2228 void (*rescanned
)(void *ru
),
2232 if(rescan_pid
!= -1) {
2233 trackdb_add_rescanned(rescanned
, ru
);
2234 error(0, "rescan already underway");
2237 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2238 recheck ?
"--check" : "--no-check",
2240 trackdb_add_rescanned(rescanned
, ru
);
2242 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2243 D(("started rescanner"));
2245 /* This is the first rescan, we block until it is complete */
2246 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2248 reap_rescan(0, rescan_pid
, w
, 0, 0);
2252 int trackdb_rescan_cancel(void) {
2253 if(rescan_pid
== -1) return 0;
2254 if(kill(rescan_pid
, SIGTERM
) < 0)
2255 fatal(errno
, "error killing rescanner");
2260 /** @brief Return true if a rescan is underway */
2261 int trackdb_rescan_underway(void) {
2262 return rescan_pid
!= -1;
2265 /* global prefs **************************************************************/
2267 void trackdb_set_global(const char *name
,
2275 tid
= trackdb_begin_transaction();
2276 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2278 trackdb_abort_transaction(tid
);
2280 trackdb_commit_transaction(tid
);
2281 /* log important state changes */
2282 if(!strcmp(name
, "playing")) {
2283 state
= !value
|| !strcmp(value
, "yes");
2284 info("playing %s by %s",
2285 state ?
"enabled" : "disabled",
2287 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2289 if(!strcmp(name
, "random-play")) {
2290 state
= !value
|| !strcmp(value
, "yes");
2291 info("random play %s by %s",
2292 state ?
"enabled" : "disabled",
2294 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2298 int trackdb_set_global_tid(const char *name
,
2304 memset(&k
, 0, sizeof k
);
2305 memset(&d
, 0, sizeof d
);
2306 k
.data
= (void *)name
;
2307 k
.size
= strlen(name
);
2309 d
.data
= (void *)value
;
2310 d
.size
= strlen(value
);
2313 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2315 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2316 if(err
== DB_LOCK_DEADLOCK
) return err
;
2318 fatal(0, "error updating database: %s", db_strerror(err
));
2322 const char *trackdb_get_global(const char *name
) {
2328 tid
= trackdb_begin_transaction();
2329 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2331 trackdb_abort_transaction(tid
);
2333 trackdb_commit_transaction(tid
);
2337 int trackdb_get_global_tid(const char *name
,
2343 memset(&k
, 0, sizeof k
);
2344 k
.data
= (void *)name
;
2345 k
.size
= strlen(name
);
2346 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2347 prepare_data(&d
), 0)) {
2349 *rp
= xstrndup(d
.data
, d
.size
);
2354 case DB_LOCK_DEADLOCK
:
2357 fatal(0, "error reading database: %s", db_strerror(err
));
2361 /** @brief Retrieve the most recently added tracks
2362 * @param ntracksp Where to put count, or 0
2363 * @param maxtracks Maximum number of tracks to retrieve
2364 * @return null-terminated array of track names
2366 * The most recently added track is first in the array.
2368 char **trackdb_new(int *ntracksp
,
2374 tid
= trackdb_begin_transaction();
2375 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2378 trackdb_abort_transaction(tid
);
2380 trackdb_commit_transaction(tid
);
2384 /** @brief Retrieve the most recently added tracks
2385 * @param ntracksp Where to put count, or 0
2386 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2387 * @param tid Transaction ID
2388 * @return null-terminated array of track names, or NULL on deadlock
2390 * The most recently added track is first in the array.
2392 static char **trackdb_new_tid(int *ntracksp
,
2398 struct vector tracks
[1];
2400 vector_init(tracks
);
2401 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2402 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2403 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2404 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2406 case 0: /* hit maxtracks */
2407 case DB_NOTFOUND
: /* ran out of tracks */
2409 case DB_LOCK_DEADLOCK
:
2410 trackdb_closecursor(c
);
2413 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2415 if((err
= trackdb_closecursor(c
)))
2416 return 0; /* deadlock */
2417 vector_terminate(tracks
);
2419 *ntracksp
= tracks
->nvec
;
2423 /** @brief Expire noticed.db
2424 * @param earliest Earliest timestamp to keep
2426 void trackdb_expire_noticed(time_t earliest
) {
2430 tid
= trackdb_begin_transaction();
2431 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2433 trackdb_abort_transaction(tid
);
2435 trackdb_commit_transaction(tid
);
2438 /** @brief Expire noticed.db
2439 * @param earliest Earliest timestamp to keep
2440 * @param tid Transaction ID
2441 * @return 0 or DB_LOCK_DEADLOCK
2443 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2451 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2452 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2454 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2455 if(when
>= earliest
)
2457 if((err
= c
->c_del(c
, 0))) {
2458 if(err
!= DB_LOCK_DEADLOCK
)
2459 fatal(0, "error deleting expired noticed.db entry: %s",
2465 if(err
== DB_NOTFOUND
)
2467 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2468 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2470 if((err
= trackdb_closecursor(c
))) {
2471 if(err
!= DB_LOCK_DEADLOCK
)
2472 fatal(0, "error closing cursor: %s", db_strerror(err
));
2476 info("expired %d tracks from noticed.db", count
);
2480 /* tidying up ****************************************************************/
2482 void trackdb_gc(void) {
2486 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2487 config
->checkpoint_kbyte
,
2488 config
->checkpoint_min
,
2490 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2491 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2492 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2493 /* This makes catastrophic recovery impossible. However, the user can still
2494 * preserve the important data by using disorder-dump to snapshot their
2495 * prefs, and later to restore it. This is likely to have much small
2496 * long-term storage requirements than record the db logfiles. */
2499 /* user database *************************************************************/
2501 /** @brief Return true if @p user is trusted */
2502 static int trusted(const char *user
) {
2505 for(n
= 0; (n
< config
->trust
.n
2506 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2508 return n
< config
->trust
.n
;
2511 /** @brief Return non-zero for a valid username
2513 * Currently we only allow the letters and digits in ASCII. We could be more
2514 * liberal than this but it is a nice simple test. It is critical that
2515 * semicolons are never allowed.
2517 static int valid_username(const char *user
) {
2521 const uint8_t c
= *user
++;
2522 /* For now we are very strict */
2523 if((c
>= 'a' && c
<= 'z')
2524 || (c
>= 'A' && c
<= 'Z')
2525 || (c
>= '0' && c
<= '9'))
2533 /** @brief Add a user */
2534 static int create_user(const char *user
,
2535 const char *password
,
2538 const char *confirmation
,
2544 /* sanity check user */
2545 if(!valid_username(user
)) {
2546 error(0, "invalid username '%s'", user
);
2549 if(parse_rights(rights
, 0, 1)) {
2550 error(0, "invalid rights string");
2553 /* data for this user */
2555 kvp_set(&k
, "password", password
);
2556 kvp_set(&k
, "rights", rights
);
2558 kvp_set(&k
, "email", email
);
2560 kvp_set(&k
, "confirmation", confirmation
);
2561 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2562 kvp_set(&k
, "created", s
);
2563 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2566 /** @brief Add one pre-existing user */
2567 static int one_old_user(const char *user
, const char *password
,
2571 /* www-data doesn't get added */
2572 if(!strcmp(user
, "www-data")) {
2573 info("not adding www-data to user database");
2577 if(!strcmp(user
, "root"))
2579 else if(trusted(user
)) {
2582 parse_rights(config
->default_rights
, &r
, 1);
2583 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2584 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2585 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2586 rights
= rights_string(r
);
2588 rights
= config
->default_rights
;
2589 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2590 tid
, DB_NOOVERWRITE
);
2593 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2596 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2597 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2600 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2603 error(0, "user %s already exists, delete 'allow' directive",
2604 config
->allow
.s
[n
].s
[0]);
2605 /* This won't ever become fatal - eventually 'allow' will be
2608 case DB_LOCK_DEADLOCK
:
2609 return DB_LOCK_DEADLOCK
;
2615 /** @brief Read old 'allow' directives and copy them to the users database */
2616 void trackdb_old_users(void) {
2620 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2623 /** @brief Create a root user in the user database if there is none */
2624 void trackdb_create_root(void) {
2629 /* Choose a new root password */
2630 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2631 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2632 /* Create the root user if it does not exist */
2633 WITH_TRANSACTION(create_user("root", pw
, "all",
2634 0/*email*/, 0/*confirmation*/,
2635 tid
, DB_NOOVERWRITE
));
2637 info("created root user");
2640 /** @brief Find a user's password from the database
2641 * @param user Username
2642 * @return Password or NULL
2644 * Only works if running as a user that can read the database!
2646 * If the user exists but has no password, "" is returned.
2648 const char *trackdb_get_password(const char *user
) {
2651 const char *password
;
2653 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2656 password
= kvp_get(k
, "password");
2657 return password ? password
: "";
2660 /** @brief Add a new user
2661 * @param user Username
2662 * @param password Password or NULL
2663 * @param rights Initial rights
2664 * @param email Email address or NULL
2665 * @param confirmation Confirmation string or NULL
2666 * @return 0 on success, non-0 on error
2668 int trackdb_adduser(const char *user
,
2669 const char *password
,
2672 const char *confirmation
) {
2675 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2676 tid
, DB_NOOVERWRITE
));
2678 error(0, "cannot create user '%s' because they already exist", user
);
2682 info("created user '%s' with rights '%s' and email address '%s'",
2683 user
, rights
, email
);
2685 info("created user '%s' with rights '%s'", user
, rights
);
2690 /** @brief Delete a user
2691 * @param user User to delete
2692 * @return 0 on success, non-0 if the user didn't exist anyway
2694 int trackdb_deluser(const char *user
) {
2697 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2699 error(0, "cannot delete user '%s' because they do not exist", user
);
2702 info("deleted user '%s'", user
);
2706 /** @brief Get user information
2707 * @param user User to query
2708 * @return Linked list of user information or NULL if user does not exist
2710 * Every user has at least a @c rights entry so NULL can be used to mean no
2713 struct kvp
*trackdb_getuserinfo(const char *user
) {
2717 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2724 /** @brief Edit user information
2725 * @param user User to edit
2726 * @param key Key to change
2727 * @param value Value to set, or NULL to remove
2728 * @param tid Transaction ID
2729 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2731 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2732 const char *value
, DB_TXN
*tid
) {
2736 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2738 if(!kvp_set(&k
, key
, value
))
2739 return 0; /* no change */
2740 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2743 /** @brief Edit user information
2744 * @param user User to edit
2745 * @param key Key to change
2746 * @param value Value to set, or NULL to remove
2747 * @return 0 on success, non-0 on error
2749 int trackdb_edituserinfo(const char *user
,
2750 const char *key
, const char *value
) {
2753 if(!strcmp(key
, "rights")) {
2755 error(0, "cannot remove 'rights' key from user '%s'", user
);
2758 if(parse_rights(value
, 0, 1)) {
2759 error(0, "invalid rights string");
2762 } else if(!strcmp(key
, "email")) {
2764 if(!strchr(value
, '@')) {
2765 error(0, "invalid email address '%s' for user '%s'", user
, value
);
2769 value
= 0; /* no email -> remove key */
2770 } else if(!strcmp(key
, "created")) {
2771 error(0, "cannot change creation date for user '%s'", user
);
2773 } else if(strcmp(key
, "password")
2774 && !strcmp(key
, "confirmation")) {
2775 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2778 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2780 error(0, "unknown user '%s'", user
);
2786 /** @brief List all users
2787 * @return NULL-terminated list of users
2789 char **trackdb_listusers(void) {
2794 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2798 /** @brief Confirm a user registration
2799 * @param user Username
2800 * @param confirmation Confirmation string
2801 * @param rightsp Where to put user rights
2802 * @param tid Transaction ID
2803 * @return 0 on success, non-0 on error
2805 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2806 rights_type
*rightsp
,
2808 const char *stored_confirmation
;
2813 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2815 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2816 error(0, "already confirmed user '%s'", user
);
2817 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2820 if(!(rights
= kvp_get(k
, "rights"))) {
2821 error(0, "no rights for unconfirmed user '%s'", user
);
2824 if(parse_rights(rights
, rightsp
, 1))
2826 if(strcmp(confirmation
, stored_confirmation
)) {
2827 error(0, "wrong confirmation string for user '%s'", user
);
2831 kvp_set(&k
, "confirmation", 0);
2832 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2835 /** @brief Confirm a user registration
2836 * @param user Username
2837 * @param confirmation Confirmation string
2838 * @param rightsp Where to put user rights
2839 * @return 0 on success, non-0 on error
2841 int trackdb_confirm(const char *user
, const char *confirmation
,
2842 rights_type
*rightsp
) {
2845 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2848 info("registration confirmed for user '%s'", user
);
2851 error(0, "confirmation for nonexistent user '%s'", user
);
2853 default: /* already reported */
2863 indent-tabs-mode:nil