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