2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/trackdb.c
21 * @brief Track database
23 * This file is getting in desparate need of splitting up...
29 #include <sys/socket.h>
35 #include <sys/resource.h>
37 #include <arpa/inet.h>
49 #include "configuration.h"
54 #include "trackname.h"
55 #include "trackdb-int.h"
65 #define RESCAN "disorder-rescan"
66 #define DEADLOCK "disorder-deadlock"
68 static const char *getpart(const char *track
,
73 static char **trackdb_new_tid(int *ntracksp
,
76 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
77 static char *normalize_tag(const char *s
, size_t ns
);
79 const struct cache_type cache_files_type
= { 86400 };
80 unsigned long cache_files_hits
, cache_files_misses
;
82 /** @brief Set by trackdb_open() */
83 int trackdb_existing_database
;
85 /* setup and teardown ********************************************************/
87 static const char *home
; /* home had better not change */
88 DB_ENV
*trackdb_env
; /* db environment */
90 /** @brief The tracks database
91 * - Keys are UTF-8(NFC(unicode(path name)))
92 * - Values are encoded key-value pairs
93 * - Data is reconstructable data about tracks that currently exist
97 /** @brief The preferences database
99 * - Keys are UTF-8(NFC(unicode(path name)))
100 * - Values are encoded key-value pairs
101 * - Data is user data about tracks (that might not exist any more)
102 * and cannot be reconstructed
106 /** @brief The search database
108 * - Keys are UTF-8(NFKC(casefold(search term)))
109 * - Values are UTF-8(NFC(unicode(path name)))
110 * - There can be more than one value per key
111 * - Presence of key,value means that path matches the search terms
112 * - Only tracks fond in @ref trackdb_tracksdb are represented here
113 * - This database can be reconstructed, it contains no user data
115 DB
*trackdb_searchdb
;
117 /** @brief The tags database
119 * - Keys are UTF-8(NFKC(casefold(tag)))
120 * - Values are UTF-8(NFC(unicode(path name)))
121 * - There can be more than one value per key
122 * - Presence of key,value means that path matches the tag
123 * - This is always in sync with the tags preference
124 * - This database can be reconstructed, it contains no user data
126 DB
*trackdb_tagsdb
; /* the tags database */
128 /** @brief The global preferences database
129 * - Keys are UTF-8(NFC(preference))
130 * - Values are global preference values
131 * - Data is user data and cannot be reconstructed
133 DB
*trackdb_globaldb
; /* global preferences */
135 /** @brief The noticed database
136 * - Keys are 64-bit big-endian timestamps
137 * - Values are UTF-8(NFC(unicode(path name)))
138 * - There can be more than one value per key
139 * - Presence of key,value means that path was added at the given time
140 * - Data cannot be reconstructed (but isn't THAT important)
142 DB
*trackdb_noticeddb
; /* when track noticed */
144 /** @brief The schedule database
146 * - Keys are ID strings, generated at random
147 * - Values are encoded key-value pairs
148 * - There can be more than one value per key
149 * - Data cannot be reconstructed
151 * See @ref server/schedule.c for further information.
153 DB
*trackdb_scheduledb
;
155 /** @brief The user database
156 * - Keys are usernames
157 * - Values are encoded key-value pairs
158 * - Data is user data and cannot be reconstructed
162 /** @brief The playlists database
163 * - Keys are playlist names
164 * - Values are encoded key-value pairs
165 * - Data is user data and cannot be reconstructed
167 DB
*trackdb_playlistsdb
;
169 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
170 static pid_t rescan_pid
= -1; /* rescanner PID */
171 static int initialized
, opened
; /* state */
173 /* comparison function for keys */
174 static int compare(DB
attribute((unused
)) *db_
,
175 const DBT
*a
, const DBT
*b
) {
176 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
179 /** @brief Test whether the track database can be read
180 * @return 1 if it can, 0 if it cannot
182 int trackdb_readable(void) {
185 byte_xasprintf(&usersdb
, "%s/users.db", config
->home
);
186 return access(usersdb
, R_OK
) == 0;
189 /** @brief Open database environment
190 * @param flags Flags word
192 * Flags should be one of:
193 * - @ref TRACKDB_NO_RECOVER
194 * - @ref TRACKDB_NORMAL_RECOVER
195 * - @ref TRACKDB_FATAL_RECOVER
196 * - @ref TRACKDB_MAY_CREATE
198 void trackdb_init(int flags
) {
200 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
201 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
204 assert(initialized
== 0);
207 if(strcmp(home
, config
->home
))
208 fatal(0, "cannot change db home without server restart");
212 if(flags
& TRACKDB_MAY_CREATE
) {
218 /* Remove world/group permissions on any regular files already in the
219 * database directory. Actually we don't care about all of them but it's
220 * easier to just do the lot. This can be revisited if it's a serious
221 * practical inconvenience for anyone.
223 * The socket, not being a regular file, is excepted.
225 if(!(dp
= opendir(config
->home
)))
226 fatal(errno
, "error reading %s", config
->home
);
227 while((de
= readdir(dp
))) {
228 byte_xasprintf(&p
, "%s/%s", config
->home
, de
->d_name
);
229 if(lstat(p
, &st
) == 0
230 && S_ISREG(st
.st_mode
)
231 && (st
.st_mode
& 077)) {
232 if(chmod(p
, st
.st_mode
& 07700) < 0)
233 fatal(errno
, "cannot chmod %s", p
);
240 /* create environment */
241 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
243 if((err
= trackdb_env
->set_alloc(trackdb_env
,
244 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
245 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
246 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
247 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
248 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
249 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
250 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
256 |recover_type
[recover
],
258 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
259 trackdb_env
->set_errpfx(trackdb_env
, "DB");
260 trackdb_env
->set_errfile(trackdb_env
, stderr
);
261 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
262 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
263 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
264 D(("initialized database environment"));
267 /* called when deadlock manager terminates */
268 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
269 pid_t
attribute((unused
)) pid
,
271 const struct rusage
attribute((unused
)) *rusage
,
272 void attribute((unused
)) *u
) {
273 db_deadlock_pid
= -1;
275 fatal(0, "deadlock manager unexpectedly terminated: %s",
278 D(("deadlock manager terminated: %s", wstat(status
)));
282 static pid_t
subprogram(ev_source
*ev
, int outputfd
, const char *prog
,
286 const char *args
[1024], **argp
, *a
;
290 *argp
++ = "--config";
291 *argp
++ = configfile
;
292 *argp
++ = debugging ?
"--debug" : "--no-debug";
293 *argp
++ = log_default
== &log_syslog ?
"--syslog" : "--no-syslog";
295 while((a
= va_arg(ap
, const char *)))
299 /* If we're in the background then trap subprocess stdout/stderr */
300 if(!(pid
= xfork())) {
303 ev_signal_atfork(ev
);
304 signal(SIGPIPE
, SIG_DFL
);
309 /* ensure we don't leak privilege anywhere */
310 if(setuid(geteuid()) < 0)
311 fatal(errno
, "error calling setuid");
312 /* If we were negatively niced, undo it. We don't bother checking for
313 * error, it's not that important. */
314 setpriority(PRIO_PROCESS
, 0, 0);
315 execvp(prog
, (char **)args
);
316 fatal(errno
, "error invoking %s", prog
);
321 /* start deadlock manager */
322 void trackdb_master(ev_source
*ev
) {
323 assert(db_deadlock_pid
== -1);
324 db_deadlock_pid
= subprogram(ev
, -1, DEADLOCK
, (char *)0);
325 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
326 D(("started deadlock manager"));
329 /* close environment */
330 void trackdb_deinit(void) {
334 assert(initialized
== 1);
337 /* close the environment */
338 if((err
= trackdb_env
->close(trackdb_env
, 0)))
339 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
341 if(rescan_pid
!= -1) {
342 /* shut down the rescanner */
343 if(kill(rescan_pid
, SIGTERM
) < 0)
344 fatal(errno
, "error killing rescanner");
345 /* wait for the rescanner to finish */
346 while(waitpid(rescan_pid
, &err
, 0) == -1 && errno
== EINTR
)
350 /* TODO kill any stats subprocesses */
352 /* finally terminate the deadlock manager */
353 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
354 fatal(errno
, "error killing deadlock manager");
355 db_deadlock_pid
= -1;
357 D(("deinitialized database environment"));
360 /* open a specific database */
361 static DB
*open_db(const char *path
,
369 D(("open %s", path
));
370 path
= config_get_file(path
);
371 if((err
= db_create(&db
, trackdb_env
, 0)))
372 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
374 if((err
= db
->set_flags(db
, dbflags
)))
375 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
376 if(dbtype
== DB_BTREE
)
377 if((err
= db
->set_bt_compare(db
, compare
)))
378 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
379 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
380 openflags
| DB_AUTO_COMMIT
, mode
))) {
381 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
382 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
389 /** @brief Open track databases
390 * @param flags Flags flags word
392 * @p flags should have one of:
393 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
394 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
395 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
397 * - @p TRACKDB_READ_ONLY, read only access
399 void trackdb_open(int flags
) {
402 uint32_t dbflags
= flags
& TRACKDB_READ_ONLY ? DB_RDONLY
: DB_CREATE
;
407 /* check the database version first */
408 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_RDONLY
, 0666);
409 if(trackdb_globaldb
) {
410 /* This is an existing database */
414 s
= trackdb_get_global("_dbversion");
415 /* Close the database again, we'll open it property below */
416 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
417 fatal(0, "error closing global.db: %s", db_strerror(err
));
418 trackdb_globaldb
= 0;
419 /* Convert version string to an integer */
420 oldversion
= s ?
atol(s
) : 1;
421 if(oldversion
> config
->dbversion
) {
422 /* Database is from the future; we never allow this. */
423 fatal(0, "this version of DisOrder is too old for database version %ld",
426 if(oldversion
< config
->dbversion
) {
427 /* Database version is out of date */
428 switch(flags
& TRACKDB_UPGRADE_MASK
) {
429 case TRACKDB_NO_UPGRADE
:
430 /* This database needs upgrading but this is not permitted */
431 fatal(0, "database needs upgrading from %ld to %ld",
432 oldversion
, config
->dbversion
);
433 case TRACKDB_CAN_UPGRADE
:
434 /* This database needs upgrading */
435 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
436 oldversion
, config
->dbversion
);
437 pid
= subprogram(0, -1, "disorder-dbupgrade", (char *)0);
438 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
441 fatal(0, "disorder-dbupgrade %s", wstat(err
));
442 info("disorder-dbupgrade succeeded");
444 case TRACKDB_OPEN_FOR_UPGRADE
:
450 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
451 /* This doesn't make any sense */
452 fatal(0, "database is already at current version");
454 trackdb_existing_database
= 1;
456 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
457 /* Cannot upgrade a new database */
458 fatal(0, "cannot upgrade a database that does not exist");
460 /* This is a brand new database */
461 trackdb_existing_database
= 0;
463 /* open the databases */
464 if(!(trackdb_usersdb
= open_db("users.db",
465 0, DB_HASH
, dbflags
, 0600)))
466 fatal(0, "cannot open users.db");
467 trackdb_tracksdb
= open_db("tracks.db",
468 DB_RECNUM
, DB_BTREE
, dbflags
, 0666);
469 trackdb_searchdb
= open_db("search.db",
470 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
471 trackdb_tagsdb
= open_db("tags.db",
472 DB_DUP
|DB_DUPSORT
, DB_HASH
, dbflags
, 0666);
473 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, dbflags
, 0666);
474 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, dbflags
, 0666);
475 trackdb_noticeddb
= open_db("noticed.db",
476 DB_DUPSORT
, DB_BTREE
, dbflags
, 0666);
477 trackdb_scheduledb
= open_db("schedule.db", 0, DB_HASH
, dbflags
, 0666);
478 trackdb_playlistsdb
= open_db("playlists.db", 0, DB_HASH
, dbflags
, 0666);
479 if(!trackdb_existing_database
) {
480 /* Stash the database version */
483 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
484 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
485 trackdb_set_global("_dbversion", buf
, 0);
487 D(("opened databases"));
490 /* close track databases */
491 void trackdb_close(void) {
497 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
498 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
499 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
500 fatal(0, "error closing search.db: %s", db_strerror(err
));
501 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
502 fatal(0, "error closing tags.db: %s", db_strerror(err
));
503 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
504 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
505 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
506 fatal(0, "error closing global.db: %s", db_strerror(err
));
507 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
508 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
509 if((err
= trackdb_scheduledb
->close(trackdb_scheduledb
, 0)))
510 fatal(0, "error closing schedule.db: %s", db_strerror(err
));
511 if((err
= trackdb_usersdb
->close(trackdb_usersdb
, 0)))
512 fatal(0, "error closing users.db: %s", db_strerror(err
));
513 if((err
= trackdb_playlistsdb
->close(trackdb_playlistsdb
, 0)))
514 fatal(0, "error closing playlists.db: %s", db_strerror(err
));
515 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
516 trackdb_tagsdb
= trackdb_globaldb
= 0;
517 D(("closed databases"));
520 /* generic db routines *******************************************************/
522 /** @brief Fetch and decode a database entry
524 * @param track Track name
525 * @param kp Where to put decoded list (or NULL if you don't care)
526 * @param tid Owning transaction
527 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
529 int trackdb_getdata(DB
*db
,
536 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
537 prepare_data(&data
), 0)) {
540 *kp
= kvp_urldecode(data
.data
, data
.size
);
546 case DB_LOCK_DEADLOCK
:
547 error(0, "error querying database: %s", db_strerror(err
));
550 fatal(0, "error querying database: %s", db_strerror(err
));
554 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
555 * DB_LOCK_DEADLOCK. */
556 int trackdb_putdata(DB
*db
,
564 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
565 encode_data(&data
, k
), flags
)) {
569 case DB_LOCK_DEADLOCK
:
570 error(0, "error updating database: %s", db_strerror(err
));
573 fatal(0, "error updating database: %s", db_strerror(err
));
577 /** @brief Delete a database entry
579 * @param track Key to delete
580 * @param tid Transaction ID
581 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
583 int trackdb_delkey(DB
*db
,
589 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
593 case DB_LOCK_DEADLOCK
:
594 error(0, "error updating database: %s", db_strerror(err
));
597 fatal(0, "error updating database: %s", db_strerror(err
));
601 /* open a database cursor */
602 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
606 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
608 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
613 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
614 int trackdb_closecursor(DBC
*c
) {
618 switch(err
= c
->c_close(c
)) {
621 case DB_LOCK_DEADLOCK
:
622 error(0, "error closing cursor: %s", db_strerror(err
));
625 fatal(0, "error closing cursor: %s", db_strerror(err
));
629 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
630 int trackdb_delkeydata(DB
*db
,
638 c
= trackdb_opencursor(db
, tid
);
639 switch(err
= c
->c_get(c
, make_key(&key
, word
),
640 make_key(&data
, track
), DB_GET_BOTH
)) {
642 switch(err
= c
->c_del(c
, 0)) {
648 case DB_LOCK_DEADLOCK
:
649 error(0, "error updating database: %s", db_strerror(err
));
652 fatal(0, "c->c_del: %s", db_strerror(err
));
657 case DB_LOCK_DEADLOCK
:
658 error(0, "error updating database: %s", db_strerror(err
));
661 fatal(0, "c->c_get: %s", db_strerror(err
));
663 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
667 /* start a transaction */
668 DB_TXN
*trackdb_begin_transaction(void) {
672 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
673 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
677 /* abort transaction */
678 void trackdb_abort_transaction(DB_TXN
*tid
) {
682 if((err
= tid
->abort(tid
)))
683 fatal(0, "tid->abort: %s", db_strerror(err
));
686 /* commit transaction */
687 void trackdb_commit_transaction(DB_TXN
*tid
) {
690 if((err
= tid
->commit(tid
, 0)))
691 fatal(0, "tid->commit: %s", db_strerror(err
));
694 /* search/tags shared code ***************************************************/
696 /* comparison function used by dedupe() */
697 static int wordcmp(const void *a
, const void *b
) {
698 return strcmp(*(const char **)a
, *(const char **)b
);
701 /* sort and de-dupe VEC */
702 static char **dedupe(char **vec
, int nvec
) {
705 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
709 for(n
= 1; n
< nvec
; ++n
)
710 if(strcmp(vec
[n
], vec
[m
- 1]))
717 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
718 static int register_word(DB
*db
, const char *what
,
719 const char *track
, const char *word
,
724 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
725 make_key(&data
, track
), DB_NODUPDATA
)) {
729 case DB_LOCK_DEADLOCK
:
730 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
733 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
737 /* search primitives *********************************************************/
739 /* return true iff NAME is a trackname_display_ pref */
740 static int is_display_pref(const char *name
) {
741 static const char prefix
[] = "trackname_display_";
742 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
745 /** @brief Word_Break property tailor that treats underscores as spaces */
746 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
750 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
751 return unicode_Word_Break_Other
;
755 /** @brief Remove all combining characters in-place
756 * @param s Pointer to start of string
757 * @param ns Length of string
758 * @return New, possiblby reduced, length
760 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
761 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
764 const uint32_t c
= *s
++;
765 if(!utf32_combining_class(c
))
771 /** @brief Normalize and split a string using a given tailoring */
772 static void word_split(struct vector
*v
,
774 unicode_property_tailor
*pt
) {
776 uint32_t *t32
, **w32
;
778 /* Convert to UTF-32 */
779 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
781 /* Erase case distinctions */
782 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
784 /* Drop combining characters */
785 nt32
= remove_combining_chars(t32
, nt32
);
786 /* Split into words, treating _ as a space */
787 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
788 /* Convert words back to UTF-8 and append to result */
789 for(i
= 0; i
< nw
; ++i
)
790 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
793 /** @brief Normalize a tag
795 * @param ns Length of tag
796 * @return Normalized string or NULL on error
798 * The return value will be:
800 * - have no leading or trailing space
801 * - have no combining characters
802 * - all spacing between words will be a single U+0020 SPACE
804 static char *normalize_tag(const char *s
, size_t ns
) {
805 uint32_t *s32
, **w32
;
806 size_t ns32
, nw32
, i
;
809 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
811 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
813 ns32
= remove_combining_chars(s32
, ns32
);
814 /* Split into words, no Word_Break tailoring */
815 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
816 /* Compose back into a string */
818 for(i
= 0; i
< nw32
; ++i
) {
820 dynstr_append(d
, ' ');
821 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
827 /* compute the words of a track name */
828 static char **track_to_words(const char *track
,
829 const struct kvp
*p
) {
831 const char *rootless
= track_rootless(track
);
834 rootless
= track
; /* bodge */
836 rootless
= strip_extension(rootless
);
837 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
838 for(; p
; p
= p
->next
)
839 if(is_display_pref(p
->name
))
840 word_split(&v
, p
->value
, 0);
841 vector_terminate(&v
);
842 return dedupe(v
.vec
, v
.nvec
);
845 /* return nonzero iff WORD is a stopword */
846 static int stopword(const char *word
) {
849 for(n
= 0; n
< config
->stopword
.n
850 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
852 return n
< config
->stopword
.n
;
855 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
856 static int register_search_word(const char *track
, const char *word
,
858 if(stopword(word
)) return 0;
859 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
862 /* Tags **********************************************************************/
864 /* Return nonzero if C is a valid tag character */
865 static int tagchar(int c
) {
874 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
875 char **parsetags(const char *s
) {
881 /* skip initial separators */
882 while(*s
&& (!tagchar(*s
) || *s
== ' '))
885 /* find the extent of the tag */
887 while(*s
&& tagchar(*s
))
889 /* strip trailing spaces */
890 while(s
> t
&& s
[-1] == ' ')
892 /* add tag to list */
893 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
894 /* skip intermediate and trailing separators */
895 while(*s
&& (!tagchar(*s
) || *s
== ' '))
899 vector_terminate(&v
);
900 return dedupe(v
.vec
, v
.nvec
);
903 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
904 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
905 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
908 /* aliases *******************************************************************/
910 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
911 * there is no alias sets *aliasp to 0. */
912 static int compute_alias(char **aliasp
,
917 const char *s
= config
->alias
, *t
, *expansion
, *part
;
918 int c
, used_db
= 0, slash_prefix
, err
;
920 const char *const root
= find_track_root(track
);
923 /* Bodge for tracks with no root */
928 dynstr_append_string(&d
, root
);
929 while((c
= (unsigned char)*s
++)) {
931 dynstr_append(&d
, c
);
934 if((slash_prefix
= (*s
== '/')))
937 assert(t
!= 0); /* validated at startup */
938 part
= xstrndup(s
, t
- s
);
939 expansion
= getpart(track
, "display", part
, p
, &used_db
);
941 if(slash_prefix
) dynstr_append(&d
, '/');
942 dynstr_append_string(&d
, expansion
);
944 s
= t
+ 1; /* skip {part} */
946 /* only admit to the alias if we used the db... */
951 dynstr_terminate(&d
);
952 /* ...and the answer differs from the original... */
953 if(!strcmp(track
, d
.vec
)) {
957 /* ...and there isn't already a different track with that name (including as
959 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
961 if((s
= kvp_get(at
, "_alias_for"))
962 && !strcmp(s
, track
)) {
974 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
975 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
976 * Always sets the return values, even if only to null pointers. */
977 static int gettrackdata(const char *track
,
980 const char **actualp
,
982 #define GTD_NOALIAS 0x0001
985 const char *actual
= track
;
986 struct kvp
*t
= 0, *p
= 0;
988 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
989 if((actual
= kvp_get(t
, "_alias_for"))) {
990 if(flags
& GTD_NOALIAS
) {
991 error(0, "alias passed to gettrackdata where real path required");
994 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
999 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1004 if(actualp
) *actualp
= actual
;
1010 /* trackdb_notice() **********************************************************/
1012 /** @brief notice a possibly new track
1013 * @return @c DB_NOTFOUND if new, 0 if already known
1015 int trackdb_notice(const char *track
,
1021 tid
= trackdb_begin_transaction();
1022 err
= trackdb_notice_tid(track
, path
, tid
);
1023 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
1026 trackdb_abort_transaction(tid
);
1028 trackdb_commit_transaction(tid
);
1032 /** @brief notice a possibly new track
1033 * @param track NFC UTF-8 track name
1034 * @param path Raw path name
1035 * @param tid Transaction ID
1036 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1038 int trackdb_notice_tid(const char *track
,
1042 struct kvp
*t
, *a
, *p
;
1044 char *alias
, **w
, *noticed
;
1047 /* notice whether the tracks.db entry changes */
1049 /* get any existing tracks entry */
1050 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1052 ret
= err
; /* 0 or DB_NOTFOUND */
1053 /* this is a real track */
1054 t_changed
+= kvp_set(&t
, "_alias_for", 0);
1055 t_changed
+= kvp_set(&t
, "_path", path
);
1057 if(ret
== DB_NOTFOUND
) {
1058 /* It's a new track; record the time */
1059 byte_xasprintf(¬iced
, "%lld", (long long)now
);
1060 t_changed
+= kvp_set(&t
, "_noticed", noticed
);
1062 /* if we have an alias record it in the database */
1063 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1065 /* won't overwrite someone else's alias as compute_alias() checks */
1066 D(("%s: alias %s", track
, alias
));
1068 kvp_set(&a
, "_alias_for", track
);
1069 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
1071 /* update search.db */
1072 w
= track_to_words(track
, p
);
1073 for(n
= 0; w
[n
]; ++n
)
1074 if((err
= register_search_word(track
, w
[n
], tid
)))
1076 /* update tags.db */
1077 w
= parsetags(kvp_get(p
, "tags"));
1078 for(n
= 0; w
[n
]; ++n
)
1079 if((err
= register_tag(track
, w
[n
], tid
)))
1081 /* only store the tracks.db entry if it has changed */
1082 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
1084 if(ret
== DB_NOTFOUND
) {
1085 uint32_t timestamp
[2];
1088 timestamp
[0] = htonl((uint64_t)now
>> 32);
1089 timestamp
[1] = htonl((uint32_t)now
);
1090 memset(&key
, 0, sizeof key
);
1091 key
.data
= timestamp
;
1092 key
.size
= sizeof timestamp
;
1093 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
1094 make_key(&data
, track
), 0)) {
1096 case DB_LOCK_DEADLOCK
: return err
;
1097 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
1103 /* trackdb_obsolete() ********************************************************/
1105 /* obsolete a track */
1106 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
1111 if((err
= gettrackdata(track
, 0, &p
, 0,
1112 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
1114 else if(err
== DB_NOTFOUND
) return 0;
1115 /* compute the alias, if any, and delete it */
1116 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
1118 /* if the alias points to some other track then compute_alias won't
1120 if((err
= trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1121 && err
!= DB_NOTFOUND
)
1124 /* update search.db */
1125 w
= track_to_words(track
, p
);
1126 for(n
= 0; w
[n
]; ++n
)
1127 if(trackdb_delkeydata(trackdb_searchdb
,
1128 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1130 /* update tags.db */
1131 w
= parsetags(kvp_get(p
, "tags"));
1132 for(n
= 0; w
[n
]; ++n
)
1133 if(trackdb_delkeydata(trackdb_tagsdb
,
1134 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1136 /* update tracks.db */
1137 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1139 /* We don't delete the prefs, so they survive temporary outages of the
1140 * (possibly virtual) track filesystem */
1144 /* trackdb_stats() ***********************************************************/
1146 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1147 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1149 static const struct statinfo
{
1152 } statinfo_hash
[] = {
1168 }, statinfo_btree
[] = {
1189 /* look up stats for DB */
1190 static int get_stats(struct vector
*v
,
1192 const struct statinfo
*si
,
1201 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1204 case DB_LOCK_DEADLOCK
:
1205 error(0, "error querying database: %s", db_strerror(err
));
1208 fatal(0, "error querying database: %s", db_strerror(err
));
1210 for(n
= 0; n
< nsi
; ++n
) {
1211 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1212 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1213 vector_append(v
, str
);
1219 /** @brief One entry in the search league */
1220 struct search_entry
{
1225 /** @brief Add a word to the search league
1226 * @param se Pointer to search league
1227 * @param count Maximum size for search league
1228 * @param nse Current size of search league
1229 * @param word New word, or NULL
1230 * @param n How often @p word appears
1231 * @return New size of search league
1233 static int register_search_entry(struct search_entry
*se
,
1240 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1241 /* Find the starting point */
1246 /* Find the insertion point */
1247 while(i
> 0 && n
> se
[i
- 1].n
)
1249 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1256 /* find the top COUNT words in the search database */
1257 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1258 struct search_entry
*se
;
1261 int err
, n
= 0, nse
= 0, i
;
1266 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1267 se
= xmalloc(count
* sizeof *se
);
1268 /* Walk across the whole database counting up the number of times each
1270 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1272 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1273 ++n
; /* same word again */
1275 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1276 word
= xstrndup(k
.data
, wl
= k
.size
);
1284 case DB_LOCK_DEADLOCK
:
1285 error(0, "error querying search database: %s", db_strerror(err
));
1288 fatal(0, "error querying search database: %s", db_strerror(err
));
1290 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1292 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1293 byte_xasprintf(&str
, "Top %d search words:", nse
);
1294 vector_append(v
, str
);
1295 for(i
= 0; i
< nse
; ++i
) {
1296 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1297 vector_append(v
, str
);
1302 #define SI(what) statinfo_##what, \
1303 sizeof statinfo_##what / sizeof (struct statinfo)
1305 /* return a list of database stats */
1306 char **trackdb_stats(int *nstatsp
) {
1312 tid
= trackdb_begin_transaction();
1314 vector_append(&v
, (char *)"Tracks database stats:");
1315 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1316 vector_append(&v
, (char *)"");
1317 vector_append(&v
, (char *)"Search database stats:");
1318 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1319 vector_append(&v
, (char *)"");
1320 vector_append(&v
, (char *)"Prefs database stats:");
1321 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1322 vector_append(&v
, (char *)"");
1323 if(search_league(&v
, 10, tid
)) goto fail
;
1324 vector_terminate(&v
);
1327 trackdb_abort_transaction(tid
);
1329 trackdb_commit_transaction(tid
);
1330 if(nstatsp
) *nstatsp
= v
.nvec
;
1334 struct stats_details
{
1335 void (*done
)(char *data
, void *u
);
1337 int exited
; /* subprocess exited */
1338 int closed
; /* pipe close */
1339 int wstat
; /* wait status from subprocess */
1340 struct dynstr data
[1]; /* data read from pipe */
1343 static void stats_complete(struct stats_details
*d
) {
1346 if(!(d
->exited
&& d
->closed
))
1348 byte_xasprintf(&s
, "\n"
1350 "track lookup cache hits: %lu\n"
1351 "track lookup cache misses: %lu\n",
1353 cache_files_misses
);
1354 dynstr_append_string(d
->data
, s
);
1355 dynstr_terminate(d
->data
);
1356 d
->done(d
->data
->vec
, d
->u
);
1359 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1360 pid_t
attribute((unused
)) pid
,
1362 const struct rusage
attribute((unused
)) *rusage
,
1364 struct stats_details
*const d
= u
;
1368 error(0, "disorder-stats %s", wstat(status
));
1373 static int stats_read(ev_source
attribute((unused
)) *ev
,
1379 struct stats_details
*const d
= u
;
1381 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1382 ev_reader_consume(reader
, bytes
);
1389 static int stats_error(ev_source
attribute((unused
)) *ev
,
1392 struct stats_details
*const d
= u
;
1394 error(errno_value
, "error reading from pipe to disorder-stats");
1400 void trackdb_stats_subprocess(ev_source
*ev
,
1401 void (*done
)(char *data
, void *u
),
1405 struct stats_details
*d
= xmalloc(sizeof *d
);
1407 dynstr_init(d
->data
);
1411 pid
= subprogram(ev
, p
[1], "disorder-stats", (char *)0);
1413 ev_child(ev
, pid
, 0, stats_finished
, d
);
1414 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1417 /** @brief Parse a track name part preference
1418 * @param name Preference name
1419 * @param partp Where to store part name
1420 * @param contextp Where to store context name
1421 * @return 0 on success, non-0 if parse fails
1423 static int trackdb__parse_namepref(const char *name
,
1427 static const char prefix
[] = "trackname_";
1429 if(strncmp(name
, prefix
, strlen(prefix
)))
1430 return -1; /* not trackname_* at all */
1431 name
+= strlen(prefix
);
1432 /* There had better be a _ between context and part */
1433 c
= strchr(name
, '_');
1436 /* Context is first in the pref name even though most APIs have the part
1437 * first. Confusing; sorry. */
1438 *contextp
= xstrndup(name
, c
- name
);
1440 /* There had better NOT be a second _ */
1443 *partp
= xstrdup(c
);
1447 /** @brief Compute the default value for a track preference
1448 * @param track Track name
1449 * @param name Preference name
1450 * @return Default value or 0 if none/not known
1452 static const char *trackdb__default(const char *track
, const char *name
) {
1453 char *context
, *part
;
1455 if(!trackdb__parse_namepref(name
, &part
, &context
)) {
1456 /* We can work out the default for a trackname_ pref */
1457 return trackname_part(track
, context
, part
);
1458 } else if(!strcmp(name
, "weight")) {
1459 /* We know the default weight */
1461 } else if(!strcmp(name
, "pick_at_random")) {
1462 /* By default everything is eligible for picking at random */
1464 } else if(!strcmp(name
, "tags")) {
1465 /* By default everything no track has any tags */
1471 /* set a pref (remove if value=0) */
1472 int trackdb_set(const char *track
,
1474 const char *value
) {
1475 struct kvp
*t
, *p
, *a
;
1478 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1481 /* If the value matches the default then unset instead, to keep the database
1482 * tidy. Older versions did not have this feature so your database may yet
1483 * have some default values stored in it. */
1485 def
= trackdb__default(track
, name
);
1486 if(def
&& !strcmp(value
, def
))
1491 tid
= trackdb_begin_transaction();
1492 if((err
= gettrackdata(track
, &t
, &p
, 0,
1493 0, tid
)) == DB_LOCK_DEADLOCK
)
1495 if(err
== DB_NOTFOUND
) break;
1496 if(name
[0] == '_') {
1497 if(kvp_set(&t
, name
, value
))
1498 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1501 /* get the old alias name */
1502 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1503 /* get the old tags */
1504 if(!strcmp(name
, "tags"))
1505 oldtags
= parsetags(kvp_get(p
, "tags"));
1507 if(kvp_set(&p
, name
, value
))
1508 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1510 /* compute the new alias name */
1511 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1512 /* check whether alias has changed */
1513 if(!(oldalias
== newalias
1514 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1515 /* adjust alias records to fit change */
1517 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
) == DB_LOCK_DEADLOCK
)
1521 kvp_set(&a
, "_alias_for", track
);
1522 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1525 /* check whether tags have changed */
1526 if(!strcmp(name
, "tags")) {
1527 newtags
= parsetags(value
);
1528 while(*oldtags
|| *newtags
) {
1529 if(*oldtags
&& *newtags
) {
1530 cmp
= strcmp(*oldtags
, *newtags
);
1532 /* keeping this tag */
1536 /* old tag fits into a gap in the new list, so delete old */
1539 /* new tag fits into a gap in the old list, so insert new */
1541 } else if(*oldtags
) {
1542 /* we've run out of new tags, so remaining old ones are to be
1545 if(trackdb_delkeydata(trackdb_tagsdb
,
1546 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1550 /* we've run out of old tags, so remainig new ones are to be
1553 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1562 trackdb_abort_transaction(tid
);
1564 trackdb_commit_transaction(tid
);
1565 return err
== 0 ?
0 : -1;
1569 const char *trackdb_get(const char *track
,
1571 return kvp_get(trackdb_get_all(track
), name
);
1574 /* get all prefs as a 0-terminated array */
1575 struct kvp
*trackdb_get_all(const char *track
) {
1576 struct kvp
*t
, *p
, **pp
;
1580 tid
= trackdb_begin_transaction();
1581 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1585 trackdb_abort_transaction(tid
);
1587 trackdb_commit_transaction(tid
);
1588 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1595 const char *trackdb_resolve(const char *track
) {
1600 tid
= trackdb_begin_transaction();
1601 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1605 trackdb_abort_transaction(tid
);
1607 trackdb_commit_transaction(tid
);
1611 int trackdb_isalias(const char *track
) {
1612 const char *actual
= trackdb_resolve(track
);
1614 return strcmp(actual
, track
);
1617 /* test whether a track exists (perhaps an alias) */
1618 int trackdb_exists(const char *track
) {
1623 tid
= trackdb_begin_transaction();
1624 /* unusually, here we want the return value */
1625 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1629 trackdb_abort_transaction(tid
);
1631 trackdb_commit_transaction(tid
);
1635 /* return the list of tags */
1636 char **trackdb_alltags(void) {
1641 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb
, v
, tid
));
1645 /** @brief List all the keys in @p db
1646 * @param db Database
1647 * @param v Vector to store keys in
1648 * @param tid Transaction ID
1649 * @return 0 or DB_LOCK_DEADLOCK
1651 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
) {
1654 DBC
*const c
= trackdb_opencursor(db
, tid
);
1657 memset(&k
, 0, sizeof k
);
1658 while(!(e
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1659 vector_append(v
, xstrndup(k
.data
, k
.size
));
1663 case DB_LOCK_DEADLOCK
:
1666 fatal(0, "c->c_get: %s", db_strerror(e
));
1668 if((e
= trackdb_closecursor(c
)))
1670 vector_terminate(v
);
1674 /* return 1 iff sorted tag lists A and B have at least one member in common */
1675 int tag_intersection(char **a
, char **b
) {
1678 /* Same sort of logic as trackdb_set() above */
1680 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1681 else if(cmp
< 0) ++a
;
1687 static pid_t choose_pid
= -1;
1688 static int choose_fd
;
1689 static random_callback
*choose_callback
;
1690 static struct dynstr choose_output
;
1691 static unsigned choose_complete
;
1692 static int choose_status
;
1693 #define CHOOSE_RUNNING 1
1694 #define CHOOSE_READING 2
1696 static void choose_finished(ev_source
*ev
, unsigned which
) {
1697 choose_complete
|= which
;
1698 if(choose_complete
!= (CHOOSE_RUNNING
|CHOOSE_READING
))
1701 if(choose_status
== 0 && choose_output
.nvec
> 0) {
1702 dynstr_terminate(&choose_output
);
1703 choose_callback(ev
, xstrdup(choose_output
.vec
));
1705 choose_callback(ev
, 0);
1708 /** @brief Called when @c disorder-choose terminates */
1709 static int choose_exited(ev_source
*ev
,
1710 pid_t
attribute((unused
)) pid
,
1712 const struct rusage
attribute((unused
)) *rusage
,
1713 void attribute((unused
)) *u
) {
1715 error(0, "disorder-choose %s", wstat(status
));
1716 choose_status
= status
;
1717 choose_finished(ev
, CHOOSE_RUNNING
);
1721 /** @brief Called with data from @c disorder-choose pipe */
1722 static int choose_readable(ev_source
*ev
,
1727 void attribute((unused
)) *u
) {
1728 dynstr_append_bytes(&choose_output
, ptr
, bytes
);
1729 ev_reader_consume(reader
, bytes
);
1731 choose_finished(ev
, CHOOSE_READING
);
1735 static int choose_read_error(ev_source
*ev
,
1737 void attribute((unused
)) *u
) {
1738 error(errno_value
, "error reading disorder-choose pipe");
1739 choose_finished(ev
, CHOOSE_READING
);
1743 /** @brief Request a random track
1744 * @param ev Event source
1745 * @param callback Called with random track or NULL
1746 * @return 0 if a request was initiated, else -1
1748 * Initiates a random track choice. @p callback will later be called back with
1749 * the choice (or NULL on error). If a choice is already underway then -1 is
1750 * returned and there will be no additional callback.
1752 * The caller shouldn't assume that the track returned actually exists (it
1753 * might be removed between the choice and the callback, or between being added
1754 * to the queue and being played).
1756 int trackdb_request_random(ev_source
*ev
,
1757 random_callback
*callback
) {
1760 if(choose_pid
!= -1)
1761 return -1; /* don't run concurrent chooses */
1764 choose_pid
= subprogram(ev
, p
[1], "disorder-choose", (char *)0);
1767 choose_callback
= callback
;
1768 choose_output
.nvec
= 0;
1769 choose_complete
= 0;
1770 ev_reader_new(ev
, p
[0], choose_readable
, choose_read_error
, 0,
1771 "disorder-choose reader"); /* owns p[0] */
1772 ev_child(ev
, choose_pid
, 0, choose_exited
, 0); /* owns the subprocess */
1776 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1777 * from the prefs. */
1778 static const char *getpart(const char *track
,
1779 const char *context
,
1781 const struct kvp
*p
,
1786 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1787 if((result
= kvp_get(p
, pref
)))
1790 result
= trackname_part(track
, context
, part
);
1791 assert(result
!= 0);
1795 /* get a track name part, like trackname_part(), but taking the database into
1797 const char *trackdb_getpart(const char *track
,
1798 const char *context
,
1806 /* construct the full pref */
1807 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1809 tid
= trackdb_begin_transaction();
1810 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1814 trackdb_abort_transaction(tid
);
1816 trackdb_commit_transaction(tid
);
1817 return getpart(actual
, context
, part
, p
, &used_db
);
1820 /* get the raw path name for @track@ (might be an alias) */
1821 const char *trackdb_rawpath(const char *track
) {
1827 tid
= trackdb_begin_transaction();
1828 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1832 trackdb_abort_transaction(tid
);
1834 trackdb_commit_transaction(tid
);
1835 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1839 /* trackdb_list **************************************************************/
1841 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1842 * readable at some point */
1844 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1845 * If RE is a null pointer then it matches everything. */
1846 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1854 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1855 case PCRE_ERROR_NOMATCH
: return 0;
1858 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1865 static int do_list(struct vector
*v
, const char *dir
,
1866 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1872 size_t l
, last_dir_len
= 0;
1873 char *last_dir
= 0, *track
;
1877 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1880 /* find the first key >= dir */
1881 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1882 /* keep going while we're dealing with <dir/anything> */
1885 && ((char *)k
.data
)[dl
] == '/'
1886 && !memcmp(k
.data
, dir
, dl
)) {
1887 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1889 /* we have <dir/component/anything>, so <dir/component> is a directory */
1890 l
= ptr
- (char *)k
.data
;
1891 if(what
& trackdb_directories
)
1893 && l
== last_dir_len
1894 && !memcmp(last_dir
, k
.data
, l
))) {
1895 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1896 if(track_matches(dl
, k
.data
, l
, re
))
1897 vector_append(v
, last_dir
);
1900 /* found a plain file */
1901 if((what
& trackdb_files
)) {
1902 track
= xstrndup(k
.data
, k
.size
);
1903 if((err
= trackdb_getdata(trackdb_prefsdb
,
1904 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1906 /* There's an awkward question here...
1908 * If a track shares a directory with its alias then we could
1909 * do one of three things:
1910 * - report both. Looks ridiculuous in most UIs.
1911 * - report just the alias. Remarkably inconvenient to write
1913 * - report just the real name. Ugly if the UI doesn't prettify
1914 * names via the name parts.
1917 /* If this file is an alias for a track in the same directory then we
1919 struct kvp
*t
= kvp_urldecode(d
.data
, d
.size
);
1920 const char *alias_target
= kvp_get(t
, "_alias_for");
1922 && !strcmp(d_dirname(alias_target
),
1924 if(track_matches(dl
, k
.data
, k
.size
, re
))
1925 vector_append(v
, track
);
1927 /* if this file has an alias in the same directory then we skip it */
1929 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1931 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1932 if(track_matches(dl
, k
.data
, k
.size
, re
))
1933 vector_append(v
, track
);
1937 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1945 case DB_LOCK_DEADLOCK
:
1946 error(0, "error querying database: %s", db_strerror(err
));
1949 fatal(0, "error querying database: %s", db_strerror(err
));
1952 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1956 /* return the directories or files below @dir@ */
1957 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1965 tid
= trackdb_begin_transaction();
1968 if(do_list(&v
, dir
, what
, re
, tid
))
1971 for(n
= 0; n
< config
->collection
.n
; ++n
)
1972 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1977 trackdb_abort_transaction(tid
);
1979 trackdb_commit_transaction(tid
);
1980 vector_terminate(&v
);
1986 /* If S is tag:something, return something. Else return 0. */
1987 static const char *checktag(const char *s
) {
1988 if(!strncmp(s
, "tag:", 4))
1994 /* return a list of tracks containing all of the words given. If you
1995 * ask for only stopwords you get no tracks. */
1996 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1997 const char **w
, *best
= 0, *tag
;
1998 char **twords
, **tags
;
2000 int i
, j
, n
, err
, what
;
2010 *ntracks
= 0; /* for early returns */
2011 /* normalize all the words */
2012 w
= xmalloc(nwordlist
* sizeof (char *));
2013 istag
= xmalloc_noptr(nwordlist
);
2014 for(n
= 0; n
< nwordlist
; ++n
) {
2018 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
2019 if(checktag(w
[n
])) {
2020 ++ntags
; /* count up tags */
2021 /* Normalize the tag */
2022 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
2025 /* Normalize the search term by removing combining characters */
2026 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
2028 nw32
= remove_combining_chars(w32
, nw32
);
2029 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
2034 /* find the longest non-stopword */
2035 for(n
= 0; n
< nwordlist
; ++n
)
2036 if(!istag
[n
] && !stopword(w
[n
]))
2037 if(!best
|| strlen(w
[n
]) > strlen(best
))
2039 /* TODO: we should at least in principal be able to identify the word or tag
2040 * with the least matches in log time, and choose that as our primary search
2042 if(ntags
&& !best
) {
2043 /* Only tags are listed. We limit to the first and narrow down with the
2045 best
= istag
[0] ? w
[0] : 0;
2046 db
= trackdb_tagsdb
;
2049 /* We can limit to some word. */
2050 db
= trackdb_searchdb
;
2053 /* Only stopwords */
2059 tid
= trackdb_begin_transaction();
2060 /* find all the tracks that have that word */
2065 cursor
= trackdb_opencursor(db
, tid
);
2066 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
2067 vector_append(&v
, xstrndup(d
.data
, d
.size
));
2074 case DB_LOCK_DEADLOCK
:
2075 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2078 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
2080 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
2082 /* do a naive search over that (hopefuly fairly small) list of tracks */
2084 for(n
= 0; n
< v
.nvec
; ++n
) {
2085 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
2088 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
2091 twords
= track_to_words(v
.vec
[n
], p
);
2092 tags
= parsetags(kvp_get(p
, "tags"));
2093 for(i
= 0; i
< nwordlist
; ++i
) {
2096 /* Track must have this tag */
2097 for(j
= 0; tags
[j
]; ++j
)
2098 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
2099 if(!tags
[j
]) break; /* tag not found */
2101 /* Track must contain this word */
2102 for(j
= 0; twords
[j
]; ++j
)
2103 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
2104 if(!twords
[j
]) break; /* word not found */
2107 if(i
>= nwordlist
) /* all words found */
2108 vector_append(&u
, v
.vec
[n
]);
2112 trackdb_closecursor(cursor
);
2114 trackdb_abort_transaction(tid
);
2115 info("retrying search");
2117 trackdb_commit_transaction(tid
);
2118 vector_terminate(&u
);
2124 /* trackdb_scan **************************************************************/
2126 int trackdb_scan(const char *root
,
2127 int (*callback
)(const char *track
,
2136 const size_t root_len
= root ?
strlen(root
) : 0;
2138 struct kvp
*data
, *prefs
;
2141 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2143 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2146 memset(&k
, 0, sizeof k
);
2147 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2152 || (k
.size
> root_len
2153 && !strncmp(k
.data
, root
, root_len
)
2154 && ((char *)k
.data
)[root_len
] == '/')) {
2155 data
= kvp_urldecode(d
.data
, d
.size
);
2156 if(kvp_get(data
, "_path")) {
2157 track
= xstrndup(k
.data
, k
.size
);
2158 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2159 * do a lookup for every single track. In fact this is quite quick:
2160 * with around 10,000 tracks a complete scan is around 0.3s on my
2161 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2162 * linear walk as we already do over trackdb_tracksdb, and probably get
2163 * even higher performance. That would require upgrade logic to
2164 * translate old databases though.
2166 switch(err
= trackdb_prefsdb
->get(trackdb_prefsdb
, tid
, &k
,
2167 prepare_data(&pd
), 0)) {
2169 prefs
= kvp_urldecode(pd
.data
, pd
.size
);
2174 case DB_LOCK_DEADLOCK
:
2175 error(0, "getting prefs: %s", db_strerror(err
));
2176 trackdb_closecursor(cursor
);
2179 fatal(0, "getting prefs: %s", db_strerror(err
));
2181 /* Advance to the next track before the callback so that the callback
2182 * may safely delete the track */
2183 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2184 if((cberr
= callback(track
, data
, prefs
, u
, tid
))) {
2189 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2193 trackdb_closecursor(cursor
);
2200 case DB_LOCK_DEADLOCK
:
2201 error(0, "c->c_get: %s", db_strerror(err
));
2204 fatal(0, "c->c_get: %s", db_strerror(err
));
2208 /* trackdb_rescan ************************************************************/
2210 /** @brief Node in the list of rescan-complete callbacks */
2211 struct rescanned_node
{
2212 struct rescanned_node
*next
;
2213 void (*rescanned
)(void *ru
);
2217 /** @brief List of rescan-complete callbacks */
2218 static struct rescanned_node
*rescanned_list
;
2220 /** @brief Add a rescan completion callback */
2221 void trackdb_add_rescanned(void (*rescanned
)(void *ru
),
2224 struct rescanned_node
*n
= xmalloc(sizeof *n
);
2225 n
->next
= rescanned_list
;
2226 n
->rescanned
= rescanned
;
2232 /* called when the rescanner terminates */
2233 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2236 const struct rusage
attribute((unused
)) *rusage
,
2237 void attribute((unused
)) *u
) {
2238 if(pid
== rescan_pid
) rescan_pid
= -1;
2240 error(0, RESCAN
": %s", wstat(status
));
2242 D((RESCAN
" terminated: %s", wstat(status
)));
2243 /* Our cache of file lookups is out of date now */
2244 cache_clean(&cache_files_type
);
2245 eventlog("rescanned", (char *)0);
2246 /* Call rescanned callbacks */
2247 while(rescanned_list
) {
2248 void (*rescanned
)(void *u_
) = rescanned_list
->rescanned
;
2249 void *ru
= rescanned_list
->ru
;
2251 rescanned_list
= rescanned_list
->next
;
2257 /** @brief Initiate a rescan
2258 * @param ev Event loop or 0 to block
2259 * @param recheck 1 to recheck lengths, 0 to suppress check
2260 * @param rescanned Called on completion (if not NULL)
2261 * @param u Passed to @p rescanned
2263 void trackdb_rescan(ev_source
*ev
, int recheck
,
2264 void (*rescanned
)(void *ru
),
2268 if(rescan_pid
!= -1) {
2269 trackdb_add_rescanned(rescanned
, ru
);
2270 error(0, "rescan already underway");
2273 rescan_pid
= subprogram(ev
, -1, RESCAN
,
2274 recheck ?
"--check" : "--no-check",
2276 trackdb_add_rescanned(rescanned
, ru
);
2278 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2279 D(("started rescanner"));
2281 /* This is the first rescan, we block until it is complete */
2282 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2284 reap_rescan(0, rescan_pid
, w
, 0, 0);
2288 int trackdb_rescan_cancel(void) {
2289 if(rescan_pid
== -1) return 0;
2290 if(kill(rescan_pid
, SIGTERM
) < 0)
2291 fatal(errno
, "error killing rescanner");
2296 /** @brief Return true if a rescan is underway */
2297 int trackdb_rescan_underway(void) {
2298 return rescan_pid
!= -1;
2301 /* global prefs **************************************************************/
2303 void trackdb_set_global(const char *name
,
2311 tid
= trackdb_begin_transaction();
2312 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2314 trackdb_abort_transaction(tid
);
2316 trackdb_commit_transaction(tid
);
2317 /* log important state changes */
2318 if(!strcmp(name
, "playing")) {
2319 state
= !value
|| !strcmp(value
, "yes");
2320 info("playing %s by %s",
2321 state ?
"enabled" : "disabled",
2323 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2325 if(!strcmp(name
, "random-play")) {
2326 state
= !value
|| !strcmp(value
, "yes");
2327 info("random play %s by %s",
2328 state ?
"enabled" : "disabled",
2330 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2334 int trackdb_set_global_tid(const char *name
,
2340 memset(&k
, 0, sizeof k
);
2341 memset(&d
, 0, sizeof d
);
2342 k
.data
= (void *)name
;
2343 k
.size
= strlen(name
);
2345 d
.data
= (void *)value
;
2346 d
.size
= strlen(value
);
2349 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2351 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2352 if(err
== DB_LOCK_DEADLOCK
) return err
;
2354 fatal(0, "error updating database: %s", db_strerror(err
));
2358 const char *trackdb_get_global(const char *name
) {
2364 tid
= trackdb_begin_transaction();
2365 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2367 trackdb_abort_transaction(tid
);
2369 trackdb_commit_transaction(tid
);
2373 int trackdb_get_global_tid(const char *name
,
2379 memset(&k
, 0, sizeof k
);
2380 k
.data
= (void *)name
;
2381 k
.size
= strlen(name
);
2382 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2383 prepare_data(&d
), 0)) {
2385 *rp
= xstrndup(d
.data
, d
.size
);
2390 case DB_LOCK_DEADLOCK
:
2393 fatal(0, "error reading database: %s", db_strerror(err
));
2397 /** @brief Retrieve the most recently added tracks
2398 * @param ntracksp Where to put count, or 0
2399 * @param maxtracks Maximum number of tracks to retrieve
2400 * @return null-terminated array of track names
2402 * The most recently added track is first in the array.
2404 char **trackdb_new(int *ntracksp
,
2410 tid
= trackdb_begin_transaction();
2411 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2414 trackdb_abort_transaction(tid
);
2416 trackdb_commit_transaction(tid
);
2420 /** @brief Retrieve the most recently added tracks
2421 * @param ntracksp Where to put count, or 0
2422 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2423 * @param tid Transaction ID
2424 * @return null-terminated array of track names, or NULL on deadlock
2426 * The most recently added track is first in the array.
2428 static char **trackdb_new_tid(int *ntracksp
,
2434 struct vector tracks
[1];
2435 hash
*h
= hash_new(1);
2437 vector_init(tracks
);
2438 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2439 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2440 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
))) {
2441 char *const track
= xstrndup(d
.data
, d
.size
);
2442 /* Don't add any track more than once */
2443 if(hash_add(h
, track
, "", HASH_INSERT
))
2445 /* See if the track still exists */
2446 err
= trackdb_getdata(trackdb_tracksdb
, track
, NULL
/*kp*/, tid
);
2447 if(err
== DB_NOTFOUND
)
2448 continue; /* It doesn't, skip it */
2449 if(err
== DB_LOCK_DEADLOCK
)
2451 vector_append(tracks
, track
);
2454 case 0: /* hit maxtracks */
2455 case DB_NOTFOUND
: /* ran out of tracks */
2457 case DB_LOCK_DEADLOCK
:
2458 trackdb_closecursor(c
);
2461 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2463 if((err
= trackdb_closecursor(c
)))
2464 return 0; /* deadlock */
2465 vector_terminate(tracks
);
2467 *ntracksp
= tracks
->nvec
;
2471 /** @brief Expire noticed.db
2472 * @param earliest Earliest timestamp to keep
2474 void trackdb_expire_noticed(time_t earliest
) {
2478 tid
= trackdb_begin_transaction();
2479 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2481 trackdb_abort_transaction(tid
);
2483 trackdb_commit_transaction(tid
);
2486 /** @brief Expire noticed.db
2487 * @param earliest Earliest timestamp to keep
2488 * @param tid Transaction ID
2489 * @return 0 or DB_LOCK_DEADLOCK
2491 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2499 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2500 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2502 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2503 if(when
>= earliest
)
2505 if((err
= c
->c_del(c
, 0))) {
2506 if(err
!= DB_LOCK_DEADLOCK
)
2507 fatal(0, "error deleting expired noticed.db entry: %s",
2513 if(err
== DB_NOTFOUND
)
2515 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2516 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2518 if((err
= trackdb_closecursor(c
))) {
2519 if(err
!= DB_LOCK_DEADLOCK
)
2520 fatal(0, "error closing cursor: %s", db_strerror(err
));
2524 info("expired %d tracks from noticed.db", count
);
2528 /* tidying up ****************************************************************/
2530 void trackdb_gc(void) {
2534 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2535 config
->checkpoint_kbyte
,
2536 config
->checkpoint_min
,
2538 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2539 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2540 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2541 /* This makes catastrophic recovery impossible. However, the user can still
2542 * preserve the important data by using disorder-dump to snapshot their
2543 * prefs, and later to restore it. This is likely to have much small
2544 * long-term storage requirements than record the db logfiles. */
2547 /* user database *************************************************************/
2549 /** @brief Return true if @p user is trusted */
2550 static int trusted(const char *user
) {
2553 for(n
= 0; (n
< config
->trust
.n
2554 && strcmp(config
->trust
.s
[n
], user
)); ++n
)
2556 return n
< config
->trust
.n
;
2559 /** @brief Return non-zero for a valid username
2561 * Currently we only allow the letters and digits in ASCII. We could be more
2562 * liberal than this but it is a nice simple test. It is critical that
2563 * semicolons are never allowed.
2565 * NB also used by playlist_parse_name() to validate playlist names!
2567 int valid_username(const char *user
) {
2571 const uint8_t c
= *user
++;
2572 /* For now we are very strict */
2573 if((c
>= 'a' && c
<= 'z')
2574 || (c
>= 'A' && c
<= 'Z')
2575 || (c
>= '0' && c
<= '9'))
2583 /** @brief Add a user */
2584 static int create_user(const char *user
,
2585 const char *password
,
2588 const char *confirmation
,
2594 /* sanity check user */
2595 if(!valid_username(user
)) {
2596 error(0, "invalid username '%s'", user
);
2599 if(parse_rights(rights
, 0, 1)) {
2600 error(0, "invalid rights string");
2603 /* data for this user */
2605 kvp_set(&k
, "password", password
);
2606 kvp_set(&k
, "rights", rights
);
2608 kvp_set(&k
, "email", email
);
2610 kvp_set(&k
, "confirmation", confirmation
);
2611 snprintf(s
, sizeof s
, "%jd", (intmax_t)time(0));
2612 kvp_set(&k
, "created", s
);
2613 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, flags
);
2616 /** @brief Add one pre-existing user */
2617 static int one_old_user(const char *user
, const char *password
,
2621 /* www-data doesn't get added */
2622 if(!strcmp(user
, "www-data")) {
2623 info("not adding www-data to user database");
2627 if(!strcmp(user
, "root"))
2629 else if(trusted(user
)) {
2632 parse_rights(config
->default_rights
, &r
, 1);
2633 r
&= ~(rights_type
)(RIGHT_SCRATCH__MASK
|RIGHT_MOVE__MASK
|RIGHT_REMOVE__MASK
);
2634 r
|= (RIGHT_ADMIN
|RIGHT_RESCAN
2635 |RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
);
2636 rights
= rights_string(r
);
2638 rights
= config
->default_rights
;
2639 return create_user(user
, password
, rights
, 0/*email*/, 0/*confirmation*/,
2640 tid
, DB_NOOVERWRITE
);
2643 static int trackdb_old_users_tid(DB_TXN
*tid
) {
2646 for(n
= 0; n
< config
->allow
.n
; ++n
) {
2647 switch(one_old_user(config
->allow
.s
[n
].s
[0], config
->allow
.s
[n
].s
[1],
2650 info("created user %s from 'allow' directive", config
->allow
.s
[n
].s
[0]);
2653 error(0, "user %s already exists, delete 'allow' directive",
2654 config
->allow
.s
[n
].s
[0]);
2655 /* This won't ever become fatal - eventually 'allow' will be
2658 case DB_LOCK_DEADLOCK
:
2659 return DB_LOCK_DEADLOCK
;
2665 /** @brief Read old 'allow' directives and copy them to the users database */
2666 void trackdb_old_users(void) {
2670 WITH_TRANSACTION(trackdb_old_users_tid(tid
));
2673 /** @brief Create a root user in the user database if there is none */
2674 void trackdb_create_root(void) {
2679 /* Choose a new root password */
2680 gcry_randomize(pwbin
, sizeof pwbin
, GCRY_STRONG_RANDOM
);
2681 pw
= mime_to_base64(pwbin
, sizeof pwbin
);
2682 /* Create the root user if it does not exist */
2683 WITH_TRANSACTION(create_user("root", pw
, "all",
2684 0/*email*/, 0/*confirmation*/,
2685 tid
, DB_NOOVERWRITE
));
2687 info("created root user");
2690 /** @brief Find a user's password from the database
2691 * @param user Username
2692 * @return Password or NULL
2694 * Only works if running as a user that can read the database!
2696 * If the user exists but has no password, "" is returned.
2698 const char *trackdb_get_password(const char *user
) {
2701 const char *password
;
2703 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2706 password
= kvp_get(k
, "password");
2707 return password ? password
: "";
2710 /** @brief Add a new user
2711 * @param user Username
2712 * @param password Password or NULL
2713 * @param rights Initial rights
2714 * @param email Email address or NULL
2715 * @param confirmation Confirmation string or NULL
2716 * @return 0 on success, non-0 on error
2718 int trackdb_adduser(const char *user
,
2719 const char *password
,
2722 const char *confirmation
) {
2725 WITH_TRANSACTION(create_user(user
, password
, rights
, email
, confirmation
,
2726 tid
, DB_NOOVERWRITE
));
2728 error(0, "cannot create user '%s' because they already exist", user
);
2732 info("created user '%s' with rights '%s' and email address '%s'",
2733 user
, rights
, email
);
2735 info("created user '%s' with rights '%s'", user
, rights
);
2736 eventlog("user_add", user
, (char *)0);
2741 /** @brief Delete a user
2742 * @param user User to delete
2743 * @return 0 on success, non-0 if the user didn't exist anyway
2745 int trackdb_deluser(const char *user
) {
2748 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb
, user
, tid
));
2750 error(0, "cannot delete user '%s' because they do not exist", user
);
2753 info("deleted user '%s'", user
);
2754 eventlog("user_delete", user
, (char *)0);
2758 /** @brief Get user information
2759 * @param user User to query
2760 * @return Linked list of user information or NULL if user does not exist
2762 * Every user has at least a @c rights entry so NULL can be used to mean no
2765 struct kvp
*trackdb_getuserinfo(const char *user
) {
2769 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
));
2776 /** @brief Edit user information
2777 * @param user User to edit
2778 * @param key Key to change
2779 * @param value Value to set, or NULL to remove
2780 * @param tid Transaction ID
2781 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2783 static int trackdb_edituserinfo_tid(const char *user
, const char *key
,
2784 const char *value
, DB_TXN
*tid
) {
2788 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2790 if(!kvp_set(&k
, key
, value
))
2791 return 0; /* no change */
2792 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2795 /** @brief Edit user information
2796 * @param user User to edit
2797 * @param key Key to change
2798 * @param value Value to set, or NULL to remove
2799 * @return 0 on success, non-0 on error
2801 int trackdb_edituserinfo(const char *user
,
2802 const char *key
, const char *value
) {
2805 if(!strcmp(key
, "rights")) {
2807 error(0, "cannot remove 'rights' key from user '%s'", user
);
2810 if(parse_rights(value
, 0, 1)) {
2811 error(0, "invalid rights string");
2814 } else if(!strcmp(key
, "email")) {
2816 if(!email_valid(value
)) {
2817 error(0, "invalid email address '%s' for user '%s'", value
, user
);
2821 value
= 0; /* no email -> remove key */
2822 } else if(!strcmp(key
, "created")) {
2823 error(0, "cannot change creation date for user '%s'", user
);
2825 } else if(strcmp(key
, "password")
2826 && !strcmp(key
, "confirmation")) {
2827 error(0, "unknown user info key '%s' for user '%s'", key
, user
);
2830 WITH_TRANSACTION(trackdb_edituserinfo_tid(user
, key
, value
, tid
));
2832 error(0, "unknown user '%s'", user
);
2835 eventlog("user_edit", user
, key
, (char *)0);
2840 /** @brief List all users
2841 * @return NULL-terminated list of users
2843 char **trackdb_listusers(void) {
2848 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb
, v
, tid
));
2852 /** @brief Confirm a user registration
2853 * @param user Username
2854 * @param confirmation Confirmation string
2855 * @param rightsp Where to put user rights
2856 * @param tid Transaction ID
2857 * @return 0 on success, non-0 on error
2859 static int trackdb_confirm_tid(const char *user
, const char *confirmation
,
2860 rights_type
*rightsp
,
2862 const char *stored_confirmation
;
2867 if((e
= trackdb_getdata(trackdb_usersdb
, user
, &k
, tid
)))
2869 if(!(stored_confirmation
= kvp_get(k
, "confirmation"))) {
2870 error(0, "already confirmed user '%s'", user
);
2871 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2874 if(!(rights
= kvp_get(k
, "rights"))) {
2875 error(0, "no rights for unconfirmed user '%s'", user
);
2878 if(parse_rights(rights
, rightsp
, 1))
2880 if(strcmp(confirmation
, stored_confirmation
)) {
2881 error(0, "wrong confirmation string for user '%s'", user
);
2885 kvp_set(&k
, "confirmation", 0);
2886 return trackdb_putdata(trackdb_usersdb
, user
, k
, tid
, 0);
2889 /** @brief Confirm a user registration
2890 * @param user Username
2891 * @param confirmation Confirmation string
2892 * @param rightsp Where to put user rights
2893 * @return 0 on success, non-0 on error
2895 int trackdb_confirm(const char *user
, const char *confirmation
,
2896 rights_type
*rightsp
) {
2899 WITH_TRANSACTION(trackdb_confirm_tid(user
, confirmation
, rightsp
, tid
));
2902 info("registration confirmed for user '%s'", user
);
2903 eventlog("user_confirm", user
, (char *)0);
2906 error(0, "confirmation for nonexistent user '%s'", user
);
2908 default: /* already reported */
2918 indent-tabs-mode:nil