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
24 struct vector
; /* forward declaration */
26 extern DB_ENV
*trackdb_env
;
28 extern DB
*trackdb_tracksdb
;
29 extern DB
*trackdb_prefsdb
;
30 extern DB
*trackdb_searchdb
;
31 extern DB
*trackdb_tagsdb
;
32 extern DB
*trackdb_noticeddb
;
33 extern DB
*trackdb_globaldb
;
34 extern DB
*trackdb_usersdb
;
36 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
);
37 /* open a transaction */
39 int trackdb_closecursor(DBC
*c
);
40 /* close transaction, returns 0 or DB_LOCK_DEADLOCK */
42 int trackdb_notice(const char *track
,
44 int trackdb_notice_tid(const char *track
,
47 /* notice a track; return DB_NOTFOUND if new, else 0. _tid can return
48 * DB_LOCK_DEADLOCK too. */
50 int trackdb_obsolete(const char *track
, DB_TXN
*tid
);
51 /* obsolete a track */
53 DB_TXN
*trackdb_begin_transaction(void);
54 void trackdb_abort_transaction(DB_TXN
*tid
);
55 void trackdb_commit_transaction(DB_TXN
*tid
);
56 /* begin, abort or commit a transaction */
58 /** @brief Evaluate @p expr in a transaction, looping on deadlock
60 * @c tid will be the transaction handle. @p e will be the error code.
62 #define WITH_TRANSACTION(expr) do { \
65 tid = trackdb_begin_transaction(); \
66 while((e = (expr)) == DB_LOCK_DEADLOCK) { \
67 trackdb_abort_transaction(tid); \
68 tid = trackdb_begin_transaction(); \
71 trackdb_abort_transaction(tid); \
73 trackdb_commit_transaction(tid); \
76 int trackdb_getdata(DB
*db
,
80 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
81 * DB_LOCK_DEADLOCK. */
83 int trackdb_putdata(DB
*db
,
88 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
89 * DB_LOCK_DEADLOCK. */
91 int trackdb_delkey(DB
*db
,
94 /* delete a database entry. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
96 int trackdb_delkeydata(DB
*db
,
100 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
102 int trackdb_scan(const char *root
,
103 int (*callback
)(const char *track
,
109 /* Call CALLBACK for each non-alias track below ROOT (or all tracks if ROOT is
110 * 0). Return 0 or DB_LOCK_DEADLOCK. CALLBACK should return 0 on success or
111 * EINTR to cancel the scan. */
113 int trackdb_listkeys(DB
*db
, struct vector
*v
, DB_TXN
*tid
);
115 /* fill KEY in with S, returns KEY */
116 static inline DBT
*make_key(DBT
*key
, const char *s
) {
117 memset(key
, 0, sizeof *key
);
118 key
->data
= (void *)s
;
119 key
->size
= strlen(s
);
123 /* set DATA up to receive data, returns DATA */
124 static inline DBT
*prepare_data(DBT
*data
) {
125 memset(data
, 0, sizeof *data
);
126 data
->flags
= DB_DBT_MALLOC
;
130 /* encode K and store in DATA, returns DATA */
131 static inline DBT
*encode_data(DBT
*data
, const struct kvp
*k
) {
134 memset(data
, 0, sizeof *data
);
135 data
->data
= kvp_urlencode(k
, &size
);
140 int trackdb_set_global_tid(const char *name
,
143 int trackdb_get_global_tid(const char *name
,
147 #endif /* TRACKDB_INT_H */