chiark - git - mdw - disorder/blob - server/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 #include <config.h>
  24 #include "types.h"
  25
  26 #include <string.h>
  27 #include <stdio.h>
  28 #include <db.h>
  29 #include <sys/socket.h>
  30 #include <pcre.h>
  31 #include <assert.h>
  32 #include <unistd.h>
  33 #include <errno.h>
  34 #include <stddef.h>
  35 #include <sys/time.h>
  36 #include <sys/resource.h>
  37 #include <time.h>
  38 #include <arpa/inet.h>
  39
  40 #include "event.h"
  41 #include "mem.h"
  42 #include "kvp.h"
  43 #include "log.h"
  44 #include "vector.h"
  45 #include "trackdb.h"
  46 #include "configuration.h"
  47 #include "syscalls.h"
  48 #include "wstat.h"
  49 #include "printf.h"
  50 #include "filepart.h"
  51 #include "trackname.h"
  52 #include "trackdb-int.h"
  53 #include "logfd.h"
  54 #include "cache.h"
  55 #include "eventlog.h"
  56 #include "hash.h"
  57 #include "unicode.h"
  58 #include "unidata.h"
  59
  60 #define RESCAN "disorder-rescan"
  61 #define DEADLOCK "disorder-deadlock"
  62
  63 static const char *getpart(const char *track,
  64                            const char *context,
  65                            const char *part,
  66                            const struct kvp *p,
  67                            int *used_db);
  68 static int trackdb_alltags_tid(DB_TXN *tid, char ***taglistp);
  69 static char **trackdb_new_tid(int *ntracksp,
  70                               int maxtracks,
  71                               DB_TXN *tid);
  72 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid);
  73
  74 const struct cache_type cache_files_type = { 86400 };
  75 unsigned long cache_files_hits, cache_files_misses;
  76
  77 /* setup and teardown ********************************************************/
  78
  79 static const char *home;                /* home had better not change */
  80 DB_ENV *trackdb_env;                    /* db environment */
  81
  82 /** @brief The tracks database
  83  * - Keys are UTF-8(NFC(unicode(path name)))
  84  * - Values are encoded key-value pairs
  85  * - Data is reconstructable data about tracks that currently exist
  86  */
  87 DB *trackdb_tracksdb;
  88
  89 /** @brief The preferences database
  90  *
  91  * - Keys are UTF-8(NFC(unicode(path name)))
  92  * - Values are encoded key-value pairs
  93  * - Data is user data about tracks (that might not exist any more)
  94  * and cannot be reconstructed
  95  */
  96 DB *trackdb_prefsdb;
  97
  98 /** @brief The search database
  99  *
 100  * - Keys are UTF-8(NFKC(casefold(search term)))
 101  * - Values are UTF-8(NFC(unicode(path name)))
 102  * - There can be more than one value per key
 103  * - Presence of key,value means that path matches the search terms
 104  * - Only tracks fond in @ref tracks_tracksdb are represented here
 105  * - This database can be reconstructed, it contains no user data
 106  */
 107 DB *trackdb_searchdb;
 108
 109 /** @brief The tags database
 110  *
 111  * - Keys are UTF-8(NFKC(casefold(tag)))
 112  * - Values are UTF-8(NFC(unicode(path name)))
 113  * - There can be more than one value per key
 114  * - Presence of key,value means that path matches the tag
 115  * - This is always in sync with the tags preference
 116  * - This database can be reconstructed, it contains no user data
 117  */
 118 DB *trackdb_tagsdb;                     /* the tags database */
 119
 120 /** @brief The global preferences database
 121  * - Keys are UTF-8(NFC(preference))
 122  * - Values are global preference values
 123  * - Data is user data and cannot be reconstructed
 124  */
 125 DB *trackdb_globaldb;                   /* global preferences */
 126
 127 /** @brief The noticed database
 128  * - Keys are 64-bit big-endian timestamps
 129  * - Values are UTF-8(NFC(unicode(path name)))
 130  * - There can be more than one value per key
 131  * - Presence of key,value means that path was added at the given time
 132  * - Data cannot be reconstructed (but isn't THAT important)
 133  */
 134 DB *trackdb_noticeddb;                   /* when track noticed */
 135 static pid_t db_deadlock_pid = -1;      /* deadlock manager PID */
 136 static pid_t rescan_pid = -1;           /* rescanner PID */
 137 static int initialized, opened;         /* state */
 138
 139 /* tracks matched by required_tags */
 140 static char **reqtracks;
 141 static size_t nreqtracks;
 142
 143 /* comparison function for keys */
 144 static int compare(DB attribute((unused)) *db_,
 145                    const DBT *a, const DBT *b) {
 146   return compare_path_raw(a->data, a->size, b->data, b->size);
 147 }
 148
 149 /** @brief Open database environment
 150  * @param flags Flags word
 151  *
 152  * Flags should be one of:
 153  * - @ref TRACKDB_NO_RECOVER
 154  * - @ref TRACKDB_NORMAL_RECOVER
 155  * - @ref TRACKDB_FATAL_RECOVER
 156  */
 157 void trackdb_init(int flags) {
 158   int err;
 159   const int recover = flags & TRACKDB_RECOVER_MASK;
 160   static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
 161
 162   /* sanity checks */
 163   assert(initialized == 0);
 164   ++initialized;
 165   if(home) {
 166     if(strcmp(home, config->home))
 167       fatal(0, "cannot change db home without server restart");
 168     home = config->home;
 169   }
 170
 171   /* create environment */
 172   if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
 173                                                    db_strerror(err));
 174   if((err = trackdb_env->set_alloc(trackdb_env,
 175                                    xmalloc_noptr, xrealloc_noptr, xfree)))
 176     fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
 177   if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
 178     fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
 179   if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
 180     fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
 181   if((err = trackdb_env->open(trackdb_env, config->home,
 182                               DB_INIT_LOG
 183                               |DB_INIT_LOCK
 184                               |DB_INIT_MPOOL
 185                               |DB_INIT_TXN
 186                               |DB_CREATE
 187                               |recover_type[recover],
 188                               0666)))
 189     fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
 190   trackdb_env->set_errpfx(trackdb_env, "DB");
 191   trackdb_env->set_errfile(trackdb_env, stderr);
 192   trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
 193   trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
 194   trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
 195   D(("initialized database environment"));
 196 }
 197
 198 /* called when deadlock manager terminates */
 199 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
 200                             pid_t attribute((unused)) pid,
 201                             int status,
 202                             const struct rusage attribute((unused)) *rusage,
 203                             void attribute((unused)) *u) {
 204   db_deadlock_pid = -1;
 205   if(initialized)
 206     fatal(0, "deadlock manager unexpectedly terminated: %s",
 207           wstat(status));
 208   else
 209     D(("deadlock manager terminated: %s", wstat(status)));
 210   return 0;
 211 }
 212
 213 static pid_t subprogram(ev_source *ev, const char *prog,
 214                         int outputfd) {
 215   pid_t pid;
 216
 217   /* If we're in the background then trap subprocess stdout/stderr */
 218   if(!(pid = xfork())) {
 219     exitfn = _exit;
 220     if(ev)
 221       ev_signal_atfork(ev);
 222     signal(SIGPIPE, SIG_DFL);
 223     if(outputfd != -1) {
 224       xdup2(outputfd, 1);
 225       xclose(outputfd);
 226     }
 227     /* If we were negatively niced, undo it.  We don't bother checking for
 228      * error, it's not that important. */
 229     setpriority(PRIO_PROCESS, 0, 0);
 230     execlp(prog, prog, "--config", configfile,
 231            debugging ? "--debug" : "--no-debug",
 232            log_default == &log_syslog ? "--syslog" : "--no-syslog",
 233            (char *)0);
 234     fatal(errno, "error invoking %s", prog);
 235   }
 236   return pid;
 237 }
 238
 239 /* start deadlock manager */
 240 void trackdb_master(ev_source *ev) {
 241   assert(db_deadlock_pid == -1);
 242   db_deadlock_pid = subprogram(ev, DEADLOCK, -1);
 243   ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
 244   D(("started deadlock manager"));
 245 }
 246
 247 /* close environment */
 248 void trackdb_deinit(void) {
 249   int err;
 250
 251   /* sanity checks */
 252   assert(initialized == 1);
 253   --initialized;
 254
 255   /* close the environment */
 256   if((err = trackdb_env->close(trackdb_env, 0)))
 257     fatal(0, "trackdb_env->close: %s", db_strerror(err));
 258
 259   if(rescan_pid != -1 && kill(rescan_pid, SIGTERM) < 0)
 260     fatal(errno, "error killing rescanner");
 261
 262   /* terminate the deadlock manager */
 263   if(db_deadlock_pid != -1 && kill(db_deadlock_pid, SIGTERM) < 0)
 264     fatal(errno, "error killing deadlock manager");
 265   db_deadlock_pid = -1;
 266
 267   D(("deinitialized database environment"));
 268 }
 269
 270 /* open a specific database */
 271 static DB *open_db(const char *path,
 272                    u_int32_t dbflags,
 273                    DBTYPE dbtype,
 274                    u_int32_t openflags,
 275                    int mode) {
 276   int err;
 277   DB *db;
 278
 279   D(("open %s", path));
 280   path = config_get_file(path);
 281   if((err = db_create(&db, trackdb_env, 0)))
 282     fatal(0, "db_create %s: %s", path, db_strerror(err));
 283   if(dbflags)
 284     if((err = db->set_flags(db, dbflags)))
 285       fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
 286   if(dbtype == DB_BTREE)
 287     if((err = db->set_bt_compare(db, compare)))
 288       fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
 289   if((err = db->open(db, 0, path, 0, dbtype,
 290                      openflags | DB_AUTO_COMMIT, mode))) {
 291     if((openflags & DB_CREATE) || errno != ENOENT)
 292       fatal(0, "db->open %s: %s", path, db_strerror(err));
 293     db->close(db, 0);
 294     db = 0;
 295   }
 296   return db;
 297 }
 298
 299 /** @brief Open track databases
 300  * @param Flags flags word
 301  *
 302  * @p flags should be one of:
 303  * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
 304  * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
 305  * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
 306  */
 307 void trackdb_open(int flags) {
 308   int newdb, err;
 309   pid_t pid;
 310
 311   /* sanity checks */
 312   assert(opened == 0);
 313   ++opened;
 314   /* check the database version first */
 315   trackdb_globaldb = open_db("global.db", 0, DB_HASH, 0, 0666);
 316   if(trackdb_globaldb) {
 317     /* This is an existing database */
 318     const char *s;
 319     long oldversion;
 320
 321     s = trackdb_get_global("_dbversion");
 322     /* Close the database again,  we'll open it property below */
 323     if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
 324       fatal(0, "error closing global.db: %s", db_strerror(err));
 325     trackdb_globaldb = 0;
 326     /* Convert version string to an integer */
 327     oldversion = s ? atol(s) : 1;
 328     if(oldversion > config->dbversion) {
 329       /* Database is from the future; we never allow this. */
 330       fatal(0, "this version of DisOrder is too old for database version %ld",
 331             oldversion);
 332     }
 333     if(oldversion < config->dbversion) {
 334       /* Database version is out of date */
 335       switch(flags & TRACKDB_UPGRADE_MASK) {
 336       case TRACKDB_NO_UPGRADE:
 337         /* This database needs upgrading but this is not permitted */
 338         fatal(0, "database needs upgrading from %ld to %ld",
 339               oldversion, config->dbversion);
 340       case TRACKDB_CAN_UPGRADE:
 341         /* This database needs upgrading */
 342         info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
 343              oldversion, config->dbversion);
 344         pid = subprogram(0, "disorder-dbupgrade", -1);
 345         while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
 346           ;
 347         if(err)
 348           fatal(0, "disorder-dbupgrade %s", wstat(err));
 349         info("disorder-dbupgrade succeeded");
 350         break;
 351       case TRACKDB_OPEN_FOR_UPGRADE:
 352         break;
 353       default:
 354         abort();
 355       }
 356     }
 357     if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
 358       /* This doesn't make any sense */
 359       fatal(0, "database is already at current version");
 360     }
 361     newdb = 0;
 362   } else {
 363     if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
 364       /* Cannot upgrade a new database */
 365       fatal(0, "cannot upgrade a database that does not exist");
 366     }
 367     /* This is a brand new database */
 368     newdb = 1;
 369   }
 370   /* open the databases */
 371   trackdb_tracksdb = open_db("tracks.db",
 372                              DB_RECNUM, DB_BTREE, DB_CREATE, 0666);
 373   trackdb_searchdb = open_db("search.db",
 374                              DB_DUP|DB_DUPSORT, DB_HASH, DB_CREATE, 0666);
 375   trackdb_tagsdb = open_db("tags.db",
 376                            DB_DUP|DB_DUPSORT, DB_HASH, DB_CREATE, 0666);
 377   trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, DB_CREATE, 0666);
 378   trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_CREATE, 0666);
 379   trackdb_noticeddb = open_db("noticed.db",
 380                              DB_DUPSORT, DB_BTREE, DB_CREATE, 0666);
 381   if(newdb) {
 382     /* Stash the database version */
 383     char buf[32];
 384
 385     assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
 386     snprintf(buf, sizeof buf, "%ld", config->dbversion);
 387     trackdb_set_global("_dbversion", buf, 0);
 388   }
 389   D(("opened databases"));
 390 }
 391
 392 /* close track databases */
 393 void trackdb_close(void) {
 394   int err;
 395
 396   /* sanity checks */
 397   assert(opened == 1);
 398   --opened;
 399   if((err = trackdb_tracksdb->close(trackdb_tracksdb, 0)))
 400     fatal(0, "error closing tracks.db: %s", db_strerror(err));
 401   if((err = trackdb_searchdb->close(trackdb_searchdb, 0)))
 402     fatal(0, "error closing search.db: %s", db_strerror(err));
 403   if((err = trackdb_tagsdb->close(trackdb_tagsdb, 0)))
 404     fatal(0, "error closing tags.db: %s", db_strerror(err));
 405   if((err = trackdb_prefsdb->close(trackdb_prefsdb, 0)))
 406     fatal(0, "error closing prefs.db: %s", db_strerror(err));
 407   if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
 408     fatal(0, "error closing global.db: %s", db_strerror(err));
 409   if((err = trackdb_noticeddb->close(trackdb_noticeddb, 0)))
 410     fatal(0, "error closing noticed.db: %s", db_strerror(err));
 411   trackdb_tracksdb = trackdb_searchdb = trackdb_prefsdb = 0;
 412   trackdb_tagsdb = trackdb_globaldb = 0;
 413   D(("closed databases"));
 414 }
 415
 416 /* generic db routines *******************************************************/
 417
 418 /* fetch and decode a database entry.  Returns 0, DB_NOTFOUND or
 419  * DB_LOCK_DEADLOCK. */
 420 int trackdb_getdata(DB *db,
 421                     const char *track,
 422                     struct kvp **kp,
 423                     DB_TXN *tid) {
 424   int err;
 425   DBT key, data;
 426
 427   switch(err = db->get(db, tid, make_key(&key, track),
 428                        prepare_data(&data), 0)) {
 429   case 0:
 430     *kp = kvp_urldecode(data.data, data.size);
 431     return 0;
 432   case DB_NOTFOUND:
 433     *kp = 0;
 434     return err;
 435   case DB_LOCK_DEADLOCK:
 436     error(0, "error querying database: %s", db_strerror(err));
 437     return err;
 438   default:
 439     fatal(0, "error querying database: %s", db_strerror(err));
 440   }
 441 }
 442
 443 /* encode and store a database entry.  Returns 0, DB_KEYEXIST or
 444  * DB_LOCK_DEADLOCK. */
 445 int trackdb_putdata(DB *db,
 446                     const char *track,
 447                     const struct kvp *k,
 448                     DB_TXN *tid,
 449                     u_int32_t flags) {
 450   int err;
 451   DBT key, data;
 452
 453   switch(err = db->put(db, tid, make_key(&key, track),
 454                        encode_data(&data, k), flags)) {
 455   case 0:
 456   case DB_KEYEXIST:
 457     return err;
 458   case DB_LOCK_DEADLOCK:
 459     error(0, "error updating database: %s", db_strerror(err));
 460     return err;
 461   default:
 462     fatal(0, "error updating database: %s", db_strerror(err));
 463   }
 464 }
 465
 466 /* delete a database entry */
 467 int trackdb_delkey(DB *db,
 468                    const char *track,
 469                    DB_TXN *tid) {
 470   int err;
 471
 472   DBT key;
 473   switch(err = db->del(db, tid, make_key(&key, track), 0)) {
 474   case 0:
 475   case DB_NOTFOUND:
 476     return 0;
 477   case DB_LOCK_DEADLOCK:
 478     error(0, "error updating database: %s", db_strerror(err));
 479     return err;
 480   default:
 481     fatal(0, "error updating database: %s", db_strerror(err));
 482   }
 483 }
 484
 485 /* open a database cursor */
 486 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
 487   int err;
 488   DBC *c;
 489
 490   switch(err = db->cursor(db, tid, &c, 0)) {
 491   case 0: break;
 492   default: fatal(0, "error creating cursor: %s", db_strerror(err));
 493   }
 494   return c;
 495 }
 496
 497 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
 498 int trackdb_closecursor(DBC *c) {
 499   int err;
 500
 501   if(!c) return 0;
 502   switch(err = c->c_close(c)) {
 503   case 0:
 504     return err;
 505   case DB_LOCK_DEADLOCK:
 506     error(0, "error closing cursor: %s", db_strerror(err));
 507     return err;
 508   default:
 509     fatal(0, "error closing cursor: %s", db_strerror(err));
 510   }
 511 }
 512
 513 /* delete a (key,data) pair.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
 514 int trackdb_delkeydata(DB *db,
 515                        const char *word,
 516                        const char *track,
 517                        DB_TXN *tid) {
 518   int err;
 519   DBC *c;
 520   DBT key, data;
 521
 522   c = trackdb_opencursor(db, tid);
 523   switch(err = c->c_get(c, make_key(&key, word),
 524                         make_key(&data, track), DB_GET_BOTH)) {
 525   case 0:
 526     switch(err = c->c_del(c, 0)) {
 527     case 0:
 528       break;
 529     case DB_KEYEMPTY:
 530       err = 0;
 531       break;
 532     case DB_LOCK_DEADLOCK:
 533       error(0, "error updating database: %s", db_strerror(err));
 534       break;
 535     default:
 536       fatal(0, "c->c_del: %s", db_strerror(err));
 537     }
 538     break;
 539   case DB_NOTFOUND:
 540     break;
 541   case DB_LOCK_DEADLOCK:
 542     error(0, "error updating database: %s", db_strerror(err));
 543     break;
 544   default:
 545     fatal(0, "c->c_get: %s", db_strerror(err));
 546   }
 547   if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
 548   return err;
 549 }
 550
 551 /* start a transaction */
 552 DB_TXN *trackdb_begin_transaction(void) {
 553   DB_TXN *tid;
 554   int err;
 555
 556   if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
 557     fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
 558   return tid;
 559 }
 560
 561 /* abort transaction */
 562 void trackdb_abort_transaction(DB_TXN *tid) {
 563   int err;
 564
 565   if(tid)
 566     if((err = tid->abort(tid)))
 567       fatal(0, "tid->abort: %s", db_strerror(err));
 568 }
 569
 570 /* commit transaction */
 571 void trackdb_commit_transaction(DB_TXN *tid) {
 572   int err;
 573
 574   if((err = tid->commit(tid, 0)))
 575     fatal(0, "tid->commit: %s", db_strerror(err));
 576 }
 577
 578 /* search/tags shared code ***************************************************/
 579
 580 /* comparison function used by dedupe() */
 581 static int wordcmp(const void *a, const void *b) {
 582   return strcmp(*(const char **)a, *(const char **)b);
 583 }
 584
 585 /* sort and de-dupe VEC */
 586 static char **dedupe(char **vec, int nvec) {
 587   int m, n;
 588
 589   qsort(vec, nvec, sizeof (char *), wordcmp);
 590   m = n = 0;
 591   if(nvec) {
 592     vec[m++] = vec[0];
 593     for(n = 1; n < nvec; ++n)
 594       if(strcmp(vec[n], vec[m - 1]))
 595         vec[m++] = vec[n];
 596   }
 597   vec[m] = 0;
 598   return vec;
 599 }
 600
 601 /* update a key/track database.  Returns 0 or DB_DEADLOCK. */
 602 static int register_word(DB *db, const char *what,
 603                          const char *track, const char *word,
 604                          DB_TXN *tid) {
 605   int err;
 606   DBT key, data;
 607
 608   switch(err = db->put(db, tid, make_key(&key, word),
 609                        make_key(&data, track), DB_NODUPDATA)) {
 610   case 0:
 611   case DB_KEYEXIST:
 612     return 0;
 613   case DB_LOCK_DEADLOCK:
 614     error(0, "error updating %s.db: %s", what, db_strerror(err));
 615     return err;
 616   default:
 617     fatal(0, "error updating %s.db: %s", what,  db_strerror(err));
 618   }
 619 }
 620
 621 /* search primitives *********************************************************/
 622
 623 /* return true iff NAME is a trackname_display_ pref */
 624 static int is_display_pref(const char *name) {
 625   static const char prefix[] = "trackname_display_";
 626   return !strncmp(name, prefix, (sizeof prefix) - 1);
 627 }
 628
 629 /** @brief Word_Break property tailor that treats underscores as spaces */
 630 static int tailor_underscore_Word_Break_Other(uint32_t c) {
 631   switch(c) {
 632   default:
 633     return -1;
 634   case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
 635     return unicode_Word_Break_Other;
 636   }
 637 }
 638
 639 /** @brief Normalize and split a string using a given tailoring */
 640 static void word_split(struct vector *v,
 641                        const char *s,
 642                        unicode_property_tailor *pt) {
 643   size_t nw, nt32, i;
 644   uint32_t *t32, **w32;
 645
 646   /* Convert to UTF-32 */
 647   if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
 648     return;
 649   /* Erase case distinctions */
 650   if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
 651     return;
 652   /* Split into words, treating _ as a space */
 653   w32 = utf32_word_split(t32, nt32, &nw, pt);
 654   /* Convert words back to UTF-8 and append to result */
 655   for(i = 0; i < nw; ++i)
 656     vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
 657 }
 658
 659 /* compute the words of a track name */
 660 static char **track_to_words(const char *track,
 661                              const struct kvp *p) {
 662   struct vector v;
 663   const char *rootless = track_rootless(track);
 664
 665   if(!rootless)
 666     rootless = track;                   /* bodge */
 667   vector_init(&v);
 668   rootless = strip_extension(rootless);
 669   word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
 670   for(; p; p = p->next)
 671     if(is_display_pref(p->name))
 672       word_split(&v, p->value, 0);
 673   vector_terminate(&v);
 674   return dedupe(v.vec, v.nvec);
 675 }
 676
 677 /* return nonzero iff WORD is a stopword */
 678 static int stopword(const char *word) {
 679   int n;
 680
 681   for(n = 0; n < config->stopword.n
 682         && strcmp(word, config->stopword.s[n]); ++n)
 683     ;
 684   return n < config->stopword.n;
 685 }
 686
 687 /* record that WORD appears in TRACK.  Returns 0 or DB_LOCK_DEADLOCK. */
 688 static int register_search_word(const char *track, const char *word,
 689                                 DB_TXN *tid) {
 690   if(stopword(word)) return 0;
 691   return register_word(trackdb_searchdb, "search", track, word, tid);
 692 }
 693
 694 /* Tags **********************************************************************/
 695
 696 /* Return nonzero if C is a valid tag character */
 697 static int tagchar(int c) {
 698   switch(c) {
 699   case ',':
 700     return 0;
 701   default:
 702     return c >= ' ';
 703   }
 704 }
 705
 706 /* Parse and de-dupe a tag list.  If S=0 then assumes "". */
 707 static char **parsetags(const char *s) {
 708   const char *t;
 709   struct vector v;
 710
 711   vector_init(&v);
 712   if(s) {
 713     /* skip initial separators */
 714     while(*s && (!tagchar(*s) || *s == ' '))
 715       ++s;
 716     while(*s) {
 717       /* find the extent of the tag */
 718       t = s;
 719       while(*s && tagchar(*s))
 720         ++s;
 721       /* strip trailing spaces */
 722       while(s > t && s[-1] == ' ')
 723         --s;
 724       vector_append(&v, xstrndup(t, s - t));
 725       /* skip intermediate and trailing separators */
 726       while(*s && (!tagchar(*s) || *s == ' '))
 727         ++s;
 728     }
 729   }
 730   vector_terminate(&v);
 731   return dedupe(v.vec, v.nvec);
 732 }
 733
 734 /* Record that TRACK has TAG.  Returns 0 or DB_LOCK_DEADLOCK. */
 735 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
 736   return register_word(trackdb_tagsdb, "tags", track, tag, tid);
 737 }
 738
 739 /* aliases *******************************************************************/
 740
 741 /* compute the alias and store at aliasp.  Returns 0 or DB_LOCK_DEADLOCK.  If
 742  * there is no alias sets *aliasp to 0. */
 743 static int compute_alias(char **aliasp,
 744                          const char *track,
 745                          const struct kvp *p,
 746                          DB_TXN *tid) {
 747   struct dynstr d;
 748   const char *s = config->alias, *t, *expansion, *part;
 749   int c, used_db = 0, slash_prefix, err;
 750   struct kvp *at;
 751   const char *const root = find_track_root(track);
 752
 753   if(!root) {
 754     /* Bodge for tracks with no root */
 755     *aliasp = 0;
 756     return 0;
 757   }
 758   dynstr_init(&d);
 759   dynstr_append_string(&d, root);
 760   while((c = (unsigned char)*s++)) {
 761     if(c != '{') {
 762       dynstr_append(&d, c);
 763       continue;
 764     }
 765     if((slash_prefix = (*s == '/')))
 766       s++;
 767     t = strchr(s, '}');
 768     assert(t != 0);                     /* validated at startup */
 769     part = xstrndup(s, t - s);
 770     expansion = getpart(track, "display", part, p, &used_db);
 771     if(*expansion) {
 772       if(slash_prefix) dynstr_append(&d, '/');
 773       dynstr_append_string(&d, expansion);
 774     }
 775     s = t + 1;                          /* skip {part} */
 776   }
 777   /* only admit to the alias if we used the db... */
 778   if(!used_db) {
 779     *aliasp = 0;
 780     return 0;
 781   }
 782   dynstr_terminate(&d);
 783   /* ...and the answer differs from the original... */
 784   if(!strcmp(track, d.vec)) {
 785     *aliasp = 0;
 786     return 0;
 787   }
 788   /* ...and there isn't already a different track with that name (including as
 789    * an alias) */
 790   switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
 791   case 0:
 792     if((s = kvp_get(at, "_alias_for"))
 793        && !strcmp(s, track)) {
 794     case DB_NOTFOUND:
 795       *aliasp = d.vec;
 796     } else {
 797       *aliasp = 0;
 798     }
 799     return 0;
 800   default:
 801     return err;
 802   }
 803 }
 804
 805 /* get track and prefs data (if tp/pp not null pointers).  Returns 0 on
 806  * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
 807  * Always sets the return values, even if only to null pointers. */
 808 static int gettrackdata(const char *track,
 809                         struct kvp **tp,
 810                         struct kvp **pp,
 811                         const char **actualp,
 812                         unsigned flags,
 813 #define GTD_NOALIAS 0x0001
 814                         DB_TXN *tid) {
 815   int err;
 816   const char *actual = track;
 817   struct kvp *t = 0, *p = 0;
 818
 819   if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
 820   if((actual = kvp_get(t, "_alias_for"))) {
 821     if(flags & GTD_NOALIAS) {
 822       error(0, "alias passed to gettrackdata where real path required");
 823       abort();
 824     }
 825     if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
 826   } else
 827     actual = track;
 828   assert(actual != 0);
 829   if(pp) {
 830     if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
 831       goto done;
 832   }
 833   err = 0;
 834 done:
 835   if(actualp) *actualp = actual;
 836   if(tp) *tp = t;
 837   if(pp) *pp = p;
 838   return err;
 839 }
 840
 841 /* trackdb_notice() **********************************************************/
 842
 843 /** @brief notice a possibly new track
 844  * @return @c DB_NOTFOUND if new, 0 if already known
 845  */
 846 int trackdb_notice(const char *track,
 847                    const char *path) {
 848   int err;
 849   DB_TXN *tid;
 850
 851   for(;;) {
 852     tid = trackdb_begin_transaction();
 853     err = trackdb_notice_tid(track, path, tid);
 854     if((err == DB_LOCK_DEADLOCK)) goto fail;
 855     break;
 856   fail:
 857     trackdb_abort_transaction(tid);
 858   }
 859   trackdb_commit_transaction(tid);
 860   return err;
 861 }
 862
 863 /** @brief notice a possibly new track
 864  * @param track NFC UTF-8 track name
 865  * @param path Raw path name
 866  * @param tid Transaction ID
 867  * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
 868  */
 869 int trackdb_notice_tid(const char *track,
 870                        const char *path,
 871                        DB_TXN *tid) {
 872   int err, n;
 873   struct kvp *t, *a, *p;
 874   int t_changed, ret;
 875   char *alias, **w;
 876
 877   /* notice whether the tracks.db entry changes */
 878   t_changed = 0;
 879   /* get any existing tracks entry */
 880   if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
 881     return err;
 882   ret = err;                            /* 0 or DB_NOTFOUND */
 883   /* this is a real track */
 884   t_changed += kvp_set(&t, "_alias_for", 0);
 885   t_changed += kvp_set(&t, "_path", path);
 886   /* if we have an alias record it in the database */
 887   if((err = compute_alias(&alias, track, p, tid))) return err;
 888   if(alias) {
 889     /* won't overwrite someone else's alias as compute_alias() checks */
 890     D(("%s: alias %s", track, alias));
 891     a = 0;
 892     kvp_set(&a, "_alias_for", track);
 893     if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
 894   }
 895   /* update search.db */
 896   w = track_to_words(track, p);
 897   for(n = 0; w[n]; ++n)
 898     if((err = register_search_word(track, w[n], tid)))
 899       return err;
 900   /* update tags.db */
 901   w = parsetags(kvp_get(p, "tags"));
 902   for(n = 0; w[n]; ++n)
 903     if((err = register_tag(track, w[n], tid)))
 904       return err;
 905   reqtracks = 0;
 906   /* only store the tracks.db entry if it has changed */
 907   if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
 908     return err;
 909   if(ret == DB_NOTFOUND) {
 910     uint32_t timestamp[2];
 911     time_t now;
 912     DBT key, data;
 913
 914     time(&now);
 915     timestamp[0] = htonl((uint64_t)now >> 32);
 916     timestamp[1] = htonl((uint32_t)now);
 917     memset(&key, 0, sizeof key);
 918     key.data = timestamp;
 919     key.size = sizeof timestamp;
 920     switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
 921                                         make_key(&data, track), 0)) {
 922     case 0: break;
 923     case DB_LOCK_DEADLOCK: return err;
 924     default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
 925     }
 926   }
 927   return ret;
 928 }
 929
 930 /* trackdb_obsolete() ********************************************************/
 931
 932 /* obsolete a track */
 933 int trackdb_obsolete(const char *track, DB_TXN *tid) {
 934   int err, n;
 935   struct kvp *p;
 936   char *alias, **w;
 937
 938   if((err = gettrackdata(track, 0, &p, 0,
 939                          GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
 940     return err;
 941   else if(err == DB_NOTFOUND) return 0;
 942   /* compute the alias, if any, and delete it */
 943   if(compute_alias(&alias, track, p, tid)) return err;
 944   if(alias) {
 945     /* if the alias points to some other track then compute_alias won't
 946      * return it */
 947     if(trackdb_delkey(trackdb_tracksdb, alias, tid))
 948       return err;
 949   }
 950   /* update search.db */
 951   w = track_to_words(track, p);
 952   for(n = 0; w[n]; ++n)
 953     if(trackdb_delkeydata(trackdb_searchdb,
 954                           w[n], track, tid) == DB_LOCK_DEADLOCK)
 955       return err;
 956   /* update tags.db */
 957   w = parsetags(kvp_get(p, "tags"));
 958   for(n = 0; w[n]; ++n)
 959     if(trackdb_delkeydata(trackdb_tagsdb,
 960                           w[n], track, tid) == DB_LOCK_DEADLOCK)
 961       return err;
 962   reqtracks = 0;
 963   /* update tracks.db */
 964   if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
 965     return err;
 966   /* We don't delete the prefs, so they survive temporary outages of the
 967    * (possibly virtual) track filesystem */
 968   return 0;
 969 }
 970
 971 /* trackdb_stats() ***********************************************************/
 972
 973 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
 974 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
 975
 976 static const struct statinfo {
 977   const char *name;
 978   size_t offset;
 979 } statinfo_hash[] = {
 980   H(hash_magic),
 981   H(hash_version),
 982   H(hash_nkeys),
 983   H(hash_ndata),
 984   H(hash_pagesize),
 985   H(hash_ffactor),
 986   H(hash_buckets),
 987   H(hash_free),
 988   H(hash_bfree),
 989   H(hash_bigpages),
 990   H(hash_big_bfree),
 991   H(hash_overflows),
 992   H(hash_ovfl_free),
 993   H(hash_dup),
 994   H(hash_dup_free),
 995 }, statinfo_btree[] = {
 996   B(bt_magic),
 997   B(bt_version),
 998   B(bt_nkeys),
 999   B(bt_ndata),
1000   B(bt_pagesize),
1001   B(bt_minkey),
1002   B(bt_re_len),
1003   B(bt_re_pad),
1004   B(bt_levels),
1005   B(bt_int_pg),
1006   B(bt_leaf_pg),
1007   B(bt_dup_pg),
1008   B(bt_over_pg),
1009   B(bt_free),
1010   B(bt_int_pgfree),
1011   B(bt_leaf_pgfree),
1012   B(bt_dup_pgfree),
1013   B(bt_over_pgfree),
1014 };
1015
1016 /* look up stats for DB */
1017 static int get_stats(struct vector *v,
1018                      DB *database,
1019                      const struct statinfo *si,
1020                      size_t nsi,
1021                      DB_TXN *tid) {
1022   void *sp;
1023   size_t n;
1024   char *str;
1025   int err;
1026
1027   if(database) {
1028     switch(err = database->stat(database, tid, &sp, 0)) {
1029     case 0:
1030       break;
1031     case DB_LOCK_DEADLOCK:
1032       error(0, "error querying database: %s", db_strerror(err));
1033       return err;
1034     default:
1035       fatal(0, "error querying database: %s", db_strerror(err));
1036     }
1037     for(n = 0; n < nsi; ++n) {
1038       byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1039                      (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1040       vector_append(v, str);
1041     }
1042   }
1043   return 0;
1044 }
1045
1046 struct search_entry {
1047   char *word;
1048   int n;
1049 };
1050
1051 /* find the top COUNT words in the search database */
1052 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1053   struct search_entry *se;
1054   DBT k, d;
1055   DBC *cursor;
1056   int err, n = 0, nse = 0, i;
1057   char *word = 0;
1058   size_t wl = 0;
1059   char *str;
1060
1061   cursor = trackdb_opencursor(trackdb_searchdb, tid);
1062   se = xmalloc(count * sizeof *se);
1063   while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1064                               DB_NEXT))) {
1065     if(word && wl == k.size && !strncmp(word, k.data, wl))
1066       ++n;
1067     else {
1068 #define FINALIZE() do {                                         \
1069   if(word && (nse < count || n > se[nse - 1].n)) {              \
1070     if(nse == count)                                            \
1071       i = nse - 1;                                              \
1072     else                                                        \
1073       i = nse++;                                                \
1074     while(i > 0 && n > se[i - 1].n)                             \
1075       --i;                                                      \
1076     memmove(&se[i + 1], &se[i], (nse - i) * sizeof *se);        \
1077     se[i].word = word;                                          \
1078     se[i].n = n;                                                \
1079   }                                                             \
1080 } while(0)
1081       FINALIZE();
1082       word = xstrndup(k.data, wl = k.size);
1083       n = 1;
1084     }
1085   }
1086   switch(err) {
1087   case DB_NOTFOUND:
1088     err = 0;
1089     break;
1090   case DB_LOCK_DEADLOCK:
1091     error(0, "error querying search database: %s", db_strerror(err));
1092     break;
1093   default:
1094     fatal(0, "error querying search database: %s", db_strerror(err));
1095   }
1096   if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1097   if(err) return err;
1098   FINALIZE();
1099   byte_xasprintf(&str, "Top %d search words:", nse);
1100   vector_append(v, str);
1101   for(i = 0; i < nse; ++i) {
1102     byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1103     vector_append(v, str);
1104   }
1105   return 0;
1106 }
1107
1108 #define SI(what) statinfo_##what, \
1109                  sizeof statinfo_##what / sizeof (struct statinfo)
1110
1111 /* return a list of database stats */
1112 char **trackdb_stats(int *nstatsp) {
1113   DB_TXN *tid;
1114   struct vector v;
1115
1116   vector_init(&v);
1117   for(;;) {
1118     tid = trackdb_begin_transaction();
1119     v.nvec = 0;
1120     vector_append(&v, (char *)"Tracks database stats:");
1121     if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1122     vector_append(&v, (char *)"");
1123     vector_append(&v, (char *)"Search database stats:");
1124     if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1125     vector_append(&v, (char *)"");
1126     vector_append(&v, (char *)"Prefs database stats:");
1127     if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1128     vector_append(&v, (char *)"");
1129     if(search_league(&v, 10, tid)) goto fail;
1130     vector_terminate(&v);
1131     break;
1132 fail:
1133     trackdb_abort_transaction(tid);
1134   }
1135   trackdb_commit_transaction(tid);
1136   if(nstatsp) *nstatsp = v.nvec;
1137   return v.vec;
1138 }
1139
1140 struct stats_details {
1141   void (*done)(char *data, void *u);
1142   void *u;
1143   int exited;                           /* subprocess exited */
1144   int closed;                           /* pipe close */
1145   int wstat;                            /* wait status from subprocess */
1146   struct dynstr data[1];                /* data read from pipe */
1147 };
1148
1149 static void stats_complete(struct stats_details *d) {
1150   char *s;
1151
1152   if(!(d->exited && d->closed))
1153     return;
1154   byte_xasprintf(&s, "\n"
1155                  "Server stats:\n"
1156                  "track lookup cache hits: %lu\n"
1157                  "track lookup cache misses: %lu\n",
1158                  cache_files_hits,
1159                  cache_files_misses);
1160   dynstr_append_string(d->data, s);
1161   dynstr_terminate(d->data);
1162   d->done(d->data->vec, d->u);
1163 }
1164
1165 static int stats_finished(ev_source attribute((unused)) *ev,
1166                           pid_t attribute((unused)) pid,
1167                           int status,
1168                           const struct rusage attribute((unused)) *rusage,
1169                           void *u) {
1170   struct stats_details *const d = u;
1171
1172   d->exited = 1;
1173   if(status)
1174     error(0, "disorder-stats %s", wstat(status));
1175   stats_complete(d);
1176   return 0;
1177 }
1178
1179 static int stats_read(ev_source attribute((unused)) *ev,
1180                       ev_reader *reader,
1181                       void *ptr,
1182                       size_t bytes,
1183                       int eof,
1184                       void *u) {
1185   struct stats_details *const d = u;
1186
1187   dynstr_append_bytes(d->data, ptr, bytes);
1188   ev_reader_consume(reader, bytes);
1189   if(eof)
1190     d->closed = 1;
1191   stats_complete(d);
1192   return 0;
1193 }
1194
1195 static int stats_error(ev_source attribute((unused)) *ev,
1196                        int errno_value,
1197                        void *u) {
1198   struct stats_details *const d = u;
1199
1200   error(errno_value, "error reading from pipe to disorder-stats");
1201   d->closed = 1;
1202   stats_complete(d);
1203   return 0;
1204 }
1205
1206 void trackdb_stats_subprocess(ev_source *ev,
1207                               void (*done)(char *data, void *u),
1208                               void *u) {
1209   int p[2];
1210   pid_t pid;
1211   struct stats_details *d = xmalloc(sizeof *d);
1212
1213   dynstr_init(d->data);
1214   d->done = done;
1215   d->u = u;
1216   xpipe(p);
1217   pid = subprogram(ev, "disorder-stats", p[1]);
1218   xclose(p[1]);
1219   ev_child(ev, pid, 0, stats_finished, d);
1220   ev_reader_new(ev, p[0], stats_read, stats_error, d, "disorder-stats reader");
1221 }
1222
1223 /* set a pref (remove if value=0) */
1224 int trackdb_set(const char *track,
1225                 const char *name,
1226                 const char *value) {
1227   struct kvp *t, *p, *a;
1228   DB_TXN *tid;
1229   int err, cmp;
1230   char *oldalias, *newalias, **oldtags = 0, **newtags;
1231
1232   if(value) {
1233     /* TODO: if value matches default then set value=0 */
1234   }
1235
1236   for(;;) {
1237     tid = trackdb_begin_transaction();
1238     if((err = gettrackdata(track, &t, &p, 0,
1239                            0, tid)) == DB_LOCK_DEADLOCK)
1240       goto fail;
1241     if(err == DB_NOTFOUND) break;
1242     if(name[0] == '_') {
1243       if(kvp_set(&t, name, value))
1244         if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1245           goto fail;
1246     } else {
1247       /* get the old alias name */
1248       if(compute_alias(&oldalias, track, p, tid)) goto fail;
1249       /* get the old tags */
1250       if(!strcmp(name, "tags"))
1251         oldtags = parsetags(kvp_get(p, "tags"));
1252       /* set the value */
1253       if(kvp_set(&p, name, value))
1254         if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1255           goto fail;
1256       /* compute the new alias name */
1257       if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1258       /* check whether alias has changed */
1259       if(!(oldalias == newalias
1260            || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1261         /* adjust alias records to fit change */
1262         if(oldalias
1263            && trackdb_delkey(trackdb_tracksdb, oldalias, tid)) goto fail;
1264         if(newalias) {
1265           a = 0;
1266           kvp_set(&a, "_alias_for", track);
1267           if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1268         }
1269       }
1270       /* check whether tags have changed */
1271       if(!strcmp(name, "tags")) {
1272         newtags = parsetags(value);
1273         while(*oldtags || *newtags) {
1274           if(*oldtags && *newtags) {
1275             cmp = strcmp(*oldtags, *newtags);
1276             if(!cmp) {
1277               /* keeping this tag */
1278               ++oldtags;
1279               ++newtags;
1280             } else if(cmp < 0)
1281               /* old tag fits into a gap in the new list, so delete old */
1282               goto delete_old;
1283             else
1284               /* new tag fits into a gap in the old list, so insert new */
1285               goto insert_new;
1286           } else if(*oldtags) {
1287             /* we've run out of new tags, so remaining old ones are to be
1288              * deleted */
1289           delete_old:
1290             if(trackdb_delkeydata(trackdb_tagsdb,
1291                                   *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1292               goto fail;
1293             ++oldtags;
1294           } else {
1295             /* we've run out of old tags, so remainig new ones are to be
1296              * inserted */
1297           insert_new:
1298             if(register_tag(track, *newtags, tid)) goto fail;
1299             ++newtags;
1300           }
1301         }
1302         reqtracks = 0;
1303       }
1304     }
1305     err = 0;
1306     break;
1307 fail:
1308     trackdb_abort_transaction(tid);
1309   }
1310   trackdb_commit_transaction(tid);
1311   return err == 0 ? 0 : -1;
1312 }
1313
1314 /* get a pref */
1315 const char *trackdb_get(const char *track,
1316                         const char *name) {
1317   return kvp_get(trackdb_get_all(track), name);
1318 }
1319
1320 /* get all prefs as a 0-terminated array */
1321 struct kvp *trackdb_get_all(const char *track) {
1322   struct kvp *t, *p, **pp;
1323   DB_TXN *tid;
1324
1325   for(;;) {
1326     tid = trackdb_begin_transaction();
1327     if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1328       goto fail;
1329     break;
1330 fail:
1331     trackdb_abort_transaction(tid);
1332   }
1333   trackdb_commit_transaction(tid);
1334   for(pp = &p; *pp; pp = &(*pp)->next)
1335     ;
1336   *pp = t;
1337   return p;
1338 }
1339
1340 /* resolve alias */
1341 const char *trackdb_resolve(const char *track) {
1342   DB_TXN *tid;
1343   const char *actual;
1344
1345   for(;;) {
1346     tid = trackdb_begin_transaction();
1347     if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1348       goto fail;
1349     break;
1350 fail:
1351     trackdb_abort_transaction(tid);
1352   }
1353   trackdb_commit_transaction(tid);
1354   return actual;
1355 }
1356
1357 int trackdb_isalias(const char *track) {
1358   const char *actual = trackdb_resolve(track);
1359
1360   return strcmp(actual, track);
1361 }
1362
1363 /* test whether a track exists (perhaps an alias) */
1364 int trackdb_exists(const char *track) {
1365   DB_TXN *tid;
1366   int err;
1367
1368   for(;;) {
1369     tid = trackdb_begin_transaction();
1370     /* unusually, here we want the return value */
1371     if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1372       goto fail;
1373     break;
1374 fail:
1375     trackdb_abort_transaction(tid);
1376   }
1377   trackdb_commit_transaction(tid);
1378   return (err == 0);
1379 }
1380
1381 /* return the list of tags */
1382 char **trackdb_alltags(void) {
1383   DB_TXN *tid;
1384   int err;
1385   char **taglist;
1386
1387   for(;;) {
1388     tid = trackdb_begin_transaction();
1389     err = trackdb_alltags_tid(tid, &taglist);
1390     if(!err) break;
1391     trackdb_abort_transaction(tid);
1392   }
1393   trackdb_commit_transaction(tid);
1394   return taglist;
1395 }
1396
1397 static int trackdb_alltags_tid(DB_TXN *tid, char ***taglistp) {
1398   struct vector v;
1399   DBC *c;
1400   DBT k, d;
1401   int err;
1402
1403   vector_init(&v);
1404   c = trackdb_opencursor(trackdb_tagsdb, tid);
1405   memset(&k, 0, sizeof k);
1406   while(!(err = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1407     vector_append(&v, xstrndup(k.data, k.size));
1408   switch(err) {
1409   case DB_NOTFOUND:
1410     break;
1411   case DB_LOCK_DEADLOCK:
1412       return err;
1413   default:
1414     fatal(0, "c->c_get: %s", db_strerror(err));
1415   }
1416   if((err = trackdb_closecursor(c))) return err;
1417   vector_terminate(&v);
1418   *taglistp = v.vec;
1419   return 0;
1420 }
1421
1422 /* return 1 iff sorted tag lists A and B have at least one member in common */
1423 static int tag_intersection(char **a, char **b) {
1424   int cmp;
1425
1426   /* Same sort of logic as trackdb_set() above */
1427   while(*a && *b) {
1428     if(!(cmp = strcmp(*a, *b))) return 1;
1429     else if(cmp < 0) ++a;
1430     else ++b;
1431   }
1432   return 0;
1433 }
1434
1435 /* Check whether a track is suitable for random play.  Returns 0 if it is,
1436  * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1437  * that. */
1438 static int check_suitable(const char *track,
1439                           DB_TXN *tid,
1440                           char **required_tags,
1441                           char **prohibited_tags) {
1442   char **track_tags;
1443   time_t last, now;
1444   struct kvp *p, *t;
1445   const char *pick_at_random, *played_time;
1446
1447   /* don't pick tracks that aren't in any surviving collection (for instance
1448    * you've edited the config but the rescan hasn't done its job yet) */
1449   if(!find_track_root(track)) {
1450     info("found track not in any collection: %s", track);
1451     return DB_NOTFOUND;
1452   }
1453   /* don't pick aliases - only pick the canonical form */
1454   if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1455     return DB_LOCK_DEADLOCK;
1456   if(kvp_get(t, "_alias_for"))
1457     return DB_NOTFOUND;
1458   /* check that random play is not suppressed for this track */
1459   if((pick_at_random = kvp_get(p, "pick_at_random"))
1460      && !strcmp(pick_at_random, "0"))
1461     return DB_NOTFOUND;
1462   /* don't pick a track that's been played in the last 8 hours */
1463   if((played_time = kvp_get(p, "played_time"))) {
1464     last = atoll(played_time);
1465     now = time(0);
1466     if(now < last + 8 * 3600)       /* TODO configurable */
1467       return DB_NOTFOUND;
1468   }
1469   track_tags = parsetags(kvp_get(p, "tags"));
1470   /* check that no prohibited tag is present for this track */
1471   if(prohibited_tags && tag_intersection(track_tags, prohibited_tags))
1472     return DB_NOTFOUND;
1473   /* check that at least one required tags is present for this track */
1474   if(*required_tags && !tag_intersection(track_tags, required_tags))
1475     return DB_NOTFOUND;
1476   return 0;
1477 }
1478
1479 /* attempt to pick a random non-alias track */
1480 const char *trackdb_random(int tries) {
1481   DBT key, data;
1482   DB_BTREE_STAT *sp;
1483   int err, n;
1484   DB_TXN *tid;
1485   const char *track, *candidate;
1486   db_recno_t r;
1487   const char *tags;
1488   char **required_tags, **prohibited_tags, **tp;
1489   hash *h;
1490   DBC *c = 0;
1491
1492   for(;;) {
1493     tid = trackdb_begin_transaction();
1494     if((err = trackdb_get_global_tid("required-tags", tid, &tags)))
1495       goto fail;
1496     required_tags = parsetags(tags);
1497     if((err = trackdb_get_global_tid("prohibited-tags", tid, &tags)))
1498       goto fail;
1499     prohibited_tags = parsetags(tags);
1500     track = 0;
1501     if(*required_tags) {
1502       /* Bung all the suitable tracks into a hash and convert to a list of keys
1503        * (to eliminate duplicates).  We cache this list since it is possible
1504        * that it will be very large. */
1505       if(!reqtracks) {
1506         h = hash_new(0);
1507         for(tp = required_tags; *tp; ++tp) {
1508           c = trackdb_opencursor(trackdb_tagsdb, tid);
1509           memset(&key, 0, sizeof key);
1510           key.data = *tp;
1511           key.size = strlen(*tp);
1512           n = 0;
1513           err = c->c_get(c, &key, prepare_data(&data), DB_SET);
1514           while(err == 0) {
1515             hash_add(h, xstrndup(data.data, data.size), 0,
1516                      HASH_INSERT_OR_REPLACE);
1517             ++n;
1518             err = c->c_get(c, &key, prepare_data(&data), DB_NEXT_DUP);
1519           }
1520           switch(err) {
1521           case 0:
1522           case DB_NOTFOUND:
1523             break;
1524           case DB_LOCK_DEADLOCK:
1525             goto fail;
1526           default:
1527             fatal(0, "error querying tags.db: %s", db_strerror(err));
1528           }
1529           trackdb_closecursor(c);
1530           c = 0;
1531           if(!n)
1532             error(0, "required tag %s does not match any tracks", *tp);
1533         }
1534         nreqtracks = hash_count(h);
1535         reqtracks = hash_keys(h);
1536       }
1537       while(nreqtracks && !track && tries-- > 0) {
1538         r = (rand() * (double)nreqtracks / (RAND_MAX + 1.0));
1539         candidate = reqtracks[r];
1540         switch(check_suitable(candidate, tid,
1541                               required_tags, prohibited_tags)) {
1542         case 0:
1543           track = candidate;
1544           break;
1545         case DB_NOTFOUND:
1546           break;
1547         case DB_LOCK_DEADLOCK:
1548           goto fail;
1549         }
1550       }
1551     } else {
1552       /* No required tags.  We pick random record numbers in the database
1553        * instead. */
1554       switch(err = trackdb_tracksdb->stat(trackdb_tracksdb, tid, &sp, 0)) {
1555       case 0:
1556         break;
1557       case DB_LOCK_DEADLOCK:
1558         error(0, "error querying tracks.db: %s", db_strerror(err));
1559         goto fail;
1560       default:
1561         fatal(0, "error querying tracks.db: %s", db_strerror(err));
1562       }
1563       if(!sp->bt_nkeys)
1564         error(0, "cannot pick tracks at random from an empty database");
1565       while(sp->bt_nkeys && !track && tries-- > 0) {
1566         /* record numbers count from 1 upwards */
1567         r = 1 + (rand() * (double)sp->bt_nkeys / (RAND_MAX + 1.0));
1568         memset(&key, sizeof key, 0);
1569         key.flags = DB_DBT_MALLOC;
1570         key.size = sizeof r;
1571         key.data = &r;
1572         switch(err = trackdb_tracksdb->get(trackdb_tracksdb, tid, &key, prepare_data(&data),
1573                                            DB_SET_RECNO)) {
1574         case 0:
1575           break;
1576         case DB_LOCK_DEADLOCK:
1577           error(0, "error querying tracks.db: %s", db_strerror(err));
1578           goto fail;
1579         default:
1580           fatal(0, "error querying tracks.db: %s", db_strerror(err));
1581         }
1582         candidate = xstrndup(key.data, key.size);
1583         switch(check_suitable(candidate, tid,
1584                               required_tags, prohibited_tags)) {
1585         case 0:
1586           track = candidate;
1587           break;
1588         case DB_NOTFOUND:
1589           break;
1590         case DB_LOCK_DEADLOCK:
1591           goto fail;
1592         }
1593       }
1594     }
1595     break;
1596 fail:
1597     trackdb_closecursor(c);
1598     c = 0;
1599     trackdb_abort_transaction(tid);
1600   }
1601   trackdb_commit_transaction(tid);
1602   if(!track)
1603     error(0, "could not pick a random track");
1604   return track;
1605 }
1606
1607 /* get a track name given the prefs.  Set *used_db to 1 if we got the answer
1608  * from the prefs. */
1609 static const char *getpart(const char *track,
1610                            const char *context,
1611                            const char *part,
1612                            const struct kvp *p,
1613                            int *used_db) {
1614   const char *result;
1615   char *pref;
1616
1617   byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1618   if((result = kvp_get(p, pref)))
1619     *used_db = 1;
1620   else
1621     result = trackname_part(track, context, part);
1622   assert(result != 0);
1623   return result;
1624 }
1625
1626 /* get a track name part, like trackname_part(), but taking the database into
1627  * account. */
1628 const char *trackdb_getpart(const char *track,
1629                             const char *context,
1630                             const char *part) {
1631   struct kvp *p;
1632   DB_TXN *tid;
1633   char *pref;
1634   const char *actual;
1635   int used_db, err;
1636
1637   /* construct the full pref */
1638   byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1639   for(;;) {
1640     tid = trackdb_begin_transaction();
1641     if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1642       goto fail;
1643     break;
1644 fail:
1645     trackdb_abort_transaction(tid);
1646   }
1647   trackdb_commit_transaction(tid);
1648   return getpart(actual, context, part, p, &used_db);
1649 }
1650
1651 /* get the raw path name for @track@ (might be an alias) */
1652 const char *trackdb_rawpath(const char *track) {
1653   DB_TXN *tid;
1654   struct kvp *t;
1655   const char *path;
1656
1657   for(;;) {
1658     tid = trackdb_begin_transaction();
1659     if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1660       goto fail;
1661     break;
1662 fail:
1663     trackdb_abort_transaction(tid);
1664   }
1665   trackdb_commit_transaction(tid);
1666   if(!(path = kvp_get(t, "_path"))) path = track;
1667   return path;
1668 }
1669
1670 /* trackdb_list **************************************************************/
1671
1672 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1673  * readable at some point */
1674
1675 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1676  * If RE is a null pointer then it matches everything. */
1677 static int track_matches(size_t dl, const char *track, size_t tl,
1678                          const pcre *re) {
1679   int ovec[3], rc;
1680
1681   if(!re)
1682     return 1;
1683   track += dl + 1;
1684   tl -= (dl + 1);
1685   switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1686   case PCRE_ERROR_NOMATCH: return 0;
1687   default:
1688     if(rc < 0) {
1689       error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1690       return 0;
1691     }
1692     return 1;
1693   }
1694 }
1695
1696 static int do_list(struct vector *v, const char *dir,
1697                    enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1698   DBC *cursor;
1699   DBT k, d;
1700   size_t dl;
1701   char *ptr;
1702   int err;
1703   size_t l, last_dir_len = 0;
1704   char *last_dir = 0, *track, *alias;
1705   struct kvp *p;
1706
1707   dl = strlen(dir);
1708   cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1709   make_key(&k, dir);
1710   prepare_data(&d);
1711   /* find the first key >= dir */
1712   err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1713   /* keep going while we're dealing with <dir/anything> */
1714   while(err == 0
1715         && k.size > dl
1716         && ((char *)k.data)[dl] == '/'
1717         && !memcmp(k.data, dir, dl)) {
1718     ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1719     if(ptr) {
1720       /* we have <dir/component/anything>, so <dir/component> is a directory */
1721       l = ptr - (char *)k.data;
1722       if(what & trackdb_directories)
1723         if(!(last_dir
1724              && l == last_dir_len
1725              && !memcmp(last_dir, k.data, l))) {
1726           last_dir = xstrndup(k.data, last_dir_len = l);
1727           if(track_matches(dl, k.data, l, re))
1728             vector_append(v, last_dir);
1729         }
1730     } else {
1731       /* found a plain file */
1732       if((what & trackdb_files)) {
1733         track = xstrndup(k.data, k.size);
1734         if((err = trackdb_getdata(trackdb_prefsdb,
1735                                   track, &p, tid)) == DB_LOCK_DEADLOCK)
1736           goto deadlocked;
1737         /* if this file has an alias in the same directory then we skip it */
1738         if((err = compute_alias(&alias, track, p, tid)))
1739           goto deadlocked;
1740         if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1741           if(track_matches(dl, k.data, k.size, re))
1742             vector_append(v, track);
1743       }
1744     }
1745     err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1746   }
1747   switch(err) {
1748   case 0:
1749     break;
1750   case DB_NOTFOUND:
1751     err = 0;
1752     break;
1753   case DB_LOCK_DEADLOCK:
1754     error(0, "error querying database: %s", db_strerror(err));
1755     break;
1756   default:
1757     fatal(0, "error querying database: %s", db_strerror(err));
1758   }
1759 deadlocked:
1760   if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1761   return err;
1762 }
1763
1764 /* return the directories or files below @dir@ */
1765 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
1766                     const pcre *re) {
1767   DB_TXN *tid;
1768   int n;
1769   struct vector v;
1770
1771   vector_init(&v);
1772   for(;;) {
1773     tid = trackdb_begin_transaction();
1774     v.nvec = 0;
1775     if(dir) {
1776       if(do_list(&v, dir, what, re, tid))
1777         goto fail;
1778     } else {
1779       for(n = 0; n < config->collection.n; ++n)
1780         if(do_list(&v, config->collection.s[n].root, what, re, tid))
1781           goto fail;
1782     }
1783     break;
1784 fail:
1785     trackdb_abort_transaction(tid);
1786   }
1787   trackdb_commit_transaction(tid);
1788   vector_terminate(&v);
1789   if(np)
1790     *np = v.nvec;
1791   return v.vec;
1792 }
1793
1794 /* If S is tag:something, return something.  Else return 0. */
1795 static const char *checktag(const char *s) {
1796   if(!strncmp(s, "tag:", 4))
1797     return s + 4;
1798   else
1799     return 0;
1800 }
1801
1802 /* return a list of tracks containing all of the words given.  If you
1803  * ask for only stopwords you get no tracks. */
1804 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
1805   const char **w, *best = 0, *tag;
1806   char **twords, **tags;
1807   int i, j, n, err, what;
1808   DBC *cursor = 0;
1809   DBT k, d;
1810   struct vector u, v;
1811   DB_TXN *tid;
1812   struct kvp *p;
1813   int ntags = 0;
1814   DB *db;
1815   const char *dbname;
1816
1817   *ntracks = 0;                         /* for early returns */
1818   /* casefold all the words */
1819   w = xmalloc(nwordlist * sizeof (char *));
1820   for(n = 0; n < nwordlist; ++n) {
1821     w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
1822     if(checktag(w[n])) ++ntags;         /* count up tags */
1823   }
1824   /* find the longest non-stopword */
1825   for(n = 0; n < nwordlist; ++n)
1826     if(!stopword(w[n]) && !checktag(w[n]))
1827       if(!best || strlen(w[n]) > strlen(best))
1828         best = w[n];
1829   /* TODO: we should at least in principal be able to identify the word or tag
1830    * with the least matches in log time, and choose that as our primary search
1831    * term. */
1832   if(ntags && !best) {
1833     /* Only tags are listed.  We limit to the first and narrow down with the
1834      * rest. */
1835     best = checktag(w[0]);
1836     db = trackdb_tagsdb;
1837     dbname = "tags";
1838   } else if(best) {
1839     /* We can limit to some word. */
1840     db = trackdb_searchdb;
1841     dbname = "search";
1842   } else {
1843     /* Only stopwords */
1844     return 0;
1845   }
1846   vector_init(&u);
1847   vector_init(&v);
1848   for(;;) {
1849     tid = trackdb_begin_transaction();
1850     /* find all the tracks that have that word */
1851     make_key(&k, best);
1852     prepare_data(&d);
1853     what = DB_SET;
1854     v.nvec = 0;
1855     cursor = trackdb_opencursor(db, tid);
1856     while(!(err = cursor->c_get(cursor, &k, &d, what))) {
1857       vector_append(&v, xstrndup(d.data, d.size));
1858       what = DB_NEXT_DUP;
1859     }
1860     switch(err) {
1861     case DB_NOTFOUND:
1862       err = 0;
1863       break;
1864     case DB_LOCK_DEADLOCK:
1865       error(0, "error querying %s database: %s", dbname, db_strerror(err));
1866       break;
1867     default:
1868       fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
1869     }
1870     if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1871     cursor = 0;
1872     /* do a naive search over that (hopefuly fairly small) list of tracks */
1873     u.nvec = 0;
1874     for(n = 0; n < v.nvec; ++n) {
1875       if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
1876         goto fail;
1877       else if(err) {
1878         error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
1879         continue;
1880       }
1881       twords = track_to_words(v.vec[n], p);
1882       tags = parsetags(kvp_get(p, "tags"));
1883       for(i = 0; i < nwordlist; ++i) {
1884         if((tag = checktag(w[i]))) {
1885           /* Track must have this tag */
1886           for(j = 0; tags[j]; ++j)
1887             if(!strcmp(tag, tags[j])) break; /* tag found */
1888           if(!tags[j]) break;           /* tag not found */
1889         } else {
1890           /* Track must contain this word */
1891           for(j = 0; twords[j]; ++j)
1892             if(!strcmp(w[i], twords[j])) break; /* word found */
1893           if(!twords[j]) break;         /* word not found */
1894         }
1895       }
1896       if(i >= nwordlist)                /* all words found */
1897         vector_append(&u, v.vec[n]);
1898     }
1899     break;
1900   fail:
1901     trackdb_closecursor(cursor);
1902     cursor = 0;
1903     trackdb_abort_transaction(tid);
1904     info("retrying search");
1905   }
1906   trackdb_commit_transaction(tid);
1907   vector_terminate(&u);
1908   if(ntracks)
1909     *ntracks = u.nvec;
1910   return u.vec;
1911 }
1912
1913 /* trackdb_scan **************************************************************/
1914
1915 int trackdb_scan(const char *root,
1916                  int (*callback)(const char *track,
1917                                  struct kvp *data,
1918                                  void *u,
1919                                  DB_TXN *tid),
1920                  void *u,
1921                  DB_TXN *tid) {
1922   DBC *cursor;
1923   DBT k, d;
1924   const size_t root_len = root ? strlen(root) : 0;
1925   int err, cberr;
1926   struct kvp *data;
1927   const char *track;
1928
1929   cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1930   if(root)
1931     err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
1932                         DB_SET_RANGE);
1933   else {
1934     memset(&k, 0, sizeof k);
1935     err = cursor->c_get(cursor, &k, prepare_data(&d),
1936                         DB_FIRST);
1937   }
1938   while(!err) {
1939     if(!root
1940        || (k.size > root_len
1941            && !strncmp(k.data, root, root_len)
1942            && ((char *)k.data)[root_len] == '/')) {
1943       data = kvp_urldecode(d.data, d.size);
1944       if(kvp_get(data, "_path")) {
1945         track = xstrndup(k.data, k.size);
1946         /* Advance to the next track before the callback so that the callback
1947          * may safely delete the track */
1948         err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1949         if((cberr = callback(track, data, u, tid))) {
1950           err = cberr;
1951           break;
1952         }
1953       } else
1954         err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1955     } else
1956       break;
1957   }
1958   trackdb_closecursor(cursor);
1959   switch(err) {
1960   case EINTR:
1961     return err;
1962   case 0:
1963   case DB_NOTFOUND:
1964     return 0;
1965   case DB_LOCK_DEADLOCK:
1966     error(0, "c->c_get: %s", db_strerror(err));
1967     return err;
1968   default:
1969     fatal(0, "c->c_get: %s", db_strerror(err));
1970   }
1971 }
1972
1973 /* trackdb_rescan ************************************************************/
1974
1975 /* called when the rescanner terminates */
1976 static int reap_rescan(ev_source attribute((unused)) *ev,
1977                        pid_t pid,
1978                        int status,
1979                        const struct rusage attribute((unused)) *rusage,
1980                        void attribute((unused)) *u) {
1981   if(pid == rescan_pid) rescan_pid = -1;
1982   if(status)
1983     error(0, "disorderd-rescan: %s", wstat(status));
1984   else
1985     D(("disorderd-rescan terminate: %s", wstat(status)));
1986   /* Our cache of file lookups is out of date now */
1987   cache_clean(&cache_files_type);
1988   eventlog("rescanned", (char *)0);
1989   return 0;
1990 }
1991
1992 void trackdb_rescan(ev_source *ev) {
1993   if(rescan_pid != -1) {
1994     error(0, "rescan already underway");
1995     return;
1996   }
1997   rescan_pid = subprogram(ev, RESCAN, -1);
1998   ev_child(ev, rescan_pid, 0, reap_rescan, 0);
1999   D(("started rescanner"));
2000
2001 }
2002
2003 int trackdb_rescan_cancel(void) {
2004   if(rescan_pid == -1) return 0;
2005   if(kill(rescan_pid, SIGTERM) < 0)
2006     fatal(errno, "error killing rescanner");
2007   rescan_pid = -1;
2008   return 1;
2009 }
2010
2011 /* global prefs **************************************************************/
2012
2013 void trackdb_set_global(const char *name,
2014                         const char *value,
2015                         const char *who) {
2016   DB_TXN *tid;
2017   int err;
2018   int state;
2019
2020   for(;;) {
2021     tid = trackdb_begin_transaction();
2022     if(!(err = trackdb_set_global_tid(name, value, tid)))
2023       break;
2024     trackdb_abort_transaction(tid);
2025   }
2026   trackdb_commit_transaction(tid);
2027   /* log important state changes */
2028   if(!strcmp(name, "playing")) {
2029     state = !value || !strcmp(value, "yes");
2030     info("playing %s by %s",
2031          state ? "enabled" : "disabled",
2032          who ? who : "-");
2033     eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2034   }
2035   if(!strcmp(name, "random-play")) {
2036     state = !value || !strcmp(value, "yes");
2037     info("random play %s by %s",
2038          state ? "enabled" : "disabled",
2039          who ? who : "-");
2040     eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2041   }
2042   if(!strcmp(name, "required-tags"))
2043     reqtracks = 0;
2044 }
2045
2046 int trackdb_set_global_tid(const char *name,
2047                            const char *value,
2048                            DB_TXN *tid) {
2049   DBT k, d;
2050   int err;
2051
2052   memset(&k, 0, sizeof k);
2053   memset(&d, 0, sizeof d);
2054   k.data = (void *)name;
2055   k.size = strlen(name);
2056   if(value) {
2057     d.data = (void *)value;
2058     d.size = strlen(value);
2059   }
2060   if(value)
2061     err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2062   else
2063     err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2064   if(err == DB_LOCK_DEADLOCK) return err;
2065   if(err)
2066     fatal(0, "error updating database: %s", db_strerror(err));
2067   return 0;
2068 }
2069
2070 const char *trackdb_get_global(const char *name) {
2071   DB_TXN *tid;
2072   int err;
2073   const char *r;
2074
2075   for(;;) {
2076     tid = trackdb_begin_transaction();
2077     if(!(err = trackdb_get_global_tid(name, tid, &r)))
2078       break;
2079     trackdb_abort_transaction(tid);
2080   }
2081   trackdb_commit_transaction(tid);
2082   return r;
2083 }
2084
2085 int trackdb_get_global_tid(const char *name,
2086                            DB_TXN *tid,
2087                            const char **rp) {
2088   DBT k, d;
2089   int err;
2090
2091   memset(&k, 0, sizeof k);
2092   k.data = (void *)name;
2093   k.size = strlen(name);
2094   switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2095                                      prepare_data(&d), 0)) {
2096   case 0:
2097     *rp = xstrndup(d.data, d.size);
2098     return 0;
2099   case DB_NOTFOUND:
2100     *rp = 0;
2101     return 0;
2102   case DB_LOCK_DEADLOCK:
2103     return err;
2104   default:
2105     fatal(0, "error reading database: %s", db_strerror(err));
2106   }
2107 }
2108
2109 /** @brief Retrieve the most recently added tracks
2110  * @param ntracksp Where to put count, or 0
2111  * @param maxtracks Maximum number of tracks to retrieve
2112  * @return null-terminated array of track names
2113  *
2114  * The most recently added track is first in the array.
2115  */
2116 char **trackdb_new(int *ntracksp,
2117                    int maxtracks) {
2118   DB_TXN *tid;
2119   char **tracks;
2120
2121   for(;;) {
2122     tid = trackdb_begin_transaction();
2123     tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2124     if(tracks)
2125       break;
2126     trackdb_abort_transaction(tid);
2127   }
2128   trackdb_commit_transaction(tid);
2129   return tracks;
2130 }
2131
2132 /** @brief Retrieve the most recently added tracks
2133  * @param ntracksp Where to put count, or 0
2134  * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2135  * @param tid Transaction ID
2136  * @return null-terminated array of track names, or NULL on deadlock
2137  *
2138  * The most recently added track is first in the array.
2139  */
2140 static char **trackdb_new_tid(int *ntracksp,
2141                               int maxtracks,
2142                               DB_TXN *tid) {
2143   DBC *c;
2144   DBT k, d;
2145   int err = 0;
2146   struct vector tracks[1];
2147
2148   vector_init(tracks);
2149   c = trackdb_opencursor(trackdb_noticeddb, tid);
2150   while((maxtracks <= 0 || tracks->nvec < maxtracks)
2151         && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV)))
2152     vector_append(tracks, xstrndup(d.data, d.size));
2153   switch(err) {
2154   case 0:                               /* hit maxtracks */
2155   case DB_NOTFOUND:                     /* ran out of tracks */
2156     break;
2157   case DB_LOCK_DEADLOCK:
2158     trackdb_closecursor(c);
2159     return 0;
2160   default:
2161     fatal(0, "error reading noticed.db: %s", db_strerror(err));
2162   }
2163   if((err = trackdb_closecursor(c)))
2164     return 0;                           /* deadlock */
2165   vector_terminate(tracks);
2166   if(ntracksp)
2167     *ntracksp = tracks->nvec;
2168   return tracks->vec;
2169 }
2170
2171 /** @brief Expire noticed.db
2172  * @param earliest Earliest timestamp to keep
2173  */
2174 void trackdb_expire_noticed(time_t earliest) {
2175   DB_TXN *tid;
2176
2177   for(;;) {
2178     tid = trackdb_begin_transaction();
2179     if(!trackdb_expire_noticed_tid(earliest, tid))
2180       break;
2181     trackdb_abort_transaction(tid);
2182   }
2183   trackdb_commit_transaction(tid);
2184 }
2185
2186 /** @brief Expire noticed.db
2187  * @param earliest Earliest timestamp to keep
2188  * @param tid Transaction ID
2189  * @return 0 or DB_LOCK_DEADLOCK
2190  */
2191 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2192   DBC *c;
2193   DBT k, d;
2194   int err = 0, ret;
2195   time_t when;
2196   uint32_t *kk;
2197   int count = 0;
2198
2199   c = trackdb_opencursor(trackdb_noticeddb, tid);
2200   while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2201     kk = k.data;
2202     when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2203     if(when >= earliest)
2204       break;
2205     if((err = c->c_del(c, 0))) {
2206       if(err != DB_LOCK_DEADLOCK)
2207         fatal(0, "error deleting expired noticed.db entry: %s",
2208               db_strerror(err));
2209       break;
2210     }
2211     ++count;
2212   }
2213   if(err == DB_NOTFOUND)
2214     err = 0;
2215   if(err && err != DB_LOCK_DEADLOCK)
2216     fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2217   ret = err;
2218   if((err = trackdb_closecursor(c))) {
2219     if(err != DB_LOCK_DEADLOCK)
2220       fatal(0, "error closing cursor: %s", db_strerror(err));
2221     ret = err;
2222   }
2223   if(!ret && count)
2224     info("expired %d tracks from noticed.db", count);
2225   return ret;
2226 }
2227
2228 /* tidying up ****************************************************************/
2229
2230 void trackdb_gc(void) {
2231   int err;
2232   char **logfiles;
2233
2234   if((err = trackdb_env->txn_checkpoint(trackdb_env,
2235                                         config->checkpoint_kbyte,
2236                                         config->checkpoint_min,
2237                                         0)))
2238     fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2239   if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2240     fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2241   /* This makes catastrophic recovery impossible.  However, the user can still
2242    * preserve the important data by using disorder-dump to snapshot their
2243    * prefs, and later to restore it.  This is likely to have much small
2244    * long-term storage requirements than record the db logfiles. */
2245 }
2246
2247 /*
2248 Local Variables:
2249 c-basic-offset:2
2250 comment-column:40
2251 fill-column:79
2252 indent-tabs-mode:nil
2253 End:
2254 */