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

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