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