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