chiark - git - mdw - disorder/blob - lib/trackdb.c

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005-2008 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20 /** @file lib/trackdb.c
  21  * @brief Track database
  22  *
  23  * This file is getting in desparate need of splitting up...
  24  */
  25
  26 #include <config.h>
  27 #include "types.h"
  28
  29 #include <string.h>
  30 #include <stdio.h>
  31 #include <db.h>
  32 #include <sys/socket.h>
  33 #include <pcre.h>
  34 #include <assert.h>
  35 #include <unistd.h>
  36 #include <errno.h>
  37 #include <stddef.h>
  38 #include <sys/time.h>
  39 #include <sys/resource.h>
  40 #include <time.h>
  41 #include <arpa/inet.h>
  42 #include <sys/wait.h>
  43 #include <dirent.h>
  44 #include <sys/stat.h>
  45 #include <gcrypt.h>
  46
  47 #include "event.h"
  48 #include "mem.h"
  49 #include "kvp.h"
  50 #include "log.h"
  51 #include "vector.h"
  52 #include "rights.h"
  53 #include "trackdb.h"
  54 #include "configuration.h"
  55 #include "syscalls.h"
  56 #include "wstat.h"
  57 #include "printf.h"
  58 #include "filepart.h"
  59 #include "trackname.h"
  60 #include "trackdb-int.h"
  61 #include "logfd.h"
  62 #include "cache.h"
  63 #include "eventlog.h"
  64 #include "hash.h"
  65 #include "unicode.h"
  66 #include "unidata.h"
  67 #include "base64.h"
  68
  69 #define RESCAN "disorder-rescan"
  70 #define DEADLOCK "disorder-deadlock"
  71
  72 static const char *getpart(const char *track,
  73                            const char *context,
  74                            const char *part,
  75                            const struct kvp *p,
  76                            int *used_db);
  77 static char **trackdb_new_tid(int *ntracksp,
  78                               int maxtracks,
  79                               DB_TXN *tid);
  80 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid);
  81 static char *normalize_tag(const char *s, size_t ns);
  82
  83 const struct cache_type cache_files_type = { 86400 };
  84 unsigned long cache_files_hits, cache_files_misses;
  85
  86 /** @brief Set by trackdb_open() */
  87 int trackdb_existing_database;
  88
  89 /* setup and teardown ********************************************************/
  90
  91 static const char *home;                /* home had better not change */
  92 DB_ENV *trackdb_env;                    /* db environment */
  93
  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
  98  */
  99 DB *trackdb_tracksdb;
 100
 101 /** @brief The preferences database
 102  *
 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
 107  */
 108 DB *trackdb_prefsdb;
 109
 110 /** @brief The search database
 111  *
 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
 118  */
 119 DB *trackdb_searchdb;
 120
 121 /** @brief The tags database
 122  *
 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
 129  */
 130 DB *trackdb_tagsdb;                     /* the tags database */
 131
 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
 136  */
 137 DB *trackdb_globaldb;                   /* global preferences */
 138
 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)
 145  */
 146 DB *trackdb_noticeddb;                   /* when track noticed */
 147
 148 /** @brief The user database
 149  * - Keys are usernames
 150  * - Values are encoded key-value pairs
 151  * - Data is user data and cannot be reconstructed
 152  */
 153 DB *trackdb_usersdb;
 154
 155 static pid_t db_deadlock_pid = -1;      /* deadlock manager PID */
 156 static pid_t rescan_pid = -1;           /* rescanner PID */
 157 static int initialized, opened;         /* state */
 158
 159 /* comparison function for keys */
 160 static int compare(DB attribute((unused)) *db_,
 161                    const DBT *a, const DBT *b) {
 162   return compare_path_raw(a->data, a->size, b->data, b->size);
 163 }
 164
 165 /** @brief Test whether the track database can be read
 166  * @return 1 if it can, 0 if it cannot
 167  */
 168 int trackdb_readable(void) {
 169   char *usersdb;
 170
 171   byte_xasprintf(&usersdb, "%s/users.db", config->home);
 172   return access(usersdb, R_OK) == 0;
 173 }
 174
 175 /** @brief Open database environment
 176  * @param flags Flags word
 177  *
 178  * Flags should be one of:
 179  * - @ref TRACKDB_NO_RECOVER
 180  * - @ref TRACKDB_NORMAL_RECOVER
 181  * - @ref TRACKDB_FATAL_RECOVER
 182  * - @ref TRACKDB_MAY_CREATE
 183  */
 184 void trackdb_init(int flags) {
 185   int err;
 186   const int recover = flags & TRACKDB_RECOVER_MASK;
 187   static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
 188
 189   /* sanity checks */
 190   assert(initialized == 0);
 191   ++initialized;
 192   if(home) {
 193     if(strcmp(home, config->home))
 194       fatal(0, "cannot change db home without server restart");
 195     home = config->home;
 196   }
 197
 198   if(flags & TRACKDB_MAY_CREATE) {
 199     DIR *dp;
 200     struct dirent *de;
 201     struct stat st;
 202     char *p;
 203
 204     /* Remove world/group permissions on any regular files already in the
 205      * database directory.  Actually we don't care about all of them but it's
 206      * easier to just do the lot.  This can be revisited if it's a serious
 207      * practical inconvenience for anyone.
 208      *
 209      * The socket, not being a regular file, is excepted.
 210      */
 211     if(!(dp = opendir(config->home)))
 212       fatal(errno, "error reading %s", config->home);
 213     while((de = readdir(dp))) {
 214       byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
 215       if(lstat(p, &st) == 0
 216          && S_ISREG(st.st_mode)
 217          && (st.st_mode & 077)) {
 218         if(chmod(p, st.st_mode & 07700) < 0)
 219           fatal(errno, "cannot chmod %s", p);
 220       }
 221       xfree(p);
 222     }
 223     closedir(dp);
 224   }
 225
 226   /* create environment */
 227   if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
 228                                                    db_strerror(err));
 229   if((err = trackdb_env->set_alloc(trackdb_env,
 230                                    xmalloc_noptr, xrealloc_noptr, xfree)))
 231     fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
 232   if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
 233     fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
 234   if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
 235     fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
 236   if((err = trackdb_env->open(trackdb_env, config->home,
 237                               DB_INIT_LOG
 238                               |DB_INIT_LOCK
 239                               |DB_INIT_MPOOL
 240                               |DB_INIT_TXN
 241                               |DB_CREATE
 242                               |recover_type[recover],
 243                               0600)))
 244     fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
 245   trackdb_env->set_errpfx(trackdb_env, "DB");
 246   trackdb_env->set_errfile(trackdb_env, stderr);
 247   trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
 248   trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
 249   trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
 250   D(("initialized database environment"));
 251 }
 252
 253 /* called when deadlock manager terminates */
 254 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
 255                             pid_t attribute((unused)) pid,
 256                             int status,
 257                             const struct rusage attribute((unused)) *rusage,
 258                             void attribute((unused)) *u) {
 259   db_deadlock_pid = -1;
 260   if(initialized)
 261     fatal(0, "deadlock manager unexpectedly terminated: %s",
 262           wstat(status));
 263   else
 264     D(("deadlock manager terminated: %s", wstat(status)));
 265   return 0;
 266 }
 267
 268 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
 269                         ...) {
 270   pid_t pid;
 271   va_list ap;
 272   const char *args[1024], **argp, *a;
 273
 274   argp = args;
 275   *argp++ = prog;
 276   *argp++ = "--config";
 277   *argp++ = configfile;
 278   *argp++ = debugging ? "--debug" : "--no-debug";
 279   *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
 280   va_start(ap, prog);
 281   while((a = va_arg(ap, const char *)))
 282     *argp++ = a;
 283   va_end(ap);
 284   *argp = 0;
 285   /* If we're in the background then trap subprocess stdout/stderr */
 286   if(!(pid = xfork())) {
 287     exitfn = _exit;
 288     if(ev)
 289       ev_signal_atfork(ev);
 290     signal(SIGPIPE, SIG_DFL);
 291     if(outputfd != -1) {
 292       xdup2(outputfd, 1);
 293       xclose(outputfd);
 294     }
 295     /* ensure we don't leak privilege anywhere */
 296     if(setuid(geteuid()) < 0)
 297       fatal(errno, "error calling setuid");
 298     /* If we were negatively niced, undo it.  We don't bother checking for
 299     * error, it's not that important. */
 300     setpriority(PRIO_PROCESS, 0, 0);
 301     execvp(prog, (char **)args);
 302     fatal(errno, "error invoking %s", prog);
 303   }
 304   return pid;
 305 }
 306
 307 /* start deadlock manager */
 308 void trackdb_master(ev_source *ev) {
 309   assert(db_deadlock_pid == -1);
 310   db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
 311   ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
 312   D(("started deadlock manager"));
 313 }
 314
 315 /* close environment */
 316 void trackdb_deinit(void) {
 317   int err;
 318
 319   /* sanity checks */
 320   assert(initialized == 1);
 321   --initialized;
 322
 323   /* close the environment */
 324   if((err = trackdb_env->close(trackdb_env, 0)))
 325     fatal(0, "trackdb_env->close: %s", db_strerror(err));
 326
 327   if(rescan_pid != -1) {
 328     /* shut down the rescanner */
 329     if(kill(rescan_pid, SIGTERM) < 0)
 330       fatal(errno, "error killing rescanner");
 331     /* wait for the rescanner to finish */
 332     while(waitpid(rescan_pid, &err, 0) == -1 && errno == EINTR)
 333       ;
 334   }
 335
 336   /* TODO kill any stats subprocesses */
 337
 338   /* finally terminate the deadlock manager */
 339   if(db_deadlock_pid != -1 && kill(db_deadlock_pid, SIGTERM) < 0)
 340     fatal(errno, "error killing deadlock manager");
 341   db_deadlock_pid = -1;
 342
 343   D(("deinitialized database environment"));
 344 }
 345
 346 /* open a specific database */
 347 static DB *open_db(const char *path,
 348                    u_int32_t dbflags,
 349                    DBTYPE dbtype,
 350                    u_int32_t openflags,
 351                    int mode) {
 352   int err;
 353   DB *db;
 354
 355   D(("open %s", path));
 356   path = config_get_file(path);
 357   if((err = db_create(&db, trackdb_env, 0)))
 358     fatal(0, "db_create %s: %s", path, db_strerror(err));
 359   if(dbflags)
 360     if((err = db->set_flags(db, dbflags)))
 361       fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
 362   if(dbtype == DB_BTREE)
 363     if((err = db->set_bt_compare(db, compare)))
 364       fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
 365   if((err = db->open(db, 0, path, 0, dbtype,
 366                      openflags | DB_AUTO_COMMIT, mode))) {
 367     if((openflags & DB_CREATE) || errno != ENOENT)
 368       fatal(0, "db->open %s: %s", path, db_strerror(err));
 369     db->close(db, 0);
 370     db = 0;
 371   }
 372   return db;
 373 }
 374
 375 /** @brief Open track databases
 376  * @param flags Flags flags word
 377  *
 378  * @p flags should have one of:
 379  * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
 380  * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
 381  * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
 382  * Also it may have:
 383  * - @p TRACKDB_READ_ONLY, read only access
 384  */
 385 void trackdb_open(int flags) {
 386   int err;
 387   pid_t pid;
 388   uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
 389
 390   /* sanity checks */
 391   assert(opened == 0);
 392   ++opened;
 393   /* check the database version first */
 394   trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
 395   if(trackdb_globaldb) {
 396     /* This is an existing database */
 397     const char *s;
 398     long oldversion;
 399
 400     s = trackdb_get_global("_dbversion");
 401     /* Close the database again,  we'll open it property below */
 402     if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
 403       fatal(0, "error closing global.db: %s", db_strerror(err));
 404     trackdb_globaldb = 0;
 405     /* Convert version string to an integer */
 406     oldversion = s ? atol(s) : 1;
 407     if(oldversion > config->dbversion) {
 408       /* Database is from the future; we never allow this. */
 409       fatal(0, "this version of DisOrder is too old for database version %ld",
 410             oldversion);
 411     }
 412     if(oldversion < config->dbversion) {
 413       /* Database version is out of date */
 414       switch(flags & TRACKDB_UPGRADE_MASK) {
 415       case TRACKDB_NO_UPGRADE:
 416         /* This database needs upgrading but this is not permitted */
 417         fatal(0, "database needs upgrading from %ld to %ld",
 418               oldversion, config->dbversion);
 419       case TRACKDB_CAN_UPGRADE:
 420         /* This database needs upgrading */
 421         info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
 422              oldversion, config->dbversion);
 423         pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
 424         while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
 425           ;
 426         if(err)
 427           fatal(0, "disorder-dbupgrade %s", wstat(err));
 428         info("disorder-dbupgrade succeeded");
 429         break;
 430       case TRACKDB_OPEN_FOR_UPGRADE:
 431         break;
 432       default:
 433         abort();
 434       }
 435     }
 436     if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
 437       /* This doesn't make any sense */
 438       fatal(0, "database is already at current version");
 439     }
 440     trackdb_existing_database = 1;
 441   } else {
 442     if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
 443       /* Cannot upgrade a new database */
 444       fatal(0, "cannot upgrade a database that does not exist");
 445     }
 446     /* This is a brand new database */
 447     trackdb_existing_database = 0;
 448   }
 449   /* open the databases */
 450   if(!(trackdb_usersdb = open_db("users.db",
 451                                  0, DB_HASH, dbflags, 0600)))
 452     fatal(0, "cannot open users.db");
 453   trackdb_tracksdb = open_db("tracks.db",
 454                              DB_RECNUM, DB_BTREE, dbflags, 0666);
 455   trackdb_searchdb = open_db("search.db",
 456                              DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
 457   trackdb_tagsdb = open_db("tags.db",
 458                            DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
 459   trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
 460   trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
 461   trackdb_noticeddb = open_db("noticed.db",
 462                              DB_DUPSORT, DB_BTREE, dbflags, 0666);
 463   if(!trackdb_existing_database) {
 464     /* Stash the database version */
 465     char buf[32];
 466
 467     assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
 468     snprintf(buf, sizeof buf, "%ld", config->dbversion);
 469     trackdb_set_global("_dbversion", buf, 0);
 470   }
 471   D(("opened databases"));
 472 }
 473
 474 /* close track databases */
 475 void trackdb_close(void) {
 476   int err;
 477
 478   /* sanity checks */
 479   assert(opened == 1);
 480   --opened;
 481   if((err = trackdb_tracksdb->close(trackdb_tracksdb, 0)))
 482     fatal(0, "error closing tracks.db: %s", db_strerror(err));
 483   if((err = trackdb_searchdb->close(trackdb_searchdb, 0)))
 484     fatal(0, "error closing search.db: %s", db_strerror(err));
 485   if((err = trackdb_tagsdb->close(trackdb_tagsdb, 0)))
 486     fatal(0, "error closing tags.db: %s", db_strerror(err));
 487   if((err = trackdb_prefsdb->close(trackdb_prefsdb, 0)))
 488     fatal(0, "error closing prefs.db: %s", db_strerror(err));
 489   if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
 490     fatal(0, "error closing global.db: %s", db_strerror(err));
 491   if((err = trackdb_noticeddb->close(trackdb_noticeddb, 0)))
 492     fatal(0, "error closing noticed.db: %s", db_strerror(err));
 493   if((err = trackdb_usersdb->close(trackdb_usersdb, 0)))
 494     fatal(0, "error closing users.db: %s", db_strerror(err));
 495   trackdb_tracksdb = trackdb_searchdb = trackdb_prefsdb = 0;
 496   trackdb_tagsdb = trackdb_globaldb = 0;
 497   D(("closed databases"));
 498 }
 499
 500 /* generic db routines *******************************************************/
 501
 502 /* fetch and decode a database entry.  Returns 0, DB_NOTFOUND or
 503  * DB_LOCK_DEADLOCK. */
 504 int trackdb_getdata(DB *db,
 505                     const char *track,
 506                     struct kvp **kp,
 507                     DB_TXN *tid) {
 508   int err;
 509   DBT key, data;
 510
 511   switch(err = db->get(db, tid, make_key(&key, track),
 512                        prepare_data(&data), 0)) {
 513   case 0:
 514     *kp = kvp_urldecode(data.data, data.size);
 515     return 0;
 516   case DB_NOTFOUND:
 517     *kp = 0;
 518     return err;
 519   case DB_LOCK_DEADLOCK:
 520     error(0, "error querying database: %s", db_strerror(err));
 521     return err;
 522   default:
 523     fatal(0, "error querying database: %s", db_strerror(err));
 524   }
 525 }
 526
 527 /* encode and store a database entry.  Returns 0, DB_KEYEXIST or
 528  * DB_LOCK_DEADLOCK. */
 529 int trackdb_putdata(DB *db,
 530                     const char *track,
 531                     const struct kvp *k,
 532                     DB_TXN *tid,
 533                     u_int32_t flags) {
 534   int err;
 535   DBT key, data;
 536
 537   switch(err = db->put(db, tid, make_key(&key, track),
 538                        encode_data(&data, k), flags)) {
 539   case 0:
 540   case DB_KEYEXIST:
 541     return err;
 542   case DB_LOCK_DEADLOCK:
 543     error(0, "error updating database: %s", db_strerror(err));
 544     return err;
 545   default:
 546     fatal(0, "error updating database: %s", db_strerror(err));
 547   }
 548 }
 549
 550 /** @brief Delete a database entry
 551  * @param db Database
 552  * @param track Key to delete
 553  * @param tid Transaction ID
 554  * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
 555  */
 556 int trackdb_delkey(DB *db,
 557                    const char *track,
 558                    DB_TXN *tid) {
 559   int err;
 560
 561   DBT key;
 562   switch(err = db->del(db, tid, make_key(&key, track), 0)) {
 563   case 0:
 564   case DB_NOTFOUND:
 565     return 0;
 566   case DB_LOCK_DEADLOCK:
 567     error(0, "error updating database: %s", db_strerror(err));
 568     return err;
 569   default:
 570     fatal(0, "error updating database: %s", db_strerror(err));
 571   }
 572 }
 573
 574 /* open a database cursor */
 575 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
 576   int err;
 577   DBC *c;
 578
 579   switch(err = db->cursor(db, tid, &c, 0)) {
 580   case 0: break;
 581   default: fatal(0, "error creating cursor: %s", db_strerror(err));
 582   }
 583   return c;
 584 }
 585
 586 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
 587 int trackdb_closecursor(DBC *c) {
 588   int err;
 589
 590   if(!c) return 0;
 591   switch(err = c->c_close(c)) {
 592   case 0:
 593     return err;
 594   case DB_LOCK_DEADLOCK:
 595     error(0, "error closing cursor: %s", db_strerror(err));
 596     return err;
 597   default:
 598     fatal(0, "error closing cursor: %s", db_strerror(err));
 599   }
 600 }
 601
 602 /* delete a (key,data) pair.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
 603 int trackdb_delkeydata(DB *db,
 604                        const char *word,
 605                        const char *track,
 606                        DB_TXN *tid) {
 607   int err;
 608   DBC *c;
 609   DBT key, data;
 610
 611   c = trackdb_opencursor(db, tid);
 612   switch(err = c->c_get(c, make_key(&key, word),
 613                         make_key(&data, track), DB_GET_BOTH)) {
 614   case 0:
 615     switch(err = c->c_del(c, 0)) {
 616     case 0:
 617       break;
 618     case DB_KEYEMPTY:
 619       err = 0;
 620       break;
 621     case DB_LOCK_DEADLOCK:
 622       error(0, "error updating database: %s", db_strerror(err));
 623       break;
 624     default:
 625       fatal(0, "c->c_del: %s", db_strerror(err));
 626     }
 627     break;
 628   case DB_NOTFOUND:
 629     break;
 630   case DB_LOCK_DEADLOCK:
 631     error(0, "error updating database: %s", db_strerror(err));
 632     break;
 633   default:
 634     fatal(0, "c->c_get: %s", db_strerror(err));
 635   }
 636   if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
 637   return err;
 638 }
 639
 640 /* start a transaction */
 641 DB_TXN *trackdb_begin_transaction(void) {
 642   DB_TXN *tid;
 643   int err;
 644
 645   if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
 646     fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
 647   return tid;
 648 }
 649
 650 /* abort transaction */
 651 void trackdb_abort_transaction(DB_TXN *tid) {
 652   int err;
 653
 654   if(tid)
 655     if((err = tid->abort(tid)))
 656       fatal(0, "tid->abort: %s", db_strerror(err));
 657 }
 658
 659 /* commit transaction */
 660 void trackdb_commit_transaction(DB_TXN *tid) {
 661   int err;
 662
 663   if((err = tid->commit(tid, 0)))
 664     fatal(0, "tid->commit: %s", db_strerror(err));
 665 }
 666
 667 /* search/tags shared code ***************************************************/
 668
 669 /* comparison function used by dedupe() */
 670 static int wordcmp(const void *a, const void *b) {
 671   return strcmp(*(const char **)a, *(const char **)b);
 672 }
 673
 674 /* sort and de-dupe VEC */
 675 static char **dedupe(char **vec, int nvec) {
 676   int m, n;
 677
 678   qsort(vec, nvec, sizeof (char *), wordcmp);
 679   m = n = 0;
 680   if(nvec) {
 681     vec[m++] = vec[0];
 682     for(n = 1; n < nvec; ++n)
 683       if(strcmp(vec[n], vec[m - 1]))
 684         vec[m++] = vec[n];
 685   }
 686   vec[m] = 0;
 687   return vec;
 688 }
 689
 690 /* update a key/track database.  Returns 0 or DB_DEADLOCK. */
 691 static int register_word(DB *db, const char *what,
 692                          const char *track, const char *word,
 693                          DB_TXN *tid) {
 694   int err;
 695   DBT key, data;
 696
 697   switch(err = db->put(db, tid, make_key(&key, word),
 698                        make_key(&data, track), DB_NODUPDATA)) {
 699   case 0:
 700   case DB_KEYEXIST:
 701     return 0;
 702   case DB_LOCK_DEADLOCK:
 703     error(0, "error updating %s.db: %s", what, db_strerror(err));
 704     return err;
 705   default:
 706     fatal(0, "error updating %s.db: %s", what,  db_strerror(err));
 707   }
 708 }
 709
 710 /* search primitives *********************************************************/
 711
 712 /* return true iff NAME is a trackname_display_ pref */
 713 static int is_display_pref(const char *name) {
 714   static const char prefix[] = "trackname_display_";
 715   return !strncmp(name, prefix, (sizeof prefix) - 1);
 716 }
 717
 718 /** @brief Word_Break property tailor that treats underscores as spaces */
 719 static int tailor_underscore_Word_Break_Other(uint32_t c) {
 720   switch(c) {
 721   default:
 722     return -1;
 723   case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
 724     return unicode_Word_Break_Other;
 725   }
 726 }
 727
 728 /** @brief Remove all combining characters in-place
 729  * @param s Pointer to start of string
 730  * @param ns Length of string
 731  * @return New, possiblby reduced, length
 732  */
 733 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
 734   uint32_t *start = s, *t = s, *end = s + ns;
 735
 736   while(s < end) {
 737     const uint32_t c = *s++;
 738     if(!utf32_combining_class(c))
 739       *t++ = c;
 740   }
 741   return t - start;
 742 }
 743
 744 /** @brief Normalize and split a string using a given tailoring */
 745 static void word_split(struct vector *v,
 746                        const char *s,
 747                        unicode_property_tailor *pt) {
 748   size_t nw, nt32, i;
 749   uint32_t *t32, **w32;
 750
 751   /* Convert to UTF-32 */
 752   if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
 753     return;
 754   /* Erase case distinctions */
 755   if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
 756     return;
 757   /* Drop combining characters */
 758   nt32 = remove_combining_chars(t32, nt32);
 759   /* Split into words, treating _ as a space */
 760   w32 = utf32_word_split(t32, nt32, &nw, pt);
 761   /* Convert words back to UTF-8 and append to result */
 762   for(i = 0; i < nw; ++i)
 763     vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
 764 }
 765
 766 /** @brief Normalize a tag
 767  * @param s Tag
 768  * @param ns Length of tag
 769  * @return Normalized string or NULL on error
 770  *
 771  * The return value will be:
 772  * - case-folded
 773  * - have no leading or trailing space
 774  * - have no combining characters
 775  * - all spacing between words will be a single U+0020 SPACE
 776  */
 777 static char *normalize_tag(const char *s, size_t ns) {
 778   uint32_t *s32, **w32;
 779   size_t ns32, nw32, i;
 780   struct dynstr d[1];
 781
 782   if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
 783     return 0;
 784   if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
 785     return 0;
 786   ns32 = remove_combining_chars(s32, ns32);
 787   /* Split into words, no Word_Break tailoring */
 788   w32 = utf32_word_split(s32, ns32, &nw32, 0);
 789   /* Compose back into a string */
 790   dynstr_init(d);
 791   for(i = 0; i < nw32; ++i) {
 792     if(i)
 793       dynstr_append(d, ' ');
 794     dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
 795   }
 796   dynstr_terminate(d);
 797   return d->vec;
 798 }
 799
 800 /* compute the words of a track name */
 801 static char **track_to_words(const char *track,
 802                              const struct kvp *p) {
 803   struct vector v;
 804   const char *rootless = track_rootless(track);
 805
 806   if(!rootless)
 807     rootless = track;                   /* bodge */
 808   vector_init(&v);
 809   rootless = strip_extension(rootless);
 810   word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
 811   for(; p; p = p->next)
 812     if(is_display_pref(p->name))
 813       word_split(&v, p->value, 0);
 814   vector_terminate(&v);
 815   return dedupe(v.vec, v.nvec);
 816 }
 817
 818 /* return nonzero iff WORD is a stopword */
 819 static int stopword(const char *word) {
 820   int n;
 821
 822   for(n = 0; n < config->stopword.n
 823         && strcmp(word, config->stopword.s[n]); ++n)
 824     ;
 825   return n < config->stopword.n;
 826 }
 827
 828 /* record that WORD appears in TRACK.  Returns 0 or DB_LOCK_DEADLOCK. */
 829 static int register_search_word(const char *track, const char *word,
 830                                 DB_TXN *tid) {
 831   if(stopword(word)) return 0;
 832   return register_word(trackdb_searchdb, "search", track, word, tid);
 833 }
 834
 835 /* Tags **********************************************************************/
 836
 837 /* Return nonzero if C is a valid tag character */
 838 static int tagchar(int c) {
 839   switch(c) {
 840   case ',':
 841     return 0;
 842   default:
 843     return c >= ' ';
 844   }
 845 }
 846
 847 /* Parse and de-dupe a tag list.  If S=0 then assumes "". */
 848 char **parsetags(const char *s) {
 849   const char *t;
 850   struct vector v;
 851
 852   vector_init(&v);
 853   if(s) {
 854     /* skip initial separators */
 855     while(*s && (!tagchar(*s) || *s == ' '))
 856       ++s;
 857     while(*s) {
 858       /* find the extent of the tag */
 859       t = s;
 860       while(*s && tagchar(*s))
 861         ++s;
 862       /* strip trailing spaces */
 863       while(s > t && s[-1] == ' ')
 864         --s;
 865       /* add tag to list */
 866       vector_append(&v, normalize_tag(t, (size_t)(s - t)));
 867       /* skip intermediate and trailing separators */
 868       while(*s && (!tagchar(*s) || *s == ' '))
 869         ++s;
 870     }
 871   }
 872   vector_terminate(&v);
 873   return dedupe(v.vec, v.nvec);
 874 }
 875
 876 /* Record that TRACK has TAG.  Returns 0 or DB_LOCK_DEADLOCK. */
 877 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
 878   return register_word(trackdb_tagsdb, "tags", track, tag, tid);
 879 }
 880
 881 /* aliases *******************************************************************/
 882
 883 /* compute the alias and store at aliasp.  Returns 0 or DB_LOCK_DEADLOCK.  If
 884  * there is no alias sets *aliasp to 0. */
 885 static int compute_alias(char **aliasp,
 886                          const char *track,
 887                          const struct kvp *p,
 888                          DB_TXN *tid) {
 889   struct dynstr d;
 890   const char *s = config->alias, *t, *expansion, *part;
 891   int c, used_db = 0, slash_prefix, err;
 892   struct kvp *at;
 893   const char *const root = find_track_root(track);
 894
 895   if(!root) {
 896     /* Bodge for tracks with no root */
 897     *aliasp = 0;
 898     return 0;
 899   }
 900   dynstr_init(&d);
 901   dynstr_append_string(&d, root);
 902   while((c = (unsigned char)*s++)) {
 903     if(c != '{') {
 904       dynstr_append(&d, c);
 905       continue;
 906     }
 907     if((slash_prefix = (*s == '/')))
 908       s++;
 909     t = strchr(s, '}');
 910     assert(t != 0);                     /* validated at startup */
 911     part = xstrndup(s, t - s);
 912     expansion = getpart(track, "display", part, p, &used_db);
 913     if(*expansion) {
 914       if(slash_prefix) dynstr_append(&d, '/');
 915       dynstr_append_string(&d, expansion);
 916     }
 917     s = t + 1;                          /* skip {part} */
 918   }
 919   /* only admit to the alias if we used the db... */
 920   if(!used_db) {
 921     *aliasp = 0;
 922     return 0;
 923   }
 924   dynstr_terminate(&d);
 925   /* ...and the answer differs from the original... */
 926   if(!strcmp(track, d.vec)) {
 927     *aliasp = 0;
 928     return 0;
 929   }
 930   /* ...and there isn't already a different track with that name (including as
 931    * an alias) */
 932   switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
 933   case 0:
 934     if((s = kvp_get(at, "_alias_for"))
 935        && !strcmp(s, track)) {
 936     case DB_NOTFOUND:
 937       *aliasp = d.vec;
 938     } else {
 939       *aliasp = 0;
 940     }
 941     return 0;
 942   default:
 943     return err;
 944   }
 945 }
 946
 947 /* get track and prefs data (if tp/pp not null pointers).  Returns 0 on
 948  * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
 949  * Always sets the return values, even if only to null pointers. */
 950 static int gettrackdata(const char *track,
 951                         struct kvp **tp,
 952                         struct kvp **pp,
 953                         const char **actualp,
 954                         unsigned flags,
 955 #define GTD_NOALIAS 0x0001
 956                         DB_TXN *tid) {
 957   int err;
 958   const char *actual = track;
 959   struct kvp *t = 0, *p = 0;
 960
 961   if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
 962   if((actual = kvp_get(t, "_alias_for"))) {
 963     if(flags & GTD_NOALIAS) {
 964       error(0, "alias passed to gettrackdata where real path required");
 965       abort();
 966     }
 967     if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
 968   } else
 969     actual = track;
 970   assert(actual != 0);
 971   if(pp) {
 972     if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
 973       goto done;
 974   }
 975   err = 0;
 976 done:
 977   if(actualp) *actualp = actual;
 978   if(tp) *tp = t;
 979   if(pp) *pp = p;
 980   return err;
 981 }
 982
 983 /* trackdb_notice() **********************************************************/
 984
 985 /** @brief notice a possibly new track
 986  * @return @c DB_NOTFOUND if new, 0 if already known
 987  */
 988 int trackdb_notice(const char *track,
 989                    const char *path) {
 990   int err;
 991   DB_TXN *tid;
 992
 993   for(;;) {
 994     tid = trackdb_begin_transaction();
 995     err = trackdb_notice_tid(track, path, tid);
 996     if((err == DB_LOCK_DEADLOCK)) goto fail;
 997     break;
 998   fail:
 999     trackdb_abort_transaction(tid);
1000   }
1001   trackdb_commit_transaction(tid);
1002   return err;
1003 }
1004
1005 /** @brief notice a possibly new track
1006  * @param track NFC UTF-8 track name
1007  * @param path Raw path name
1008  * @param tid Transaction ID
1009  * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1010  */
1011 int trackdb_notice_tid(const char *track,
1012                        const char *path,
1013                        DB_TXN *tid) {
1014   int err, n;
1015   struct kvp *t, *a, *p;
1016   int t_changed, ret;
1017   char *alias, **w, *noticed;
1018   time_t now;
1019
1020   /* notice whether the tracks.db entry changes */
1021   t_changed = 0;
1022   /* get any existing tracks entry */
1023   if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1024     return err;
1025   ret = err;                            /* 0 or DB_NOTFOUND */
1026   /* this is a real track */
1027   t_changed += kvp_set(&t, "_alias_for", 0);
1028   t_changed += kvp_set(&t, "_path", path);
1029   time(&now);
1030   if(ret == DB_NOTFOUND) {
1031     /* It's a new track; record the time */
1032     byte_xasprintf(&noticed, "%lld", (long long)now);
1033     t_changed += kvp_set(&t, "_noticed", noticed);
1034   }
1035   /* if we have an alias record it in the database */
1036   if((err = compute_alias(&alias, track, p, tid))) return err;
1037   if(alias) {
1038     /* won't overwrite someone else's alias as compute_alias() checks */
1039     D(("%s: alias %s", track, alias));
1040     a = 0;
1041     kvp_set(&a, "_alias_for", track);
1042     if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1043   }
1044   /* update search.db */
1045   w = track_to_words(track, p);
1046   for(n = 0; w[n]; ++n)
1047     if((err = register_search_word(track, w[n], tid)))
1048       return err;
1049   /* update tags.db */
1050   w = parsetags(kvp_get(p, "tags"));
1051   for(n = 0; w[n]; ++n)
1052     if((err = register_tag(track, w[n], tid)))
1053       return err;
1054   /* only store the tracks.db entry if it has changed */
1055   if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1056     return err;
1057   if(ret == DB_NOTFOUND) {
1058     uint32_t timestamp[2];
1059     DBT key, data;
1060
1061     timestamp[0] = htonl((uint64_t)now >> 32);
1062     timestamp[1] = htonl((uint32_t)now);
1063     memset(&key, 0, sizeof key);
1064     key.data = timestamp;
1065     key.size = sizeof timestamp;
1066     switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1067                                         make_key(&data, track), 0)) {
1068     case 0: break;
1069     case DB_LOCK_DEADLOCK: return err;
1070     default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1071     }
1072   }
1073   return ret;
1074 }
1075
1076 /* trackdb_obsolete() ********************************************************/
1077
1078 /* obsolete a track */
1079 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1080   int err, n;
1081   struct kvp *p;
1082   char *alias, **w;
1083
1084   if((err = gettrackdata(track, 0, &p, 0,
1085                          GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1086     return err;
1087   else if(err == DB_NOTFOUND) return 0;
1088   /* compute the alias, if any, and delete it */
1089   if((err = compute_alias(&alias, track, p, tid))) return err;
1090   if(alias) {
1091     /* if the alias points to some other track then compute_alias won't
1092      * return it */
1093     if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1094        && err != DB_NOTFOUND)
1095       return err;
1096   }
1097   /* update search.db */
1098   w = track_to_words(track, p);
1099   for(n = 0; w[n]; ++n)
1100     if(trackdb_delkeydata(trackdb_searchdb,
1101                           w[n], track, tid) == DB_LOCK_DEADLOCK)
1102       return err;
1103   /* update tags.db */
1104   w = parsetags(kvp_get(p, "tags"));
1105   for(n = 0; w[n]; ++n)
1106     if(trackdb_delkeydata(trackdb_tagsdb,
1107                           w[n], track, tid) == DB_LOCK_DEADLOCK)
1108       return err;
1109   /* update tracks.db */
1110   if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1111     return err;
1112   /* We don't delete the prefs, so they survive temporary outages of the
1113    * (possibly virtual) track filesystem */
1114   return 0;
1115 }
1116
1117 /* trackdb_stats() ***********************************************************/
1118
1119 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1120 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1121
1122 static const struct statinfo {
1123   const char *name;
1124   size_t offset;
1125 } statinfo_hash[] = {
1126   H(hash_magic),
1127   H(hash_version),
1128   H(hash_nkeys),
1129   H(hash_ndata),
1130   H(hash_pagesize),
1131   H(hash_ffactor),
1132   H(hash_buckets),
1133   H(hash_free),
1134   H(hash_bfree),
1135   H(hash_bigpages),
1136   H(hash_big_bfree),
1137   H(hash_overflows),
1138   H(hash_ovfl_free),
1139   H(hash_dup),
1140   H(hash_dup_free),
1141 }, statinfo_btree[] = {
1142   B(bt_magic),
1143   B(bt_version),
1144   B(bt_nkeys),
1145   B(bt_ndata),
1146   B(bt_pagesize),
1147   B(bt_minkey),
1148   B(bt_re_len),
1149   B(bt_re_pad),
1150   B(bt_levels),
1151   B(bt_int_pg),
1152   B(bt_leaf_pg),
1153   B(bt_dup_pg),
1154   B(bt_over_pg),
1155   B(bt_free),
1156   B(bt_int_pgfree),
1157   B(bt_leaf_pgfree),
1158   B(bt_dup_pgfree),
1159   B(bt_over_pgfree),
1160 };
1161
1162 /* look up stats for DB */
1163 static int get_stats(struct vector *v,
1164                      DB *database,
1165                      const struct statinfo *si,
1166                      size_t nsi,
1167                      DB_TXN *tid) {
1168   void *sp;
1169   size_t n;
1170   char *str;
1171   int err;
1172
1173   if(database) {
1174     switch(err = database->stat(database, tid, &sp, 0)) {
1175     case 0:
1176       break;
1177     case DB_LOCK_DEADLOCK:
1178       error(0, "error querying database: %s", db_strerror(err));
1179       return err;
1180     default:
1181       fatal(0, "error querying database: %s", db_strerror(err));
1182     }
1183     for(n = 0; n < nsi; ++n) {
1184       byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1185                      (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1186       vector_append(v, str);
1187     }
1188   }
1189   return 0;
1190 }
1191
1192 /** @brief One entry in the search league */
1193 struct search_entry {
1194   char *word;
1195   int n;
1196 };
1197
1198 /** @brief Add a word to the search league
1199  * @param se Pointer to search league
1200  * @param count Maximum size for search league
1201  * @param nse Current size of search league
1202  * @param word New word, or NULL
1203  * @param n How often @p word appears
1204  * @return New size of search league
1205  */
1206 static int register_search_entry(struct search_entry *se,
1207                                  int count,
1208                                  int nse,
1209                                  char *word,
1210                                  int n) {
1211   int i;
1212
1213   if(word && (nse < count || n > se[nse - 1].n)) {
1214     /* Find the starting point */
1215     if(nse == count)
1216       i = nse - 1;
1217     else
1218       i = nse++;
1219     /* Find the insertion point */
1220     while(i > 0 && n > se[i - 1].n)
1221       --i;
1222     memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1223     se[i].word = word;
1224     se[i].n = n;
1225   }
1226   return nse;
1227 }
1228
1229 /* find the top COUNT words in the search database */
1230 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1231   struct search_entry *se;
1232   DBT k, d;
1233   DBC *cursor;
1234   int err, n = 0, nse = 0, i;
1235   char *word = 0;
1236   size_t wl = 0;
1237   char *str;
1238
1239   cursor = trackdb_opencursor(trackdb_searchdb, tid);
1240   se = xmalloc(count * sizeof *se);
1241   /* Walk across the whole database counting up the number of times each
1242    * word appears. */
1243   while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1244                               DB_NEXT))) {
1245     if(word && wl == k.size && !strncmp(word, k.data, wl))
1246       ++n;                              /* same word again */
1247     else {
1248       nse = register_search_entry(se, count, nse, word, n);
1249       word = xstrndup(k.data, wl = k.size);
1250       n = 1;
1251     }
1252   }
1253   switch(err) {
1254   case DB_NOTFOUND:
1255     err = 0;
1256     break;
1257   case DB_LOCK_DEADLOCK:
1258     error(0, "error querying search database: %s", db_strerror(err));
1259     break;
1260   default:
1261     fatal(0, "error querying search database: %s", db_strerror(err));
1262   }
1263   if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1264   if(err) return err;
1265   nse = register_search_entry(se, count, nse, word, n);
1266   byte_xasprintf(&str, "Top %d search words:", nse);
1267   vector_append(v, str);
1268   for(i = 0; i < nse; ++i) {
1269     byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1270     vector_append(v, str);
1271   }
1272   return 0;
1273 }
1274
1275 #define SI(what) statinfo_##what, \
1276                  sizeof statinfo_##what / sizeof (struct statinfo)
1277
1278 /* return a list of database stats */
1279 char **trackdb_stats(int *nstatsp) {
1280   DB_TXN *tid;
1281   struct vector v;
1282
1283   vector_init(&v);
1284   for(;;) {
1285     tid = trackdb_begin_transaction();
1286     v.nvec = 0;
1287     vector_append(&v, (char *)"Tracks database stats:");
1288     if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1289     vector_append(&v, (char *)"");
1290     vector_append(&v, (char *)"Search database stats:");
1291     if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1292     vector_append(&v, (char *)"");
1293     vector_append(&v, (char *)"Prefs database stats:");
1294     if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1295     vector_append(&v, (char *)"");
1296     if(search_league(&v, 10, tid)) goto fail;
1297     vector_terminate(&v);
1298     break;
1299 fail:
1300     trackdb_abort_transaction(tid);
1301   }
1302   trackdb_commit_transaction(tid);
1303   if(nstatsp) *nstatsp = v.nvec;
1304   return v.vec;
1305 }
1306
1307 struct stats_details {
1308   void (*done)(char *data, void *u);
1309   void *u;
1310   int exited;                           /* subprocess exited */
1311   int closed;                           /* pipe close */
1312   int wstat;                            /* wait status from subprocess */
1313   struct dynstr data[1];                /* data read from pipe */
1314 };
1315
1316 static void stats_complete(struct stats_details *d) {
1317   char *s;
1318
1319   if(!(d->exited && d->closed))
1320     return;
1321   byte_xasprintf(&s, "\n"
1322                  "Server stats:\n"
1323                  "track lookup cache hits: %lu\n"
1324                  "track lookup cache misses: %lu\n",
1325                  cache_files_hits,
1326                  cache_files_misses);
1327   dynstr_append_string(d->data, s);
1328   dynstr_terminate(d->data);
1329   d->done(d->data->vec, d->u);
1330 }
1331
1332 static int stats_finished(ev_source attribute((unused)) *ev,
1333                           pid_t attribute((unused)) pid,
1334                           int status,
1335                           const struct rusage attribute((unused)) *rusage,
1336                           void *u) {
1337   struct stats_details *const d = u;
1338
1339   d->exited = 1;
1340   if(status)
1341     error(0, "disorder-stats %s", wstat(status));
1342   stats_complete(d);
1343   return 0;
1344 }
1345
1346 static int stats_read(ev_source attribute((unused)) *ev,
1347                       ev_reader *reader,
1348                       void *ptr,
1349                       size_t bytes,
1350                       int eof,
1351                       void *u) {
1352   struct stats_details *const d = u;
1353
1354   dynstr_append_bytes(d->data, ptr, bytes);
1355   ev_reader_consume(reader, bytes);
1356   if(eof)
1357     d->closed = 1;
1358   stats_complete(d);
1359   return 0;
1360 }
1361
1362 static int stats_error(ev_source attribute((unused)) *ev,
1363                        int errno_value,
1364                        void *u) {
1365   struct stats_details *const d = u;
1366
1367   error(errno_value, "error reading from pipe to disorder-stats");
1368   d->closed = 1;
1369   stats_complete(d);
1370   return 0;
1371 }
1372
1373 void trackdb_stats_subprocess(ev_source *ev,
1374                               void (*done)(char *data, void *u),
1375                               void *u) {
1376   int p[2];
1377   pid_t pid;
1378   struct stats_details *d = xmalloc(sizeof *d);
1379
1380   dynstr_init(d->data);
1381   d->done = done;
1382   d->u = u;
1383   xpipe(p);
1384   pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1385   xclose(p[1]);
1386   ev_child(ev, pid, 0, stats_finished, d);
1387   ev_reader_new(ev, p[0], stats_read, stats_error, d, "disorder-stats reader");
1388 }
1389
1390 /* set a pref (remove if value=0) */
1391 int trackdb_set(const char *track,
1392                 const char *name,
1393                 const char *value) {
1394   struct kvp *t, *p, *a;
1395   DB_TXN *tid;
1396   int err, cmp;
1397   char *oldalias, *newalias, **oldtags = 0, **newtags;
1398
1399   if(value) {
1400     /* TODO: if value matches default then set value=0 */
1401   }
1402
1403   for(;;) {
1404     tid = trackdb_begin_transaction();
1405     if((err = gettrackdata(track, &t, &p, 0,
1406                            0, tid)) == DB_LOCK_DEADLOCK)
1407       goto fail;
1408     if(err == DB_NOTFOUND) break;
1409     if(name[0] == '_') {
1410       if(kvp_set(&t, name, value))
1411         if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1412           goto fail;
1413     } else {
1414       /* get the old alias name */
1415       if(compute_alias(&oldalias, track, p, tid)) goto fail;
1416       /* get the old tags */
1417       if(!strcmp(name, "tags"))
1418         oldtags = parsetags(kvp_get(p, "tags"));
1419       /* set the value */
1420       if(kvp_set(&p, name, value))
1421         if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1422           goto fail;
1423       /* compute the new alias name */
1424       if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1425       /* check whether alias has changed */
1426       if(!(oldalias == newalias
1427            || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1428         /* adjust alias records to fit change */
1429         if(oldalias
1430            && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1431           goto fail;
1432         if(newalias) {
1433           a = 0;
1434           kvp_set(&a, "_alias_for", track);
1435           if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1436         }
1437       }
1438       /* check whether tags have changed */
1439       if(!strcmp(name, "tags")) {
1440         newtags = parsetags(value);
1441         while(*oldtags || *newtags) {
1442           if(*oldtags && *newtags) {
1443             cmp = strcmp(*oldtags, *newtags);
1444             if(!cmp) {
1445               /* keeping this tag */
1446               ++oldtags;
1447               ++newtags;
1448             } else if(cmp < 0)
1449               /* old tag fits into a gap in the new list, so delete old */
1450               goto delete_old;
1451             else
1452               /* new tag fits into a gap in the old list, so insert new */
1453               goto insert_new;
1454           } else if(*oldtags) {
1455             /* we've run out of new tags, so remaining old ones are to be
1456              * deleted */
1457           delete_old:
1458             if(trackdb_delkeydata(trackdb_tagsdb,
1459                                   *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1460               goto fail;
1461             ++oldtags;
1462           } else {
1463             /* we've run out of old tags, so remainig new ones are to be
1464              * inserted */
1465           insert_new:
1466             if(register_tag(track, *newtags, tid)) goto fail;
1467             ++newtags;
1468           }
1469         }
1470       }
1471     }
1472     err = 0;
1473     break;
1474 fail:
1475     trackdb_abort_transaction(tid);
1476   }
1477   trackdb_commit_transaction(tid);
1478   return err == 0 ? 0 : -1;
1479 }
1480
1481 /* get a pref */
1482 const char *trackdb_get(const char *track,
1483                         const char *name) {
1484   return kvp_get(trackdb_get_all(track), name);
1485 }
1486
1487 /* get all prefs as a 0-terminated array */
1488 struct kvp *trackdb_get_all(const char *track) {
1489   struct kvp *t, *p, **pp;
1490   DB_TXN *tid;
1491
1492   for(;;) {
1493     tid = trackdb_begin_transaction();
1494     if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1495       goto fail;
1496     break;
1497 fail:
1498     trackdb_abort_transaction(tid);
1499   }
1500   trackdb_commit_transaction(tid);
1501   for(pp = &p; *pp; pp = &(*pp)->next)
1502     ;
1503   *pp = t;
1504   return p;
1505 }
1506
1507 /* resolve alias */
1508 const char *trackdb_resolve(const char *track) {
1509   DB_TXN *tid;
1510   const char *actual;
1511
1512   for(;;) {
1513     tid = trackdb_begin_transaction();
1514     if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1515       goto fail;
1516     break;
1517 fail:
1518     trackdb_abort_transaction(tid);
1519   }
1520   trackdb_commit_transaction(tid);
1521   return actual;
1522 }
1523
1524 int trackdb_isalias(const char *track) {
1525   const char *actual = trackdb_resolve(track);
1526
1527   return strcmp(actual, track);
1528 }
1529
1530 /* test whether a track exists (perhaps an alias) */
1531 int trackdb_exists(const char *track) {
1532   DB_TXN *tid;
1533   int err;
1534
1535   for(;;) {
1536     tid = trackdb_begin_transaction();
1537     /* unusually, here we want the return value */
1538     if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1539       goto fail;
1540     break;
1541 fail:
1542     trackdb_abort_transaction(tid);
1543   }
1544   trackdb_commit_transaction(tid);
1545   return (err == 0);
1546 }
1547
1548 /* return the list of tags */
1549 char **trackdb_alltags(void) {
1550   int e;
1551   struct vector v[1];
1552
1553   vector_init(v);
1554   WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1555   return v->vec;
1556 }
1557
1558 /** @brief List all the keys in @p db
1559  * @param db Database
1560  * @param v Vector to store keys in
1561  * @param tid Transaction ID
1562  * @return 0 or DB_LOCK_DEADLOCK
1563  */
1564 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1565   int e;
1566   DBT k, d;
1567   DBC *const c = trackdb_opencursor(db, tid);
1568
1569   v->nvec = 0;
1570   memset(&k, 0, sizeof k);
1571   while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1572     vector_append(v, xstrndup(k.data, k.size));
1573   switch(e) {
1574   case DB_NOTFOUND:
1575     break;
1576   case DB_LOCK_DEADLOCK:
1577     return e;
1578   default:
1579     fatal(0, "c->c_get: %s", db_strerror(e));
1580   }
1581   if((e = trackdb_closecursor(c)))
1582     return e;
1583   vector_terminate(v);
1584   return 0;
1585 }
1586
1587 /* return 1 iff sorted tag lists A and B have at least one member in common */
1588 int tag_intersection(char **a, char **b) {
1589   int cmp;
1590
1591   /* Same sort of logic as trackdb_set() above */
1592   while(*a && *b) {
1593     if(!(cmp = strcmp(*a, *b))) return 1;
1594     else if(cmp < 0) ++a;
1595     else ++b;
1596   }
1597   return 0;
1598 }
1599
1600 static pid_t choose_pid = -1;
1601 static int choose_fd;
1602 static random_callback *choose_callback;
1603 static struct dynstr choose_output;
1604 static unsigned choose_complete;
1605 static int choose_status;
1606 #define CHOOSE_RUNNING 1
1607 #define CHOOSE_READING 2
1608
1609 static void choose_finished(ev_source *ev, unsigned which) {
1610   choose_complete |= which;
1611   if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
1612     return;
1613   choose_pid = -1;
1614   if(choose_status == 0 && choose_output.nvec > 0) {
1615     dynstr_terminate(&choose_output);
1616     choose_callback(ev, xstrdup(choose_output.vec));
1617   } else
1618     choose_callback(ev, 0);
1619 }
1620
1621 /** @brief Called when @c disorder-choose terminates */
1622 static int choose_exited(ev_source *ev,
1623                          pid_t attribute((unused)) pid,
1624                          int status,
1625                          const struct rusage attribute((unused)) *rusage,
1626                          void attribute((unused)) *u) {
1627   if(status)
1628     error(0, "disorder-choose %s", wstat(status));
1629   choose_status = status;
1630   choose_finished(ev, CHOOSE_RUNNING);
1631   return 0;
1632 }
1633
1634 /** @brief Called with data from @c disorder-choose pipe */
1635 static int choose_readable(ev_source *ev,
1636                            ev_reader *reader,
1637                            void *ptr,
1638                            size_t bytes,
1639                            int eof,
1640                            void attribute((unused)) *u) {
1641   dynstr_append_bytes(&choose_output, ptr, bytes);
1642   ev_reader_consume(reader, bytes);
1643   if(eof)
1644     choose_finished(ev, CHOOSE_READING);
1645   return 0;
1646 }
1647
1648 static int choose_read_error(ev_source *ev,
1649                              int errno_value,
1650                              void attribute((unused)) *u) {
1651   error(errno_value, "error reading disorder-choose pipe");
1652   choose_finished(ev, CHOOSE_READING);
1653   return 0;
1654 }
1655
1656 /** @brief Request a random track
1657  * @param ev Event source
1658  * @param callback Called with random track or NULL
1659  * @return 0 if a request was initiated, else -1
1660  *
1661  * Initiates a random track choice.  @p callback will later be called back with
1662  * the choice (or NULL on error).  If a choice is already underway then -1 is
1663  * returned and there will be no additional callback.
1664  *
1665  * The caller shouldn't assume that the track returned actually exists (it
1666  * might be removed between the choice and the callback, or between being added
1667  * to the queue and being played).
1668  */
1669 int trackdb_request_random(ev_source *ev,
1670                            random_callback *callback) {
1671   int p[2];
1672
1673   if(choose_pid != -1)
1674     return -1;                          /* don't run concurrent chooses */
1675   xpipe(p);
1676   cloexec(p[0]);
1677   choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
1678   choose_fd = p[0];
1679   xclose(p[1]);
1680   choose_callback = callback;
1681   choose_output.nvec = 0;
1682   choose_complete = 0;
1683   ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
1684                 "disorder-choose reader"); /* owns p[0] */
1685   ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
1686   return 0;
1687 }
1688
1689 /* get a track name given the prefs.  Set *used_db to 1 if we got the answer
1690  * from the prefs. */
1691 static const char *getpart(const char *track,
1692                            const char *context,
1693                            const char *part,
1694                            const struct kvp *p,
1695                            int *used_db) {
1696   const char *result;
1697   char *pref;
1698
1699   byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1700   if((result = kvp_get(p, pref)))
1701     *used_db = 1;
1702   else
1703     result = trackname_part(track, context, part);
1704   assert(result != 0);
1705   return result;
1706 }
1707
1708 /* get a track name part, like trackname_part(), but taking the database into
1709  * account. */
1710 const char *trackdb_getpart(const char *track,
1711                             const char *context,
1712                             const char *part) {
1713   struct kvp *p;
1714   DB_TXN *tid;
1715   char *pref;
1716   const char *actual;
1717   int used_db, err;
1718
1719   /* construct the full pref */
1720   byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1721   for(;;) {
1722     tid = trackdb_begin_transaction();
1723     if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1724       goto fail;
1725     break;
1726 fail:
1727     trackdb_abort_transaction(tid);
1728   }
1729   trackdb_commit_transaction(tid);
1730   return getpart(actual, context, part, p, &used_db);
1731 }
1732
1733 /* get the raw path name for @track@ (might be an alias) */
1734 const char *trackdb_rawpath(const char *track) {
1735   DB_TXN *tid;
1736   struct kvp *t;
1737   const char *path;
1738
1739   for(;;) {
1740     tid = trackdb_begin_transaction();
1741     if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1742       goto fail;
1743     break;
1744 fail:
1745     trackdb_abort_transaction(tid);
1746   }
1747   trackdb_commit_transaction(tid);
1748   if(!(path = kvp_get(t, "_path"))) path = track;
1749   return path;
1750 }
1751
1752 /* trackdb_list **************************************************************/
1753
1754 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1755  * readable at some point */
1756
1757 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1758  * If RE is a null pointer then it matches everything. */
1759 static int track_matches(size_t dl, const char *track, size_t tl,
1760                          const pcre *re) {
1761   int ovec[3], rc;
1762
1763   if(!re)
1764     return 1;
1765   track += dl + 1;
1766   tl -= (dl + 1);
1767   switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1768   case PCRE_ERROR_NOMATCH: return 0;
1769   default:
1770     if(rc < 0) {
1771       error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1772       return 0;
1773     }
1774     return 1;
1775   }
1776 }
1777
1778 static int do_list(struct vector *v, const char *dir,
1779                    enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1780   DBC *cursor;
1781   DBT k, d;
1782   size_t dl;
1783   char *ptr;
1784   int err;
1785   size_t l, last_dir_len = 0;
1786   char *last_dir = 0, *track, *alias;
1787   struct kvp *p;
1788
1789   dl = strlen(dir);
1790   cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1791   make_key(&k, dir);
1792   prepare_data(&d);
1793   /* find the first key >= dir */
1794   err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1795   /* keep going while we're dealing with <dir/anything> */
1796   while(err == 0
1797         && k.size > dl
1798         && ((char *)k.data)[dl] == '/'
1799         && !memcmp(k.data, dir, dl)) {
1800     ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1801     if(ptr) {
1802       /* we have <dir/component/anything>, so <dir/component> is a directory */
1803       l = ptr - (char *)k.data;
1804       if(what & trackdb_directories)
1805         if(!(last_dir
1806              && l == last_dir_len
1807              && !memcmp(last_dir, k.data, l))) {
1808           last_dir = xstrndup(k.data, last_dir_len = l);
1809           if(track_matches(dl, k.data, l, re))
1810             vector_append(v, last_dir);
1811         }
1812     } else {
1813       /* found a plain file */
1814       if((what & trackdb_files)) {
1815         track = xstrndup(k.data, k.size);
1816         if((err = trackdb_getdata(trackdb_prefsdb,
1817                                   track, &p, tid)) == DB_LOCK_DEADLOCK)
1818           goto deadlocked;
1819         /* if this file has an alias in the same directory then we skip it */
1820         if((err = compute_alias(&alias, track, p, tid)))
1821           goto deadlocked;
1822         if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1823           if(track_matches(dl, k.data, k.size, re))
1824             vector_append(v, track);
1825       }
1826     }
1827     err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1828   }
1829   switch(err) {
1830   case 0:
1831     break;
1832   case DB_NOTFOUND:
1833     err = 0;
1834     break;
1835   case DB_LOCK_DEADLOCK:
1836     error(0, "error querying database: %s", db_strerror(err));
1837     break;
1838   default:
1839     fatal(0, "error querying database: %s", db_strerror(err));
1840   }
1841 deadlocked:
1842   if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1843   return err;
1844 }
1845
1846 /* return the directories or files below @dir@ */
1847 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
1848                     const pcre *re) {
1849   DB_TXN *tid;
1850   int n;
1851   struct vector v;
1852
1853   vector_init(&v);
1854   for(;;) {
1855     tid = trackdb_begin_transaction();
1856     v.nvec = 0;
1857     if(dir) {
1858       if(do_list(&v, dir, what, re, tid))
1859         goto fail;
1860     } else {
1861       for(n = 0; n < config->collection.n; ++n)
1862         if(do_list(&v, config->collection.s[n].root, what, re, tid))
1863           goto fail;
1864     }
1865     break;
1866 fail:
1867     trackdb_abort_transaction(tid);
1868   }
1869   trackdb_commit_transaction(tid);
1870   vector_terminate(&v);
1871   if(np)
1872     *np = v.nvec;
1873   return v.vec;
1874 }
1875
1876 /* If S is tag:something, return something.  Else return 0. */
1877 static const char *checktag(const char *s) {
1878   if(!strncmp(s, "tag:", 4))
1879     return s + 4;
1880   else
1881     return 0;
1882 }
1883
1884 /* return a list of tracks containing all of the words given.  If you
1885  * ask for only stopwords you get no tracks. */
1886 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
1887   const char **w, *best = 0, *tag;
1888   char **twords, **tags;
1889   char *istag;
1890   int i, j, n, err, what;
1891   DBC *cursor = 0;
1892   DBT k, d;
1893   struct vector u, v;
1894   DB_TXN *tid;
1895   struct kvp *p;
1896   int ntags = 0;
1897   DB *db;
1898   const char *dbname;
1899
1900   *ntracks = 0;                         /* for early returns */
1901   /* normalize all the words */
1902   w = xmalloc(nwordlist * sizeof (char *));
1903   istag = xmalloc_noptr(nwordlist);
1904   for(n = 0; n < nwordlist; ++n) {
1905     uint32_t *w32;
1906     size_t nw32;
1907
1908     w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
1909     if(checktag(w[n])) {
1910       ++ntags;         /* count up tags */
1911       /* Normalize the tag */
1912       w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
1913       istag[n] = 1;
1914     } else {
1915       /* Normalize the search term by removing combining characters */
1916       if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
1917         return 0;
1918       nw32 = remove_combining_chars(w32, nw32);
1919       if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
1920         return 0;
1921       istag[n] = 0;
1922     }
1923   }
1924   /* find the longest non-stopword */
1925   for(n = 0; n < nwordlist; ++n)
1926     if(!istag[n] && !stopword(w[n]))
1927       if(!best || strlen(w[n]) > strlen(best))
1928         best = w[n];
1929   /* TODO: we should at least in principal be able to identify the word or tag
1930    * with the least matches in log time, and choose that as our primary search
1931    * term. */
1932   if(ntags && !best) {
1933     /* Only tags are listed.  We limit to the first and narrow down with the
1934      * rest. */
1935     best = istag[0] ? w[0] : 0;
1936     db = trackdb_tagsdb;
1937     dbname = "tags";
1938   } else if(best) {
1939     /* We can limit to some word. */
1940     db = trackdb_searchdb;
1941     dbname = "search";
1942   } else {
1943     /* Only stopwords */
1944     return 0;
1945   }
1946   vector_init(&u);
1947   vector_init(&v);
1948   for(;;) {
1949     tid = trackdb_begin_transaction();
1950     /* find all the tracks that have that word */
1951     make_key(&k, best);
1952     prepare_data(&d);
1953     what = DB_SET;
1954     v.nvec = 0;
1955     cursor = trackdb_opencursor(db, tid);
1956     while(!(err = cursor->c_get(cursor, &k, &d, what))) {
1957       vector_append(&v, xstrndup(d.data, d.size));
1958       what = DB_NEXT_DUP;
1959     }
1960     switch(err) {
1961     case DB_NOTFOUND:
1962       err = 0;
1963       break;
1964     case DB_LOCK_DEADLOCK:
1965       error(0, "error querying %s database: %s", dbname, db_strerror(err));
1966       break;
1967     default:
1968       fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
1969     }
1970     if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1971     cursor = 0;
1972     /* do a naive search over that (hopefuly fairly small) list of tracks */
1973     u.nvec = 0;
1974     for(n = 0; n < v.nvec; ++n) {
1975       if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
1976         goto fail;
1977       else if(err) {
1978         error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
1979         continue;
1980       }
1981       twords = track_to_words(v.vec[n], p);
1982       tags = parsetags(kvp_get(p, "tags"));
1983       for(i = 0; i < nwordlist; ++i) {
1984         if(istag[i]) {
1985           tag = w[i];
1986           /* Track must have this tag */
1987           for(j = 0; tags[j]; ++j)
1988             if(!strcmp(tag, tags[j])) break; /* tag found */
1989           if(!tags[j]) break;           /* tag not found */
1990         } else {
1991           /* Track must contain this word */
1992           for(j = 0; twords[j]; ++j)
1993             if(!strcmp(w[i], twords[j])) break; /* word found */
1994           if(!twords[j]) break;         /* word not found */
1995         }
1996       }
1997       if(i >= nwordlist)                /* all words found */
1998         vector_append(&u, v.vec[n]);
1999     }
2000     break;
2001   fail:
2002     trackdb_closecursor(cursor);
2003     cursor = 0;
2004     trackdb_abort_transaction(tid);
2005     info("retrying search");
2006   }
2007   trackdb_commit_transaction(tid);
2008   vector_terminate(&u);
2009   if(ntracks)
2010     *ntracks = u.nvec;
2011   return u.vec;
2012 }
2013
2014 /* trackdb_scan **************************************************************/
2015
2016 int trackdb_scan(const char *root,
2017                  int (*callback)(const char *track,
2018                                  struct kvp *data,
2019                                  struct kvp *prefs,
2020                                  void *u,
2021                                  DB_TXN *tid),
2022                  void *u,
2023                  DB_TXN *tid) {
2024   DBC *cursor;
2025   DBT k, d, pd;
2026   const size_t root_len = root ? strlen(root) : 0;
2027   int err, cberr;
2028   struct kvp *data, *prefs;
2029   const char *track;
2030
2031   cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2032   if(root)
2033     err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2034                         DB_SET_RANGE);
2035   else {
2036     memset(&k, 0, sizeof k);
2037     err = cursor->c_get(cursor, &k, prepare_data(&d),
2038                         DB_FIRST);
2039   }
2040   while(!err) {
2041     if(!root
2042        || (k.size > root_len
2043            && !strncmp(k.data, root, root_len)
2044            && ((char *)k.data)[root_len] == '/')) {
2045       data = kvp_urldecode(d.data, d.size);
2046       if(kvp_get(data, "_path")) {
2047         track = xstrndup(k.data, k.size);
2048         /* TODO: trackdb_prefsdb is currently a DB_HASH.  This means we have to
2049          * do a lookup for every single track.  In fact this is quite quick:
2050          * with around 10,000 tracks a complete scan is around 0.3s on my
2051          * 2.2GHz Athlon.  However, if it were a DB_BTREE, we could do the same
2052          * linear walk as we already do over trackdb_tracksdb, and probably get
2053          * even higher performance.  That would require upgrade logic to
2054          * translate old databases though.
2055          */
2056         switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2057                                           prepare_data(&pd), 0)) {
2058         case 0:
2059           prefs = kvp_urldecode(pd.data, pd.size);
2060           break;
2061         case DB_NOTFOUND:
2062           prefs = 0;
2063           break;
2064         case DB_LOCK_DEADLOCK:
2065           error(0, "getting prefs: %s", db_strerror(err));
2066           trackdb_closecursor(cursor);
2067           return err;
2068         default:
2069           fatal(0, "getting prefs: %s", db_strerror(err));
2070         }
2071         /* Advance to the next track before the callback so that the callback
2072          * may safely delete the track */
2073         err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2074         if((cberr = callback(track, data, prefs, u, tid))) {
2075           err = cberr;
2076           break;
2077         }
2078       } else
2079         err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2080     } else
2081       break;
2082   }
2083   trackdb_closecursor(cursor);
2084   switch(err) {
2085   case EINTR:
2086     return err;
2087   case 0:
2088   case DB_NOTFOUND:
2089     return 0;
2090   case DB_LOCK_DEADLOCK:
2091     error(0, "c->c_get: %s", db_strerror(err));
2092     return err;
2093   default:
2094     fatal(0, "c->c_get: %s", db_strerror(err));
2095   }
2096 }
2097
2098 /* trackdb_rescan ************************************************************/
2099
2100 /* called when the rescanner terminates */
2101 static int reap_rescan(ev_source attribute((unused)) *ev,
2102                        pid_t pid,
2103                        int status,
2104                        const struct rusage attribute((unused)) *rusage,
2105                        void attribute((unused)) *u) {
2106   if(pid == rescan_pid) rescan_pid = -1;
2107   if(status)
2108     error(0, RESCAN": %s", wstat(status));
2109   else
2110     D((RESCAN" terminated: %s", wstat(status)));
2111   /* Our cache of file lookups is out of date now */
2112   cache_clean(&cache_files_type);
2113   eventlog("rescanned", (char *)0);
2114   return 0;
2115 }
2116
2117 /** @brief Initiate a rescan
2118  * @param ev Event loop or 0 to block
2119  * @param recheck 1 to recheck lengths, 0 to suppress check
2120  */
2121 void trackdb_rescan(ev_source *ev, int recheck) {
2122   int w;
2123
2124   if(rescan_pid != -1) {
2125     error(0, "rescan already underway");
2126     return;
2127   }
2128   rescan_pid = subprogram(ev, -1, RESCAN,
2129                           recheck ? "--check" : "--no-check",
2130                           (char *)0);
2131   if(ev) {
2132     ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2133     D(("started rescanner"));
2134   } else {
2135     /* This is the first rescan, we block until it is complete */
2136     while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2137       ;
2138     reap_rescan(0, rescan_pid, w, 0, 0);
2139   }
2140 }
2141
2142 int trackdb_rescan_cancel(void) {
2143   if(rescan_pid == -1) return 0;
2144   if(kill(rescan_pid, SIGTERM) < 0)
2145     fatal(errno, "error killing rescanner");
2146   rescan_pid = -1;
2147   return 1;
2148 }
2149
2150 /* global prefs **************************************************************/
2151
2152 void trackdb_set_global(const char *name,
2153                         const char *value,
2154                         const char *who) {
2155   DB_TXN *tid;
2156   int err;
2157   int state;
2158
2159   for(;;) {
2160     tid = trackdb_begin_transaction();
2161     if(!(err = trackdb_set_global_tid(name, value, tid)))
2162       break;
2163     trackdb_abort_transaction(tid);
2164   }
2165   trackdb_commit_transaction(tid);
2166   /* log important state changes */
2167   if(!strcmp(name, "playing")) {
2168     state = !value || !strcmp(value, "yes");
2169     info("playing %s by %s",
2170          state ? "enabled" : "disabled",
2171          who ? who : "-");
2172     eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2173   }
2174   if(!strcmp(name, "random-play")) {
2175     state = !value || !strcmp(value, "yes");
2176     info("random play %s by %s",
2177          state ? "enabled" : "disabled",
2178          who ? who : "-");
2179     eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2180   }
2181 }
2182
2183 int trackdb_set_global_tid(const char *name,
2184                            const char *value,
2185                            DB_TXN *tid) {
2186   DBT k, d;
2187   int err;
2188
2189   memset(&k, 0, sizeof k);
2190   memset(&d, 0, sizeof d);
2191   k.data = (void *)name;
2192   k.size = strlen(name);
2193   if(value) {
2194     d.data = (void *)value;
2195     d.size = strlen(value);
2196   }
2197   if(value)
2198     err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2199   else
2200     err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2201   if(err == DB_LOCK_DEADLOCK) return err;
2202   if(err)
2203     fatal(0, "error updating database: %s", db_strerror(err));
2204   return 0;
2205 }
2206
2207 const char *trackdb_get_global(const char *name) {
2208   DB_TXN *tid;
2209   int err;
2210   const char *r;
2211
2212   for(;;) {
2213     tid = trackdb_begin_transaction();
2214     if(!(err = trackdb_get_global_tid(name, tid, &r)))
2215       break;
2216     trackdb_abort_transaction(tid);
2217   }
2218   trackdb_commit_transaction(tid);
2219   return r;
2220 }
2221
2222 int trackdb_get_global_tid(const char *name,
2223                            DB_TXN *tid,
2224                            const char **rp) {
2225   DBT k, d;
2226   int err;
2227
2228   memset(&k, 0, sizeof k);
2229   k.data = (void *)name;
2230   k.size = strlen(name);
2231   switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2232                                      prepare_data(&d), 0)) {
2233   case 0:
2234     *rp = xstrndup(d.data, d.size);
2235     return 0;
2236   case DB_NOTFOUND:
2237     *rp = 0;
2238     return 0;
2239   case DB_LOCK_DEADLOCK:
2240     return err;
2241   default:
2242     fatal(0, "error reading database: %s", db_strerror(err));
2243   }
2244 }
2245
2246 /** @brief Retrieve the most recently added tracks
2247  * @param ntracksp Where to put count, or 0
2248  * @param maxtracks Maximum number of tracks to retrieve
2249  * @return null-terminated array of track names
2250  *
2251  * The most recently added track is first in the array.
2252  */
2253 char **trackdb_new(int *ntracksp,
2254                    int maxtracks) {
2255   DB_TXN *tid;
2256   char **tracks;
2257
2258   for(;;) {
2259     tid = trackdb_begin_transaction();
2260     tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2261     if(tracks)
2262       break;
2263     trackdb_abort_transaction(tid);
2264   }
2265   trackdb_commit_transaction(tid);
2266   return tracks;
2267 }
2268
2269 /** @brief Retrieve the most recently added tracks
2270  * @param ntracksp Where to put count, or 0
2271  * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2272  * @param tid Transaction ID
2273  * @return null-terminated array of track names, or NULL on deadlock
2274  *
2275  * The most recently added track is first in the array.
2276  */
2277 static char **trackdb_new_tid(int *ntracksp,
2278                               int maxtracks,
2279                               DB_TXN *tid) {
2280   DBC *c;
2281   DBT k, d;
2282   int err = 0;
2283   struct vector tracks[1];
2284
2285   vector_init(tracks);
2286   c = trackdb_opencursor(trackdb_noticeddb, tid);
2287   while((maxtracks <= 0 || tracks->nvec < maxtracks)
2288         && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV)))
2289     vector_append(tracks, xstrndup(d.data, d.size));
2290   switch(err) {
2291   case 0:                               /* hit maxtracks */
2292   case DB_NOTFOUND:                     /* ran out of tracks */
2293     break;
2294   case DB_LOCK_DEADLOCK:
2295     trackdb_closecursor(c);
2296     return 0;
2297   default:
2298     fatal(0, "error reading noticed.db: %s", db_strerror(err));
2299   }
2300   if((err = trackdb_closecursor(c)))
2301     return 0;                           /* deadlock */
2302   vector_terminate(tracks);
2303   if(ntracksp)
2304     *ntracksp = tracks->nvec;
2305   return tracks->vec;
2306 }
2307
2308 /** @brief Expire noticed.db
2309  * @param earliest Earliest timestamp to keep
2310  */
2311 void trackdb_expire_noticed(time_t earliest) {
2312   DB_TXN *tid;
2313
2314   for(;;) {
2315     tid = trackdb_begin_transaction();
2316     if(!trackdb_expire_noticed_tid(earliest, tid))
2317       break;
2318     trackdb_abort_transaction(tid);
2319   }
2320   trackdb_commit_transaction(tid);
2321 }
2322
2323 /** @brief Expire noticed.db
2324  * @param earliest Earliest timestamp to keep
2325  * @param tid Transaction ID
2326  * @return 0 or DB_LOCK_DEADLOCK
2327  */
2328 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2329   DBC *c;
2330   DBT k, d;
2331   int err = 0, ret;
2332   time_t when;
2333   uint32_t *kk;
2334   int count = 0;
2335
2336   c = trackdb_opencursor(trackdb_noticeddb, tid);
2337   while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2338     kk = k.data;
2339     when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2340     if(when >= earliest)
2341       break;
2342     if((err = c->c_del(c, 0))) {
2343       if(err != DB_LOCK_DEADLOCK)
2344         fatal(0, "error deleting expired noticed.db entry: %s",
2345               db_strerror(err));
2346       break;
2347     }
2348     ++count;
2349   }
2350   if(err == DB_NOTFOUND)
2351     err = 0;
2352   if(err && err != DB_LOCK_DEADLOCK)
2353     fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2354   ret = err;
2355   if((err = trackdb_closecursor(c))) {
2356     if(err != DB_LOCK_DEADLOCK)
2357       fatal(0, "error closing cursor: %s", db_strerror(err));
2358     ret = err;
2359   }
2360   if(!ret && count)
2361     info("expired %d tracks from noticed.db", count);
2362   return ret;
2363 }
2364
2365 /* tidying up ****************************************************************/
2366
2367 void trackdb_gc(void) {
2368   int err;
2369   char **logfiles;
2370
2371   if((err = trackdb_env->txn_checkpoint(trackdb_env,
2372                                         config->checkpoint_kbyte,
2373                                         config->checkpoint_min,
2374                                         0)))
2375     fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2376   if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2377     fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2378   /* This makes catastrophic recovery impossible.  However, the user can still
2379    * preserve the important data by using disorder-dump to snapshot their
2380    * prefs, and later to restore it.  This is likely to have much small
2381    * long-term storage requirements than record the db logfiles. */
2382 }
2383
2384 /* user database *************************************************************/
2385
2386 /** @brief Return true if @p user is trusted */
2387 static int trusted(const char *user) {
2388   int n;
2389
2390   for(n = 0; (n < config->trust.n
2391               && strcmp(config->trust.s[n], user)); ++n)
2392     ;
2393   return n < config->trust.n;
2394 }
2395
2396 /** @brief Return non-zero for a valid username
2397  *
2398  * Currently we only allow the letters and digits in ASCII.  We could be more
2399  * liberal than this but it is a nice simple test.  It is critical that
2400  * semicolons are never allowed.
2401  */
2402 static int valid_username(const char *user) {
2403   if(!*user)
2404     return 0;
2405   while(*user) {
2406     const uint8_t c = *user++;
2407     /* For now we are very strict */
2408     if((c >= 'a' && c <= 'z')
2409        || (c >= 'A' && c <= 'Z')
2410        || (c >= '0' && c <= '9'))
2411       /* ok */;
2412     else
2413       return 0;
2414   }
2415   return 1;
2416 }
2417
2418 /** @brief Add a user */
2419 static int create_user(const char *user,
2420                        const char *password,
2421                        const char *rights,
2422                        const char *email,
2423                        const char *confirmation,
2424                        DB_TXN *tid,
2425                        uint32_t flags) {
2426   struct kvp *k = 0;
2427   char s[64];
2428
2429   /* sanity check user */
2430   if(!valid_username(user)) {
2431     error(0, "invalid username '%s'", user);
2432     return -1;
2433   }
2434   if(parse_rights(rights, 0, 1)) {
2435     error(0, "invalid rights string");
2436     return -1;
2437   }
2438   /* data for this user */
2439   if(password)
2440     kvp_set(&k, "password", password);
2441   kvp_set(&k, "rights", rights);
2442   if(email)
2443     kvp_set(&k, "email", email);
2444   if(confirmation)
2445     kvp_set(&k, "confirmation", confirmation);
2446   snprintf(s, sizeof s, "%jd", (intmax_t)time(0));
2447   kvp_set(&k, "created", s);
2448   return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2449 }
2450
2451 /** @brief Add one pre-existing user */
2452 static int one_old_user(const char *user, const char *password,
2453                         DB_TXN *tid) {
2454   const char *rights;
2455
2456   /* www-data doesn't get added */
2457   if(!strcmp(user, "www-data")) {
2458     info("not adding www-data to user database");
2459     return 0;
2460   }
2461   /* pick rights */
2462   if(!strcmp(user, "root"))
2463     rights = "all";
2464   else if(trusted(user)) {
2465     rights_type r;
2466
2467     parse_rights(config->default_rights, &r, 1);
2468     r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2469     r |= (RIGHT_ADMIN|RIGHT_RESCAN
2470           |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2471     rights = rights_string(r);
2472   } else
2473     rights = config->default_rights;
2474   return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2475                      tid, DB_NOOVERWRITE);
2476 }
2477
2478 static int trackdb_old_users_tid(DB_TXN *tid) {
2479   int n;
2480
2481   for(n = 0; n < config->allow.n; ++n) {
2482     switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2483                         tid)) {
2484     case 0:
2485       info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2486       break;
2487     case DB_KEYEXIST:
2488       error(0, "user %s already exists, delete 'allow' directive",
2489             config->allow.s[n].s[0]);
2490           /* This won't ever become fatal - eventually 'allow' will be
2491            * disabled. */
2492       break;
2493     case DB_LOCK_DEADLOCK:
2494       return DB_LOCK_DEADLOCK;
2495     }
2496   }
2497   return 0;
2498 }
2499
2500 /** @brief Read old 'allow' directives and copy them to the users database */
2501 void trackdb_old_users(void) {
2502   int e;
2503
2504   if(config->allow.n)
2505     WITH_TRANSACTION(trackdb_old_users_tid(tid));
2506 }
2507
2508 /** @brief Create a root user in the user database if there is none */
2509 void trackdb_create_root(void) {
2510   int e;
2511   uint8_t pwbin[12];
2512   char *pw;
2513
2514   /* Choose a new root password */
2515   gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2516   pw = mime_to_base64(pwbin, sizeof pwbin);
2517   /* Create the root user if it does not exist */
2518   WITH_TRANSACTION(create_user("root", pw, "all",
2519                                0/*email*/, 0/*confirmation*/,
2520                                tid, DB_NOOVERWRITE));
2521   if(e == 0)
2522     info("created root user");
2523 }
2524
2525 /** @brief Find a user's password from the database
2526  * @param user Username
2527  * @return Password or NULL
2528  *
2529  * Only works if running as a user that can read the database!
2530  *
2531  * If the user exists but has no password, "" is returned.
2532  */
2533 const char *trackdb_get_password(const char *user) {
2534   int e;
2535   struct kvp *k;
2536   const char *password;
2537
2538   WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2539   if(e)
2540     return 0;
2541   password = kvp_get(k, "password");
2542   return password ? password : "";
2543 }
2544
2545 /** @brief Add a new user
2546  * @param user Username
2547  * @param password Password or NULL
2548  * @param rights Initial rights
2549  * @param email Email address or NULL
2550  * @param confirmation Confirmation string or NULL
2551  * @return 0 on success, non-0 on error
2552  */
2553 int trackdb_adduser(const char *user,
2554                     const char *password,
2555                     const char *rights,
2556                     const char *email,
2557                     const char *confirmation) {
2558   int e;
2559
2560   WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2561                                tid, DB_NOOVERWRITE));
2562   if(e) {
2563     error(0, "cannot create user '%s' because they already exist", user);
2564     return -1;
2565   } else {
2566     if(email)
2567       info("created user '%s' with rights '%s' and email address '%s'",
2568            user, rights, email);
2569     else
2570       info("created user '%s' with rights '%s'", user, rights);
2571     return 0;
2572   }
2573 }
2574
2575 /** @brief Delete a user
2576  * @param user User to delete
2577  * @return 0 on success, non-0 if the user didn't exist anyway
2578  */
2579 int trackdb_deluser(const char *user) {
2580   int e;
2581
2582   WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2583   if(e) {
2584     error(0, "cannot delete user '%s' because they do not exist", user);
2585     return -1;
2586   }
2587   info("deleted user '%s'", user);
2588   return 0;
2589 }
2590
2591 /** @brief Get user information
2592  * @param user User to query
2593  * @return Linked list of user information or NULL if user does not exist
2594  *
2595  * Every user has at least a @c rights entry so NULL can be used to mean no
2596  * such user safely.
2597  */
2598 struct kvp *trackdb_getuserinfo(const char *user) {
2599   int e;
2600   struct kvp *k;
2601
2602   WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2603   if(e)
2604     return 0;
2605   else
2606     return k;
2607 }
2608
2609 /** @brief Edit user information
2610  * @param user User to edit
2611  * @param key Key to change
2612  * @param value Value to set, or NULL to remove
2613  * @param tid Transaction ID
2614  * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2615  */
2616 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2617                                     const char *value, DB_TXN *tid) {
2618   struct kvp *k;
2619   int e;
2620
2621   if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2622     return e;
2623   if(!kvp_set(&k, key, value))
2624     return 0;                           /* no change */
2625   return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2626 }
2627
2628 /** @brief Edit user information
2629  * @param user User to edit
2630  * @param key Key to change
2631  * @param value Value to set, or NULL to remove
2632  * @return 0 on success, non-0 on error
2633  */
2634 int trackdb_edituserinfo(const char *user,
2635                          const char *key, const char *value) {
2636   int e;
2637
2638   if(!strcmp(key, "rights")) {
2639     if(!value) {
2640       error(0, "cannot remove 'rights' key from user '%s'", user);
2641       return -1;
2642     }
2643     if(parse_rights(value, 0, 1)) {
2644       error(0, "invalid rights string");
2645       return -1;
2646     }
2647   } else if(!strcmp(key, "email")) {
2648     if(*value) {
2649       if(!strchr(value, '@')) {
2650         error(0, "invalid email address '%s' for user '%s'", user, value);
2651         return -1;
2652       }
2653     } else
2654       value = 0;                        /* no email -> remove key */
2655   } else if(!strcmp(key, "created")) {
2656     error(0, "cannot change creation date for user '%s'", user);
2657     return -1;
2658   } else if(strcmp(key, "password")
2659             && !strcmp(key, "confirmation")) {
2660     error(0, "unknown user info key '%s' for user '%s'", key, user);
2661     return -1;
2662   }
2663   WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2664   if(e) {
2665     error(0, "unknown user '%s'", user);
2666     return -1;
2667   } else
2668     return 0;
2669 }
2670
2671 /** @brief List all users
2672  * @return NULL-terminated list of users
2673  */
2674 char **trackdb_listusers(void) {
2675   int e;
2676   struct vector v[1];
2677
2678   vector_init(v);
2679   WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2680   return v->vec;
2681 }
2682
2683 /** @brief Confirm a user registration
2684  * @param user Username
2685  * @param confirmation Confirmation string
2686  * @param rightsp Where to put user rights
2687  * @param tid Transaction ID
2688  * @return 0 on success, non-0 on error
2689  */
2690 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2691                                rights_type *rightsp,
2692                                DB_TXN *tid) {
2693   const char *stored_confirmation;
2694   struct kvp *k;
2695   int e;
2696   const char *rights;
2697
2698   if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2699     return e;
2700   if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2701     error(0, "already confirmed user '%s'", user);
2702     /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2703     return -1;
2704   }
2705   if(!(rights = kvp_get(k, "rights"))) {
2706     error(0, "no rights for unconfirmed user '%s'", user);
2707     return -1;
2708   }
2709   if(parse_rights(rights, rightsp, 1))
2710     return -1;
2711   if(strcmp(confirmation, stored_confirmation)) {
2712     error(0, "wrong confirmation string for user '%s'", user);
2713     return -1;
2714   }
2715   /* 'sall good */
2716   kvp_set(&k, "confirmation", 0);
2717   return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2718 }
2719
2720 /** @brief Confirm a user registration
2721  * @param user Username
2722  * @param confirmation Confirmation string
2723  * @param rightsp Where to put user rights
2724  * @return 0 on success, non-0 on error
2725  */
2726 int trackdb_confirm(const char *user, const char *confirmation,
2727                     rights_type *rightsp) {
2728   int e;
2729
2730   WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
2731   switch(e) {
2732   case 0:
2733     info("registration confirmed for user '%s'", user);
2734     return 0;
2735   case DB_NOTFOUND:
2736     error(0, "confirmation for nonexistent user '%s'", user);
2737     return -1;
2738   default:                              /* already reported */
2739     return -1;
2740   }
2741 }
2742
2743 /*
2744 Local Variables:
2745 c-basic-offset:2
2746 comment-column:40
2747 fill-column:79
2748 indent-tabs-mode:nil
2749 End:
2750 */