2 * This file is part of DisOrder
3 * Copyright (C) 2005, 2007 Richard Kettlewell
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.
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.
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
28 struct vector; /* forward declaration */
30 extern DB_ENV *trackdb_env;
32 extern DB *trackdb_tracksdb;
33 extern DB *trackdb_prefsdb;
34 extern DB *trackdb_searchdb;
35 extern DB *trackdb_tagsdb;
36 extern DB *trackdb_noticeddb;
37 extern DB *trackdb_globaldb;
38 extern DB *trackdb_usersdb;
39 extern DB *trackdb_scheduledb;
41 DBC *trackdb_opencursor(DB *db, DB_TXN *tid);
42 /* open a transaction */
44 int trackdb_closecursor(DBC *c);
45 /* close transaction, returns 0 or DB_LOCK_DEADLOCK */
47 int trackdb_notice(const char *track,
49 int trackdb_notice_tid(const char *track,
52 /* notice a track; return DB_NOTFOUND if new, else 0. _tid can return
53 * DB_LOCK_DEADLOCK too. */
55 int trackdb_obsolete(const char *track, DB_TXN *tid);
56 /* obsolete a track */
58 DB_TXN *trackdb_begin_transaction(void);
59 void trackdb_abort_transaction(DB_TXN *tid);
60 void trackdb_commit_transaction(DB_TXN *tid);
61 /* begin, abort or commit a transaction */
63 /** @brief Evaluate @p expr in a transaction, looping on deadlock
65 * @c tid will be the transaction handle. @p e will be the error code.
67 #define WITH_TRANSACTION(expr) do { \
70 tid = trackdb_begin_transaction(); \
71 while((e = (expr)) == DB_LOCK_DEADLOCK) { \
72 trackdb_abort_transaction(tid); \
73 tid = trackdb_begin_transaction(); \
76 trackdb_abort_transaction(tid); \
78 trackdb_commit_transaction(tid); \
81 int trackdb_getdata(DB *db,
85 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
86 * DB_LOCK_DEADLOCK. */
88 int trackdb_putdata(DB *db,
93 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
94 * DB_LOCK_DEADLOCK. */
96 int trackdb_delkey(DB *db,
99 /* delete a database entry. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
101 int trackdb_delkeydata(DB *db,
105 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
107 int trackdb_scan(const char *root,
108 int (*callback)(const char *track,
115 /* Call CALLBACK for each non-alias track below ROOT (or all tracks if ROOT is
116 * 0). Return 0 or DB_LOCK_DEADLOCK. CALLBACK should return 0 on success or
117 * EINTR to cancel the scan. */
119 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid);
121 /* fill KEY in with S, returns KEY */
122 static inline DBT *make_key(DBT *key, const char *s) {
123 memset(key, 0, sizeof *key);
124 key->data = (void *)s;
125 key->size = strlen(s);
129 /* set DATA up to receive data, returns DATA */
130 static inline DBT *prepare_data(DBT *data) {
131 memset(data, 0, sizeof *data);
132 data->flags = DB_DBT_MALLOC;
136 /* encode K and store in DATA, returns DATA */
137 static inline DBT *encode_data(DBT *data, const struct kvp *k) {
140 memset(data, 0, sizeof *data);
141 data->data = kvp_urlencode(k, &size);
146 int trackdb_set_global_tid(const char *name,
149 int trackdb_get_global_tid(const char *name,
153 char **parsetags(const char *s);
154 int tag_intersection(char **a, char **b);
156 #endif /* TRACKDB_INT_H */