chiark - git - mdw - disorder/blob - server/trackdb-int.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2005, 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 #ifndef TRACKDB_INT_H
  22 #define TRACKDB_INT_H
  23
  24 extern DB_ENV *trackdb_env;
  25
  26 extern DB *trackdb_tracksdb;
  27 extern DB *trackdb_prefsdb;
  28 extern DB *trackdb_searchdb;
  29 extern DB *trackdb_tagsdb;
  30 extern DB *trackdb_noticeddb;
  31 extern DB *trackdb_globaldb;
  32 extern DB *trackdb_usersdb;
  33
  34 DBC *trackdb_opencursor(DB *db, DB_TXN *tid);
  35 /* open a transaction */
  36
  37 int trackdb_closecursor(DBC *c);
  38 /* close transaction, returns 0 or DB_LOCK_DEADLOCK */
  39
  40 int trackdb_notice(const char *track,
  41                    const char *path);
  42 int trackdb_notice_tid(const char *track,
  43                        const char *path,
  44                        DB_TXN *tid);
  45 /* notice a track; return DB_NOTFOUND if new, else 0.  _tid can return
  46  * DB_LOCK_DEADLOCK too. */
  47
  48 int trackdb_obsolete(const char *track, DB_TXN *tid);
  49 /* obsolete a track */
  50
  51 DB_TXN *trackdb_begin_transaction(void);
  52 void trackdb_abort_transaction(DB_TXN *tid);
  53 void trackdb_commit_transaction(DB_TXN *tid);
  54 /* begin, abort or commit a transaction */
  55
  56 int trackdb_getdata(DB *db,
  57                     const char *track,
  58                     struct kvp **kp,
  59                     DB_TXN *tid);
  60 /* fetch and decode a database entry.  Returns 0, DB_NOTFOUND or
  61  * DB_LOCK_DEADLOCK. */
  62
  63 int trackdb_putdata(DB *db,
  64                     const char *track,
  65                     const struct kvp *k,
  66                     DB_TXN *tid,
  67                     u_int32_t flags);
  68 /* encode and store a database entry.  Returns 0, DB_KEYEXIST or
  69  * DB_LOCK_DEADLOCK. */
  70
  71 int trackdb_delkey(DB *db,
  72                    const char *track,
  73                    DB_TXN *tid);
  74 /* delete a database entry.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
  75
  76 int trackdb_delkeydata(DB *db,
  77                        const char *word,
  78                        const char *track,
  79                        DB_TXN *tid);
  80 /* delete a (key,data) pair.  Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
  81
  82 int trackdb_scan(const char *root,
  83                  int (*callback)(const char *track,
  84                                  struct kvp *data,
  85                                  void *u,
  86                                  DB_TXN *tid),
  87                  void *u,
  88                  DB_TXN *tid);
  89 /* Call CALLBACK for each non-alias track below ROOT (or all tracks if ROOT is
  90  * 0).  Return 0 or DB_LOCK_DEADLOCK.  CALLBACK should return 0 on success or
  91  * EINTR to cancel the scan. */
  92
  93 /* fill KEY in with S, returns KEY */
  94
  95 static inline DBT *make_key(DBT *key, const char *s) {
  96   memset(key, 0, sizeof *key);
  97   key->data = (void *)s;
  98   key->size = strlen(s);
  99   return key;
 100 }
 101
 102 /* set DATA up to receive data, returns DATA */
 103 static inline DBT *prepare_data(DBT *data) {
 104   memset(data, 0, sizeof *data);
 105   data->flags = DB_DBT_MALLOC;
 106   return data;
 107 }
 108
 109 /* encode K and store in DATA, returns DATA */
 110 static inline DBT *encode_data(DBT *data, const struct kvp *k) {
 111   size_t size;
 112
 113   memset(data, 0, sizeof *data);
 114   data->data = kvp_urlencode(k, &size);
 115   data->size = size;
 116   return data;
 117 }
 118
 119 int trackdb_set_global_tid(const char *name,
 120                            const char *value,
 121                            DB_TXN *tid);
 122 int trackdb_get_global_tid(const char *name,
 123                            DB_TXN *tid,
 124                            const char **rp);
 125
 126 #endif /* TRACKDB_INT_H */
 127
 128 /*
 129 Local Variables:
 130 c-basic-offset:2
 131 comment-column:40
 132 fill-column:79
 133 indent-tabs-mode:nil
 134 End:
 135 */