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