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