1 /*
2 Unix SMB/CIFS implementation.
3
4 Python interface to tdb.
5
6 Copyright (C) 2004-2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2007-2008 Jelmer Vernooij <jelmer@samba.org>
8
9 ** NOTE! The following LGPL license applies to the tdb
10 ** library. This does NOT imply that all of Samba is released
11 ** under the LGPL
12
13 This library is free software; you can redistribute it and/or
14 modify it under the terms of the GNU Lesser General Public
15 License as published by the Free Software Foundation; either
16 version 3 of the License, or (at your option) any later version.
17
18 This library is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
22
23 You should have received a copy of the GNU Lesser General Public
24 License along with this library; if not, see <http://www.gnu.org/licenses/>.
25 */
26
27 #include <Python.h>
28 #include "replace.h"
29 #include "system/filesys.h"
30
31 /* Include tdb headers */
32 #include <tdb.h>
33
34 #if PY_MAJOR_VERSION >= 3
35 #define PyInt_FromLong PyLong_FromLong
36 #define PyInt_Check PyLong_Check
37 #define PyInt_AsLong PyLong_AsLong
38 #define Py_TPFLAGS_HAVE_ITER 0
39 #endif
40
41 /* discard signature of 'func' in favour of 'target_sig' */
42 #define PY_DISCARD_FUNC_SIG(target_sig, func) (target_sig)(void(*)(void))func
43
44 typedef struct {
45 PyObject_HEAD
46 TDB_CONTEXT *ctx;
47 bool closed;
48 } PyTdbObject;
49
50 static PyTypeObject PyTdb;
51
PyErr_SetTDBError(TDB_CONTEXT * tdb)52 static void PyErr_SetTDBError(TDB_CONTEXT *tdb)
53 {
54 PyErr_SetObject(PyExc_RuntimeError,
55 Py_BuildValue("(i,s)", tdb_error(tdb), tdb_errorstr(tdb)));
56 }
57
PyBytes_AsTDB_DATA(PyObject * data)58 static TDB_DATA PyBytes_AsTDB_DATA(PyObject *data)
59 {
60 TDB_DATA ret;
61 ret.dptr = (unsigned char *)PyBytes_AsString(data);
62 ret.dsize = PyBytes_Size(data);
63 return ret;
64 }
65
PyBytes_FromTDB_DATA(TDB_DATA data)66 static PyObject *PyBytes_FromTDB_DATA(TDB_DATA data)
67 {
68 if (data.dptr == NULL && data.dsize == 0) {
69 Py_RETURN_NONE;
70 } else {
71 PyObject *ret = PyBytes_FromStringAndSize((const char *)data.dptr,
72 data.dsize);
73 free(data.dptr);
74 return ret;
75 }
76 }
77
78 #define PyErr_TDB_ERROR_IS_ERR_RAISE(ret, tdb) \
79 if (ret != 0) { \
80 PyErr_SetTDBError(tdb); \
81 return NULL; \
82 }
83
84 #define PyErr_TDB_RAISE_IF_CLOSED(self) \
85 if (self->closed) { \
86 PyErr_SetObject(PyExc_RuntimeError, \
87 Py_BuildValue("(i,s)", TDB_ERR_IO, "Database is already closed")); \
88 return NULL; \
89 }
90
91 #define PyErr_TDB_RAISE_RETURN_MINUS_1_IF_CLOSED(self) \
92 if (self->closed) { \
93 PyErr_SetObject(PyExc_RuntimeError, \
94 Py_BuildValue("(i,s)", TDB_ERR_IO, "Database is already closed")); \
95 return -1; \
96 }
97
py_tdb_open(PyTypeObject * type,PyObject * args,PyObject * kwargs)98 static PyObject *py_tdb_open(PyTypeObject *type, PyObject *args, PyObject *kwargs)
99 {
100 char *name = NULL;
101 int hash_size = 0, tdb_flags = TDB_DEFAULT, flags = O_RDWR, mode = 0600;
102 TDB_CONTEXT *ctx;
103 PyTdbObject *ret;
104 const char *_kwnames[] = { "name", "hash_size", "tdb_flags", "flags", "mode", NULL };
105 char **kwnames = discard_const_p(char *, _kwnames);
106
107 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|siiii", kwnames, &name, &hash_size, &tdb_flags, &flags, &mode))
108 return NULL;
109
110 if (name == NULL) {
111 tdb_flags |= TDB_INTERNAL;
112 }
113
114 ctx = tdb_open(name, hash_size, tdb_flags, flags, mode);
115 if (ctx == NULL) {
116 PyErr_SetFromErrno(PyExc_IOError);
117 return NULL;
118 }
119
120 ret = PyObject_New(PyTdbObject, &PyTdb);
121 if (!ret) {
122 tdb_close(ctx);
123 return NULL;
124 }
125
126 ret->ctx = ctx;
127 ret->closed = false;
128 return (PyObject *)ret;
129 }
130
obj_transaction_cancel(PyTdbObject * self,PyObject * Py_UNUSED (ignored))131 static PyObject *obj_transaction_cancel(PyTdbObject *self,
132 PyObject *Py_UNUSED(ignored))
133 {
134 int ret;
135
136 PyErr_TDB_RAISE_IF_CLOSED(self);
137
138 ret = tdb_transaction_cancel(self->ctx);
139 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
140 Py_RETURN_NONE;
141 }
142
obj_transaction_commit(PyTdbObject * self,PyObject * Py_UNUSED (ignored))143 static PyObject *obj_transaction_commit(PyTdbObject *self,
144 PyObject *Py_UNUSED(ignored))
145 {
146 int ret;
147 PyErr_TDB_RAISE_IF_CLOSED(self);
148 ret = tdb_transaction_commit(self->ctx);
149 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
150 Py_RETURN_NONE;
151 }
152
obj_transaction_prepare_commit(PyTdbObject * self,PyObject * Py_UNUSED (ignored))153 static PyObject *obj_transaction_prepare_commit(PyTdbObject *self,
154 PyObject *Py_UNUSED(ignored))
155 {
156 int ret;
157 PyErr_TDB_RAISE_IF_CLOSED(self);
158 ret = tdb_transaction_prepare_commit(self->ctx);
159 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
160 Py_RETURN_NONE;
161 }
162
obj_transaction_start(PyTdbObject * self,PyObject * Py_UNUSED (ignored))163 static PyObject *obj_transaction_start(PyTdbObject *self,
164 PyObject *Py_UNUSED(ignored))
165 {
166 int ret;
167 PyErr_TDB_RAISE_IF_CLOSED(self);
168 ret = tdb_transaction_start(self->ctx);
169 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
170 Py_RETURN_NONE;
171 }
172
obj_reopen(PyTdbObject * self,PyObject * Py_UNUSED (ignored))173 static PyObject *obj_reopen(PyTdbObject *self,
174 PyObject *Py_UNUSED(ignored))
175 {
176 int ret;
177 PyErr_TDB_RAISE_IF_CLOSED(self);
178 ret = tdb_reopen(self->ctx);
179 if (ret != 0) {
180 self->closed = true;
181 PyErr_SetObject(PyExc_RuntimeError,
182 Py_BuildValue("(i,s)",
183 TDB_ERR_IO,
184 "Failed to reopen database"));
185 return NULL;
186 }
187 Py_RETURN_NONE;
188 }
189
obj_lockall(PyTdbObject * self,PyObject * Py_UNUSED (ignored))190 static PyObject *obj_lockall(PyTdbObject *self,
191 PyObject *Py_UNUSED(ignored))
192 {
193 int ret;
194 PyErr_TDB_RAISE_IF_CLOSED(self);
195 ret = tdb_lockall(self->ctx);
196 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
197 Py_RETURN_NONE;
198 }
199
obj_unlockall(PyTdbObject * self,PyObject * Py_UNUSED (ignored))200 static PyObject *obj_unlockall(PyTdbObject *self,
201 PyObject *Py_UNUSED(ignored))
202 {
203 int ret;
204 PyErr_TDB_RAISE_IF_CLOSED(self);
205 ret = tdb_unlockall(self->ctx);
206 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
207 Py_RETURN_NONE;
208 }
209
obj_lockall_read(PyTdbObject * self,PyObject * Py_UNUSED (ignored))210 static PyObject *obj_lockall_read(PyTdbObject *self,
211 PyObject *Py_UNUSED(ignored))
212 {
213 int ret;
214 PyErr_TDB_RAISE_IF_CLOSED(self);
215 ret = tdb_lockall_read(self->ctx);
216 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
217 Py_RETURN_NONE;
218 }
219
obj_unlockall_read(PyTdbObject * self,PyObject * Py_UNUSED (ignored))220 static PyObject *obj_unlockall_read(PyTdbObject *self,
221 PyObject *Py_UNUSED(ignored))
222 {
223 int ret = tdb_unlockall_read(self->ctx);
224 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
225 Py_RETURN_NONE;
226 }
227
obj_close(PyTdbObject * self,PyObject * Py_UNUSED (ignored))228 static PyObject *obj_close(PyTdbObject *self, PyObject *Py_UNUSED(ignored))
229 {
230 int ret;
231 if (self->closed)
232 Py_RETURN_NONE;
233 ret = tdb_close(self->ctx);
234 self->closed = true;
235 if (ret != 0) {
236 PyErr_SetObject(PyExc_RuntimeError,
237 Py_BuildValue("(i,s)",
238 TDB_ERR_IO,
239 "Failed to close database"));
240 return NULL;
241 }
242 Py_RETURN_NONE;
243 }
244
obj_get(PyTdbObject * self,PyObject * args)245 static PyObject *obj_get(PyTdbObject *self, PyObject *args)
246 {
247 TDB_DATA key;
248 PyObject *py_key;
249
250 PyErr_TDB_RAISE_IF_CLOSED(self);
251
252 if (!PyArg_ParseTuple(args, "O", &py_key))
253 return NULL;
254
255 key = PyBytes_AsTDB_DATA(py_key);
256 if (!key.dptr)
257 return NULL;
258
259 return PyBytes_FromTDB_DATA(tdb_fetch(self->ctx, key));
260 }
261
obj_append(PyTdbObject * self,PyObject * args)262 static PyObject *obj_append(PyTdbObject *self, PyObject *args)
263 {
264 TDB_DATA key, data;
265 PyObject *py_key, *py_data;
266 int ret;
267
268 PyErr_TDB_RAISE_IF_CLOSED(self);
269
270 if (!PyArg_ParseTuple(args, "OO", &py_key, &py_data))
271 return NULL;
272
273 key = PyBytes_AsTDB_DATA(py_key);
274 if (!key.dptr)
275 return NULL;
276 data = PyBytes_AsTDB_DATA(py_data);
277 if (!data.dptr)
278 return NULL;
279
280 ret = tdb_append(self->ctx, key, data);
281 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
282 Py_RETURN_NONE;
283 }
284
obj_firstkey(PyTdbObject * self,PyObject * Py_UNUSED (ignored))285 static PyObject *obj_firstkey(PyTdbObject *self, PyObject *Py_UNUSED(ignored))
286 {
287 PyErr_TDB_RAISE_IF_CLOSED(self);
288
289 return PyBytes_FromTDB_DATA(tdb_firstkey(self->ctx));
290 }
291
obj_nextkey(PyTdbObject * self,PyObject * args)292 static PyObject *obj_nextkey(PyTdbObject *self, PyObject *args)
293 {
294 TDB_DATA key;
295 PyObject *py_key;
296 PyErr_TDB_RAISE_IF_CLOSED(self);
297
298 if (!PyArg_ParseTuple(args, "O", &py_key))
299 return NULL;
300
301 key = PyBytes_AsTDB_DATA(py_key);
302 if (!key.dptr)
303 return NULL;
304
305 return PyBytes_FromTDB_DATA(tdb_nextkey(self->ctx, key));
306 }
307
obj_delete(PyTdbObject * self,PyObject * args)308 static PyObject *obj_delete(PyTdbObject *self, PyObject *args)
309 {
310 TDB_DATA key;
311 PyObject *py_key;
312 int ret;
313 PyErr_TDB_RAISE_IF_CLOSED(self);
314
315 if (!PyArg_ParseTuple(args, "O", &py_key))
316 return NULL;
317
318 key = PyBytes_AsTDB_DATA(py_key);
319 if (!key.dptr)
320 return NULL;
321 ret = tdb_delete(self->ctx, key);
322 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
323 Py_RETURN_NONE;
324 }
325
obj_contains(PyTdbObject * self,PyObject * py_key)326 static int obj_contains(PyTdbObject *self, PyObject *py_key)
327 {
328 TDB_DATA key;
329 int ret;
330 PyErr_TDB_RAISE_RETURN_MINUS_1_IF_CLOSED(self);
331
332 key = PyBytes_AsTDB_DATA(py_key);
333 if (!key.dptr) {
334 PyErr_BadArgument();
335 return -1;
336 }
337 ret = tdb_exists(self->ctx, key);
338 if (ret)
339 return 1;
340 return 0;
341 }
342
343 #if PY_MAJOR_VERSION < 3
obj_has_key(PyTdbObject * self,PyObject * args)344 static PyObject *obj_has_key(PyTdbObject *self, PyObject *args)
345 {
346 int ret;
347 PyObject *py_key;
348 PyErr_TDB_RAISE_IF_CLOSED(self);
349
350 if (!PyArg_ParseTuple(args, "O", &py_key))
351 return NULL;
352
353 ret = obj_contains(self, py_key);
354 if (ret == -1)
355 return NULL;
356 if (ret)
357 Py_RETURN_TRUE;
358 Py_RETURN_FALSE;
359
360 }
361 #endif
362
obj_store(PyTdbObject * self,PyObject * args)363 static PyObject *obj_store(PyTdbObject *self, PyObject *args)
364 {
365 TDB_DATA key, value;
366 int ret;
367 int flag = TDB_REPLACE;
368 PyObject *py_key, *py_value;
369
370 PyErr_TDB_RAISE_IF_CLOSED(self);
371
372 if (!PyArg_ParseTuple(args, "OO|i", &py_key, &py_value, &flag))
373 return NULL;
374
375 key = PyBytes_AsTDB_DATA(py_key);
376 if (!key.dptr)
377 return NULL;
378 value = PyBytes_AsTDB_DATA(py_value);
379 if (!value.dptr)
380 return NULL;
381
382 ret = tdb_store(self->ctx, key, value, flag);
383 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
384 Py_RETURN_NONE;
385 }
386
obj_add_flags(PyTdbObject * self,PyObject * args)387 static PyObject *obj_add_flags(PyTdbObject *self, PyObject *args)
388 {
389 unsigned flags;
390
391 PyErr_TDB_RAISE_IF_CLOSED(self);
392
393 if (!PyArg_ParseTuple(args, "I", &flags))
394 return NULL;
395
396 tdb_add_flags(self->ctx, flags);
397 Py_RETURN_NONE;
398 }
399
obj_remove_flags(PyTdbObject * self,PyObject * args)400 static PyObject *obj_remove_flags(PyTdbObject *self, PyObject *args)
401 {
402 unsigned flags;
403
404 PyErr_TDB_RAISE_IF_CLOSED(self);
405
406 if (!PyArg_ParseTuple(args, "I", &flags))
407 return NULL;
408
409 tdb_remove_flags(self->ctx, flags);
410 Py_RETURN_NONE;
411 }
412
413 typedef struct {
414 PyObject_HEAD
415 TDB_DATA current;
416 PyTdbObject *iteratee;
417 } PyTdbIteratorObject;
418
tdb_iter_next(PyTdbIteratorObject * self)419 static PyObject *tdb_iter_next(PyTdbIteratorObject *self)
420 {
421 TDB_DATA current;
422 PyObject *ret;
423 if (self->current.dptr == NULL && self->current.dsize == 0)
424 return NULL;
425 current = self->current;
426 self->current = tdb_nextkey(self->iteratee->ctx, self->current);
427 ret = PyBytes_FromTDB_DATA(current);
428 return ret;
429 }
430
tdb_iter_dealloc(PyTdbIteratorObject * self)431 static void tdb_iter_dealloc(PyTdbIteratorObject *self)
432 {
433 Py_DECREF(self->iteratee);
434 PyObject_Del(self);
435 }
436
437 PyTypeObject PyTdbIterator = {
438 .tp_name = "Iterator",
439 .tp_basicsize = sizeof(PyTdbIteratorObject),
440 .tp_iternext = (iternextfunc)tdb_iter_next,
441 .tp_dealloc = (destructor)tdb_iter_dealloc,
442 .tp_flags = Py_TPFLAGS_DEFAULT,
443 .tp_iter = PyObject_SelfIter,
444 };
445
tdb_object_iter(PyTdbObject * self,PyObject * Py_UNUSED (ignored))446 static PyObject *tdb_object_iter(PyTdbObject *self,
447 PyObject *Py_UNUSED(ignored))
448 {
449 PyTdbIteratorObject *ret;
450
451 PyErr_TDB_RAISE_IF_CLOSED(self);
452
453 ret = PyObject_New(PyTdbIteratorObject, &PyTdbIterator);
454 if (!ret)
455 return NULL;
456 ret->current = tdb_firstkey(self->ctx);
457 ret->iteratee = self;
458 Py_INCREF(self);
459 return (PyObject *)ret;
460 }
461
obj_clear(PyTdbObject * self,PyObject * Py_UNUSED (ignored))462 static PyObject *obj_clear(PyTdbObject *self, PyObject *Py_UNUSED(ignored))
463 {
464 int ret;
465 PyErr_TDB_RAISE_IF_CLOSED(self);
466 ret = tdb_wipe_all(self->ctx);
467 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
468 Py_RETURN_NONE;
469 }
470
obj_repack(PyTdbObject * self,PyObject * Py_UNUSED (ignored))471 static PyObject *obj_repack(PyTdbObject *self, PyObject *Py_UNUSED(ignored))
472 {
473 int ret;
474 PyErr_TDB_RAISE_IF_CLOSED(self);
475 ret = tdb_repack(self->ctx);
476 PyErr_TDB_ERROR_IS_ERR_RAISE(ret, self->ctx);
477 Py_RETURN_NONE;
478 }
479
obj_enable_seqnum(PyTdbObject * self,PyObject * Py_UNUSED (ignored))480 static PyObject *obj_enable_seqnum(PyTdbObject *self,
481 PyObject *Py_UNUSED(ignored))
482 {
483 PyErr_TDB_RAISE_IF_CLOSED(self);
484 tdb_enable_seqnum(self->ctx);
485 Py_RETURN_NONE;
486 }
487
obj_increment_seqnum_nonblock(PyTdbObject * self,PyObject * Py_UNUSED (ignored))488 static PyObject *obj_increment_seqnum_nonblock(PyTdbObject *self,
489 PyObject *Py_UNUSED(ignored))
490 {
491 PyErr_TDB_RAISE_IF_CLOSED(self);
492 tdb_increment_seqnum_nonblock(self->ctx);
493 Py_RETURN_NONE;
494 }
495
496 static PyMethodDef tdb_object_methods[] = {
497 { "transaction_cancel", (PyCFunction)obj_transaction_cancel, METH_NOARGS,
498 "S.transaction_cancel() -> None\n"
499 "Cancel the currently active transaction." },
500 { "transaction_commit", (PyCFunction)obj_transaction_commit, METH_NOARGS,
501 "S.transaction_commit() -> None\n"
502 "Commit the currently active transaction." },
503 { "transaction_prepare_commit", (PyCFunction)obj_transaction_prepare_commit, METH_NOARGS,
504 "S.transaction_prepare_commit() -> None\n"
505 "Prepare to commit the currently active transaction" },
506 { "transaction_start", (PyCFunction)obj_transaction_start, METH_NOARGS,
507 "S.transaction_start() -> None\n"
508 "Start a new transaction." },
509 { "reopen", (PyCFunction)obj_reopen, METH_NOARGS, "Reopen this file." },
510 { "lock_all", (PyCFunction)obj_lockall, METH_NOARGS, NULL },
511 { "unlock_all", (PyCFunction)obj_unlockall, METH_NOARGS, NULL },
512 { "read_lock_all", (PyCFunction)obj_lockall_read, METH_NOARGS, NULL },
513 { "read_unlock_all", (PyCFunction)obj_unlockall_read, METH_NOARGS, NULL },
514 { "close", (PyCFunction)obj_close, METH_NOARGS, NULL },
515 { "get", (PyCFunction)obj_get, METH_VARARGS, "S.get(key) -> value\n"
516 "Fetch a value." },
517 { "append", (PyCFunction)obj_append, METH_VARARGS, "S.append(key, value) -> None\n"
518 "Append data to an existing key." },
519 { "firstkey", (PyCFunction)obj_firstkey, METH_NOARGS, "S.firstkey() -> data\n"
520 "Return the first key in this database." },
521 { "nextkey", (PyCFunction)obj_nextkey, METH_VARARGS, "S.nextkey(key) -> data\n"
522 "Return the next key in this database." },
523 { "delete", (PyCFunction)obj_delete, METH_VARARGS, "S.delete(key) -> None\n"
524 "Delete an entry." },
525 #if PY_MAJOR_VERSION < 3
526 { "has_key", (PyCFunction)obj_has_key, METH_VARARGS, "S.has_key(key) -> None\n"
527 "Check whether key exists in this database." },
528 #endif
529 { "store", (PyCFunction)obj_store, METH_VARARGS, "S.store(key, data, flag=REPLACE) -> None"
530 "Store data." },
531 { "add_flags", (PyCFunction)obj_add_flags, METH_VARARGS, "S.add_flags(flags) -> None" },
532 { "remove_flags", (PyCFunction)obj_remove_flags, METH_VARARGS, "S.remove_flags(flags) -> None" },
533 #if PY_MAJOR_VERSION >= 3
534 { "keys", (PyCFunction)tdb_object_iter, METH_NOARGS, "S.iterkeys() -> iterator" },
535 #else
536 { "iterkeys", (PyCFunction)tdb_object_iter, METH_NOARGS, "S.iterkeys() -> iterator" },
537 #endif
538 { "clear", (PyCFunction)obj_clear, METH_NOARGS, "S.clear() -> None\n"
539 "Wipe the entire database." },
540 { "repack", (PyCFunction)obj_repack, METH_NOARGS, "S.repack() -> None\n"
541 "Repack the entire database." },
542 { "enable_seqnum", (PyCFunction)obj_enable_seqnum, METH_NOARGS,
543 "S.enable_seqnum() -> None" },
544 { "increment_seqnum_nonblock", (PyCFunction)obj_increment_seqnum_nonblock, METH_NOARGS,
545 "S.increment_seqnum_nonblock() -> None" },
546 { NULL }
547 };
548
obj_get_hash_size(PyTdbObject * self,void * closure)549 static PyObject *obj_get_hash_size(PyTdbObject *self, void *closure)
550 {
551 PyErr_TDB_RAISE_IF_CLOSED(self);
552 return PyInt_FromLong(tdb_hash_size(self->ctx));
553 }
554
obj_set_max_dead(PyTdbObject * self,PyObject * max_dead,void * closure)555 static int obj_set_max_dead(PyTdbObject *self, PyObject *max_dead, void *closure)
556 {
557 PyErr_TDB_RAISE_RETURN_MINUS_1_IF_CLOSED(self);
558 if (!PyInt_Check(max_dead))
559 return -1;
560 tdb_set_max_dead(self->ctx, PyInt_AsLong(max_dead));
561 return 0;
562 }
563
obj_get_map_size(PyTdbObject * self,void * closure)564 static PyObject *obj_get_map_size(PyTdbObject *self, void *closure)
565 {
566 PyErr_TDB_RAISE_IF_CLOSED(self);
567 return PyInt_FromLong(tdb_map_size(self->ctx));
568 }
569
obj_get_freelist_size(PyTdbObject * self,void * closure)570 static PyObject *obj_get_freelist_size(PyTdbObject *self, void *closure)
571 {
572 PyErr_TDB_RAISE_IF_CLOSED(self);
573 return PyInt_FromLong(tdb_freelist_size(self->ctx));
574 }
575
obj_get_flags(PyTdbObject * self,void * closure)576 static PyObject *obj_get_flags(PyTdbObject *self, void *closure)
577 {
578 PyErr_TDB_RAISE_IF_CLOSED(self);
579 return PyInt_FromLong(tdb_get_flags(self->ctx));
580 }
581
obj_get_filename(PyTdbObject * self,void * closure)582 static PyObject *obj_get_filename(PyTdbObject *self, void *closure)
583 {
584 PyErr_TDB_RAISE_IF_CLOSED(self);
585 return PyBytes_FromString(tdb_name(self->ctx));
586 }
587
obj_get_seqnum(PyTdbObject * self,void * closure)588 static PyObject *obj_get_seqnum(PyTdbObject *self, void *closure)
589 {
590 PyErr_TDB_RAISE_IF_CLOSED(self);
591 return PyInt_FromLong(tdb_get_seqnum(self->ctx));
592 }
593
obj_get_text(PyTdbObject * self,void * closure)594 static PyObject *obj_get_text(PyTdbObject *self, void *closure)
595 {
596 PyObject *mod, *cls, *inst;
597 mod = PyImport_ImportModule("_tdb_text");
598 if (mod == NULL)
599 return NULL;
600 cls = PyObject_GetAttrString(mod, "TdbTextWrapper");
601 if (cls == NULL) {
602 Py_DECREF(mod);
603 return NULL;
604 }
605 inst = PyObject_CallFunction(cls, discard_const_p(char, "O"), self);
606 Py_DECREF(mod);
607 Py_DECREF(cls);
608 return inst;
609 }
610
611 static PyGetSetDef tdb_object_getsetters[] = {
612 {
613 .name = discard_const_p(char, "hash_size"),
614 .get = (getter)obj_get_hash_size,
615 },
616 {
617 .name = discard_const_p(char, "map_size"),
618 .get = (getter)obj_get_map_size,
619 },
620 {
621 .name = discard_const_p(char, "freelist_size"),
622 .get = (getter)obj_get_freelist_size,
623 },
624 {
625 .name = discard_const_p(char, "flags"),
626 .get = (getter)obj_get_flags,
627 },
628 {
629 .name = discard_const_p(char, "max_dead"),
630 .set = (setter)obj_set_max_dead,
631 },
632 {
633 .name = discard_const_p(char, "filename"),
634 .get = (getter)obj_get_filename,
635 .doc = discard_const_p(char, "The filename of this TDB file."),
636 },
637 {
638 .name = discard_const_p(char, "seqnum"),
639 .get = (getter)obj_get_seqnum,
640 },
641 {
642 .name = discard_const_p(char, "text"),
643 .get = (getter)obj_get_text,
644 },
645 { .name = NULL }
646 };
647
tdb_object_repr(PyTdbObject * self)648 static PyObject *tdb_object_repr(PyTdbObject *self)
649 {
650 PyErr_TDB_RAISE_IF_CLOSED(self);
651 if (tdb_get_flags(self->ctx) & TDB_INTERNAL) {
652 return PyUnicode_FromString("Tdb(<internal>)");
653 } else {
654 return PyUnicode_FromFormat("Tdb('%s')", tdb_name(self->ctx));
655 }
656 }
657
tdb_object_dealloc(PyTdbObject * self)658 static void tdb_object_dealloc(PyTdbObject *self)
659 {
660 if (!self->closed)
661 tdb_close(self->ctx);
662 Py_TYPE(self)->tp_free(self);
663 }
664
obj_getitem(PyTdbObject * self,PyObject * key)665 static PyObject *obj_getitem(PyTdbObject *self, PyObject *key)
666 {
667 TDB_DATA tkey, val;
668 PyErr_TDB_RAISE_IF_CLOSED(self);
669 if (!PyBytes_Check(key)) {
670 PyErr_SetString(PyExc_TypeError, "Expected bytestring as key");
671 return NULL;
672 }
673
674 tkey.dptr = (unsigned char *)PyBytes_AsString(key);
675 tkey.dsize = PyBytes_Size(key);
676
677 val = tdb_fetch(self->ctx, tkey);
678 if (val.dptr == NULL) {
679 /*
680 * if the key doesn't exist raise KeyError(key) to be
681 * consistent with python dict
682 */
683 PyErr_SetObject(PyExc_KeyError, key);
684 return NULL;
685 } else {
686 return PyBytes_FromTDB_DATA(val);
687 }
688 }
689
obj_setitem(PyTdbObject * self,PyObject * key,PyObject * value)690 static int obj_setitem(PyTdbObject *self, PyObject *key, PyObject *value)
691 {
692 TDB_DATA tkey, tval;
693 int ret;
694 PyErr_TDB_RAISE_RETURN_MINUS_1_IF_CLOSED(self);
695 if (!PyBytes_Check(key)) {
696 PyErr_SetString(PyExc_TypeError, "Expected bytestring as key");
697 return -1;
698 }
699
700 tkey = PyBytes_AsTDB_DATA(key);
701
702 if (value == NULL) {
703 ret = tdb_delete(self->ctx, tkey);
704 } else {
705 if (!PyBytes_Check(value)) {
706 PyErr_SetString(PyExc_TypeError, "Expected string as value");
707 return -1;
708 }
709
710 tval = PyBytes_AsTDB_DATA(value);
711
712 ret = tdb_store(self->ctx, tkey, tval, TDB_REPLACE);
713 }
714
715 if (ret != 0) {
716 PyErr_SetTDBError(self->ctx);
717 return -1;
718 }
719
720 return ret;
721 }
722
723 static PyMappingMethods tdb_object_mapping = {
724 .mp_subscript = (binaryfunc)obj_getitem,
725 .mp_ass_subscript = (objobjargproc)obj_setitem,
726 };
727 static PySequenceMethods tdb_object_seq = {
728 .sq_contains = (objobjproc)obj_contains,
729 };
730 static PyTypeObject PyTdb = {
731 .tp_name = "tdb.Tdb",
732 .tp_basicsize = sizeof(PyTdbObject),
733 .tp_methods = tdb_object_methods,
734 .tp_getset = tdb_object_getsetters,
735 .tp_new = py_tdb_open,
736 .tp_doc = "A TDB file",
737 .tp_repr = (reprfunc)tdb_object_repr,
738 .tp_dealloc = (destructor)tdb_object_dealloc,
739 .tp_as_mapping = &tdb_object_mapping,
740 .tp_as_sequence = &tdb_object_seq,
741 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE|Py_TPFLAGS_HAVE_ITER,
742 .tp_iter = PY_DISCARD_FUNC_SIG(getiterfunc,tdb_object_iter),
743 };
744
745 static PyMethodDef tdb_methods[] = {
746 {
747 .ml_name = "open",
748 .ml_meth = PY_DISCARD_FUNC_SIG(PyCFunction, py_tdb_open),
749 .ml_flags = METH_VARARGS|METH_KEYWORDS,
750 .ml_doc = "open(name, hash_size=0, tdb_flags=TDB_DEFAULT, "
751 "flags=O_RDWR, mode=0600)\nOpen a TDB file."
752 },
753 { .ml_name = NULL }
754 };
755
756 #define MODULE_DOC "simple key-value database that supports multiple writers."
757
758 #if PY_MAJOR_VERSION >= 3
759 static struct PyModuleDef moduledef = {
760 PyModuleDef_HEAD_INIT,
761 .m_name = "tdb",
762 .m_doc = MODULE_DOC,
763 .m_size = -1,
764 .m_methods = tdb_methods,
765 };
766 #endif
767
768 PyObject* module_init(void);
module_init(void)769 PyObject* module_init(void)
770 {
771 PyObject *m;
772
773 if (PyType_Ready(&PyTdb) < 0)
774 return NULL;
775
776 if (PyType_Ready(&PyTdbIterator) < 0)
777 return NULL;
778
779 #if PY_MAJOR_VERSION >= 3
780 m = PyModule_Create(&moduledef);
781 #else
782 m = Py_InitModule3("tdb", tdb_methods, MODULE_DOC);
783 #endif
784 if (m == NULL)
785 return NULL;
786
787 PyModule_AddIntConstant(m, "REPLACE", TDB_REPLACE);
788 PyModule_AddIntConstant(m, "INSERT", TDB_INSERT);
789 PyModule_AddIntConstant(m, "MODIFY", TDB_MODIFY);
790
791 PyModule_AddIntConstant(m, "DEFAULT", TDB_DEFAULT);
792 PyModule_AddIntConstant(m, "CLEAR_IF_FIRST", TDB_CLEAR_IF_FIRST);
793 PyModule_AddIntConstant(m, "INTERNAL", TDB_INTERNAL);
794 PyModule_AddIntConstant(m, "NOLOCK", TDB_NOLOCK);
795 PyModule_AddIntConstant(m, "NOMMAP", TDB_NOMMAP);
796 PyModule_AddIntConstant(m, "CONVERT", TDB_CONVERT);
797 PyModule_AddIntConstant(m, "BIGENDIAN", TDB_BIGENDIAN);
798 PyModule_AddIntConstant(m, "NOSYNC", TDB_NOSYNC);
799 PyModule_AddIntConstant(m, "SEQNUM", TDB_SEQNUM);
800 PyModule_AddIntConstant(m, "VOLATILE", TDB_VOLATILE);
801 PyModule_AddIntConstant(m, "ALLOW_NESTING", TDB_ALLOW_NESTING);
802 PyModule_AddIntConstant(m, "DISALLOW_NESTING", TDB_DISALLOW_NESTING);
803 PyModule_AddIntConstant(m, "INCOMPATIBLE_HASH", TDB_INCOMPATIBLE_HASH);
804
805 PyModule_AddStringConstant(m, "__docformat__", "restructuredText");
806
807 PyModule_AddStringConstant(m, "__version__", PACKAGE_VERSION);
808
809 Py_INCREF(&PyTdb);
810 PyModule_AddObject(m, "Tdb", (PyObject *)&PyTdb);
811
812 Py_INCREF(&PyTdbIterator);
813
814 return m;
815 }
816
817
818 #if PY_MAJOR_VERSION >= 3
819 PyMODINIT_FUNC PyInit_tdb(void);
PyInit_tdb(void)820 PyMODINIT_FUNC PyInit_tdb(void)
821 {
822 return module_init();
823 }
824 #else
825 void inittdb(void);
inittdb(void)826 void inittdb(void)
827 {
828 module_init();
829 }
830 #endif
831