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