2 Unix SMB/CIFS implementation.
4 Python interface to tdb.
6 Copyright (C) 2004-2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2007-2008 Jelmer Vernooij <jelmer@samba.org>
9 ** NOTE! The following LGPL license applies to the tdb
10 ** library. This does NOT imply that all of Samba is released
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.
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.
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/>.
29 #include "system/filesys.h"
31 #ifndef Py_RETURN_NONE
32 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
35 /* Include tdb headers */
44 staticforward PyTypeObject PyTdb
;
46 static void PyErr_SetTDBError(TDB_CONTEXT
*tdb
)
48 PyErr_SetObject(PyExc_RuntimeError
,
49 Py_BuildValue("(i,s)", tdb_error(tdb
), tdb_errorstr(tdb
)));
52 static TDB_DATA
PyString_AsTDB_DATA(PyObject
*data
)
55 ret
.dptr
= (unsigned char *)PyString_AsString(data
);
56 ret
.dsize
= PyString_Size(data
);
60 static PyObject
*PyString_FromTDB_DATA(TDB_DATA data
)
62 if (data
.dptr
== NULL
&& data
.dsize
== 0) {
65 PyObject
*ret
= PyString_FromStringAndSize((const char *)data
.dptr
,
72 #define PyErr_TDB_ERROR_IS_ERR_RAISE(ret, tdb) \
74 PyErr_SetTDBError(tdb); \
78 static PyObject
*py_tdb_open(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
)
81 int hash_size
= 0, tdb_flags
= TDB_DEFAULT
, flags
= O_RDWR
, mode
= 0600;
84 const char *kwnames
[] = { "name", "hash_size", "tdb_flags", "flags", "mode", NULL
};
86 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "|siiii", (char **)kwnames
, &name
, &hash_size
, &tdb_flags
, &flags
, &mode
))
90 tdb_flags
|= TDB_INTERNAL
;
93 ctx
= tdb_open(name
, hash_size
, tdb_flags
, flags
, mode
);
95 PyErr_SetFromErrno(PyExc_IOError
);
99 ret
= PyObject_New(PyTdbObject
, &PyTdb
);
107 return (PyObject
*)ret
;
110 static PyObject
*obj_transaction_cancel(PyTdbObject
*self
)
112 int ret
= tdb_transaction_cancel(self
->ctx
);
113 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
117 static PyObject
*obj_transaction_commit(PyTdbObject
*self
)
119 int ret
= tdb_transaction_commit(self
->ctx
);
120 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
124 static PyObject
*obj_transaction_prepare_commit(PyTdbObject
*self
)
126 int ret
= tdb_transaction_prepare_commit(self
->ctx
);
127 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
131 static PyObject
*obj_transaction_start(PyTdbObject
*self
)
133 int ret
= tdb_transaction_start(self
->ctx
);
134 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
138 static PyObject
*obj_reopen(PyTdbObject
*self
)
140 int ret
= tdb_reopen(self
->ctx
);
141 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
145 static PyObject
*obj_lockall(PyTdbObject
*self
)
147 int ret
= tdb_lockall(self
->ctx
);
148 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
152 static PyObject
*obj_unlockall(PyTdbObject
*self
)
154 int ret
= tdb_unlockall(self
->ctx
);
155 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
159 static PyObject
*obj_lockall_read(PyTdbObject
*self
)
161 int ret
= tdb_lockall_read(self
->ctx
);
162 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
166 static PyObject
*obj_unlockall_read(PyTdbObject
*self
)
168 int ret
= tdb_unlockall_read(self
->ctx
);
169 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
173 static PyObject
*obj_close(PyTdbObject
*self
)
178 ret
= tdb_close(self
->ctx
);
180 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
184 static PyObject
*obj_get(PyTdbObject
*self
, PyObject
*args
)
188 if (!PyArg_ParseTuple(args
, "O", &py_key
))
191 key
= PyString_AsTDB_DATA(py_key
);
193 return PyString_FromTDB_DATA(tdb_fetch(self
->ctx
, key
));
196 static PyObject
*obj_append(PyTdbObject
*self
, PyObject
*args
)
199 PyObject
*py_key
, *py_data
;
201 if (!PyArg_ParseTuple(args
, "OO", &py_key
, &py_data
))
204 key
= PyString_AsTDB_DATA(py_key
);
205 data
= PyString_AsTDB_DATA(py_data
);
207 ret
= tdb_append(self
->ctx
, key
, data
);
208 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
212 static PyObject
*obj_firstkey(PyTdbObject
*self
)
214 return PyString_FromTDB_DATA(tdb_firstkey(self
->ctx
));
217 static PyObject
*obj_nextkey(PyTdbObject
*self
, PyObject
*args
)
221 if (!PyArg_ParseTuple(args
, "O", &py_key
))
224 key
= PyString_AsTDB_DATA(py_key
);
226 return PyString_FromTDB_DATA(tdb_nextkey(self
->ctx
, key
));
229 static PyObject
*obj_delete(PyTdbObject
*self
, PyObject
*args
)
234 if (!PyArg_ParseTuple(args
, "O", &py_key
))
237 key
= PyString_AsTDB_DATA(py_key
);
238 ret
= tdb_delete(self
->ctx
, key
);
239 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
243 static PyObject
*obj_has_key(PyTdbObject
*self
, PyObject
*args
)
248 if (!PyArg_ParseTuple(args
, "O", &py_key
))
251 key
= PyString_AsTDB_DATA(py_key
);
252 ret
= tdb_exists(self
->ctx
, key
);
253 if (ret
!= TDB_ERR_NOEXIST
) {
254 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
257 return (ret
== TDB_ERR_NOEXIST
)?Py_False
:Py_True
;
260 static PyObject
*obj_store(PyTdbObject
*self
, PyObject
*args
)
264 int flag
= TDB_REPLACE
;
265 PyObject
*py_key
, *py_value
;
267 if (!PyArg_ParseTuple(args
, "OO|i", &py_key
, &py_value
, &flag
))
270 key
= PyString_AsTDB_DATA(py_key
);
271 value
= PyString_AsTDB_DATA(py_value
);
273 ret
= tdb_store(self
->ctx
, key
, value
, flag
);
274 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
278 static PyObject
*obj_add_flags(PyTdbObject
*self
, PyObject
*args
)
282 if (!PyArg_ParseTuple(args
, "I", &flags
))
285 tdb_add_flags(self
->ctx
, flags
);
289 static PyObject
*obj_remove_flags(PyTdbObject
*self
, PyObject
*args
)
293 if (!PyArg_ParseTuple(args
, "I", &flags
))
296 tdb_remove_flags(self
->ctx
, flags
);
303 PyTdbObject
*iteratee
;
304 } PyTdbIteratorObject
;
306 static PyObject
*tdb_iter_next(PyTdbIteratorObject
*self
)
310 if (self
->current
.dptr
== NULL
&& self
->current
.dsize
== 0)
312 current
= self
->current
;
313 self
->current
= tdb_nextkey(self
->iteratee
->ctx
, self
->current
);
314 ret
= PyString_FromTDB_DATA(current
);
318 static void tdb_iter_dealloc(PyTdbIteratorObject
*self
)
320 Py_DECREF(self
->iteratee
);
324 PyTypeObject PyTdbIterator
= {
325 .tp_name
= "Iterator",
326 .tp_basicsize
= sizeof(PyTdbIteratorObject
),
327 .tp_iternext
= (iternextfunc
)tdb_iter_next
,
328 .tp_dealloc
= (destructor
)tdb_iter_dealloc
,
329 .tp_flags
= Py_TPFLAGS_DEFAULT
,
330 .tp_iter
= PyObject_SelfIter
,
333 static PyObject
*tdb_object_iter(PyTdbObject
*self
)
335 PyTdbIteratorObject
*ret
;
337 ret
= PyObject_New(PyTdbIteratorObject
, &PyTdbIterator
);
340 ret
->current
= tdb_firstkey(self
->ctx
);
341 ret
->iteratee
= self
;
343 return (PyObject
*)ret
;
346 static PyObject
*obj_clear(PyTdbObject
*self
)
348 int ret
= tdb_wipe_all(self
->ctx
);
349 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
353 static PyObject
*obj_repack(PyTdbObject
*self
)
355 int ret
= tdb_repack(self
->ctx
);
356 PyErr_TDB_ERROR_IS_ERR_RAISE(ret
, self
->ctx
);
360 static PyObject
*obj_enable_seqnum(PyTdbObject
*self
)
362 tdb_enable_seqnum(self
->ctx
);
366 static PyObject
*obj_increment_seqnum_nonblock(PyTdbObject
*self
)
368 tdb_increment_seqnum_nonblock(self
->ctx
);
372 static PyMethodDef tdb_object_methods
[] = {
373 { "transaction_cancel", (PyCFunction
)obj_transaction_cancel
, METH_NOARGS
,
374 "S.transaction_cancel() -> None\n"
375 "Cancel the currently active transaction." },
376 { "transaction_commit", (PyCFunction
)obj_transaction_commit
, METH_NOARGS
,
377 "S.transaction_commit() -> None\n"
378 "Commit the currently active transaction." },
379 { "transaction_prepare_commit", (PyCFunction
)obj_transaction_prepare_commit
, METH_NOARGS
,
380 "S.transaction_prepare_commit() -> None\n"
381 "Prepare to commit the currently active transaction" },
382 { "transaction_start", (PyCFunction
)obj_transaction_start
, METH_NOARGS
,
383 "S.transaction_start() -> None\n"
384 "Start a new transaction." },
385 { "reopen", (PyCFunction
)obj_reopen
, METH_NOARGS
, "Reopen this file." },
386 { "lock_all", (PyCFunction
)obj_lockall
, METH_NOARGS
, NULL
},
387 { "unlock_all", (PyCFunction
)obj_unlockall
, METH_NOARGS
, NULL
},
388 { "read_lock_all", (PyCFunction
)obj_lockall_read
, METH_NOARGS
, NULL
},
389 { "read_unlock_all", (PyCFunction
)obj_unlockall_read
, METH_NOARGS
, NULL
},
390 { "close", (PyCFunction
)obj_close
, METH_NOARGS
, NULL
},
391 { "get", (PyCFunction
)obj_get
, METH_VARARGS
, "S.get(key) -> value\n"
393 { "append", (PyCFunction
)obj_append
, METH_VARARGS
, "S.append(key, value) -> None\n"
394 "Append data to an existing key." },
395 { "firstkey", (PyCFunction
)obj_firstkey
, METH_NOARGS
, "S.firstkey() -> data\n"
396 "Return the first key in this database." },
397 { "nextkey", (PyCFunction
)obj_nextkey
, METH_NOARGS
, "S.nextkey(key) -> data\n"
398 "Return the next key in this database." },
399 { "delete", (PyCFunction
)obj_delete
, METH_VARARGS
, "S.delete(key) -> None\n"
400 "Delete an entry." },
401 { "has_key", (PyCFunction
)obj_has_key
, METH_VARARGS
, "S.has_key(key) -> None\n"
402 "Check whether key exists in this database." },
403 { "store", (PyCFunction
)obj_store
, METH_VARARGS
, "S.store(key, data, flag=REPLACE) -> None"
405 { "add_flags", (PyCFunction
)obj_add_flags
, METH_VARARGS
, "S.add_flags(flags) -> None" },
406 { "remove_flags", (PyCFunction
)obj_remove_flags
, METH_VARARGS
, "S.remove_flags(flags) -> None" },
407 { "iterkeys", (PyCFunction
)tdb_object_iter
, METH_NOARGS
, "S.iterkeys() -> iterator" },
408 { "clear", (PyCFunction
)obj_clear
, METH_NOARGS
, "S.clear() -> None\n"
409 "Wipe the entire database." },
410 { "repack", (PyCFunction
)obj_repack
, METH_NOARGS
, "S.repack() -> None\n"
411 "Repack the entire database." },
412 { "enable_seqnum", (PyCFunction
)obj_enable_seqnum
, METH_NOARGS
,
413 "S.enable_seqnum() -> None" },
414 { "increment_seqnum_nonblock", (PyCFunction
)obj_increment_seqnum_nonblock
, METH_NOARGS
,
415 "S.increment_seqnum_nonblock() -> None" },
419 static PyObject
*obj_get_hash_size(PyTdbObject
*self
, void *closure
)
421 return PyInt_FromLong(tdb_hash_size(self
->ctx
));
424 static int obj_set_max_dead(PyTdbObject
*self
, PyObject
*max_dead
, void *closure
)
426 if (!PyInt_Check(max_dead
))
428 tdb_set_max_dead(self
->ctx
, PyInt_AsLong(max_dead
));
432 static PyObject
*obj_get_map_size(PyTdbObject
*self
, void *closure
)
434 return PyInt_FromLong(tdb_map_size(self
->ctx
));
437 static PyObject
*obj_get_freelist_size(PyTdbObject
*self
, void *closure
)
439 return PyInt_FromLong(tdb_freelist_size(self
->ctx
));
442 static PyObject
*obj_get_flags(PyTdbObject
*self
, void *closure
)
444 return PyInt_FromLong(tdb_get_flags(self
->ctx
));
447 static PyObject
*obj_get_filename(PyTdbObject
*self
, void *closure
)
449 return PyString_FromString(tdb_name(self
->ctx
));
452 static PyObject
*obj_get_seqnum(PyTdbObject
*self
, void *closure
)
454 return PyInt_FromLong(tdb_get_seqnum(self
->ctx
));
458 static PyGetSetDef tdb_object_getsetters
[] = {
459 { (char *)"hash_size", (getter
)obj_get_hash_size
, NULL
, NULL
},
460 { (char *)"map_size", (getter
)obj_get_map_size
, NULL
, NULL
},
461 { (char *)"freelist_size", (getter
)obj_get_freelist_size
, NULL
, NULL
},
462 { (char *)"flags", (getter
)obj_get_flags
, NULL
, NULL
},
463 { (char *)"max_dead", NULL
, (setter
)obj_set_max_dead
, NULL
},
464 { (char *)"filename", (getter
)obj_get_filename
, NULL
, (char *)"The filename of this TDB file."},
465 { (char *)"seqnum", (getter
)obj_get_seqnum
, NULL
, NULL
},
469 static PyObject
*tdb_object_repr(PyTdbObject
*self
)
471 if (tdb_get_flags(self
->ctx
) & TDB_INTERNAL
) {
472 return PyString_FromString("Tdb(<internal>)");
474 return PyString_FromFormat("Tdb('%s')", tdb_name(self
->ctx
));
478 static void tdb_object_dealloc(PyTdbObject
*self
)
481 tdb_close(self
->ctx
);
482 self
->ob_type
->tp_free(self
);
485 static PyObject
*obj_getitem(PyTdbObject
*self
, PyObject
*key
)
488 if (!PyString_Check(key
)) {
489 PyErr_SetString(PyExc_TypeError
, "Expected string as key");
493 tkey
.dptr
= (unsigned char *)PyString_AsString(key
);
494 tkey
.dsize
= PyString_Size(key
);
496 val
= tdb_fetch(self
->ctx
, tkey
);
497 if (val
.dptr
== NULL
) {
498 PyErr_SetString(PyExc_KeyError
, "No such TDB entry");
501 return PyString_FromTDB_DATA(val
);
505 static int obj_setitem(PyTdbObject
*self
, PyObject
*key
, PyObject
*value
)
509 if (!PyString_Check(key
)) {
510 PyErr_SetString(PyExc_TypeError
, "Expected string as key");
514 tkey
= PyString_AsTDB_DATA(key
);
517 ret
= tdb_delete(self
->ctx
, tkey
);
519 if (!PyString_Check(value
)) {
520 PyErr_SetString(PyExc_TypeError
, "Expected string as value");
524 tval
= PyString_AsTDB_DATA(value
);
526 ret
= tdb_store(self
->ctx
, tkey
, tval
, TDB_REPLACE
);
530 PyErr_SetTDBError(self
->ctx
);
537 static PyMappingMethods tdb_object_mapping
= {
538 .mp_subscript
= (binaryfunc
)obj_getitem
,
539 .mp_ass_subscript
= (objobjargproc
)obj_setitem
,
541 static PyTypeObject PyTdb
= {
542 .tp_name
= "tdb.Tdb",
543 .tp_basicsize
= sizeof(PyTdbObject
),
544 .tp_methods
= tdb_object_methods
,
545 .tp_getset
= tdb_object_getsetters
,
546 .tp_new
= py_tdb_open
,
547 .tp_doc
= "A TDB file",
548 .tp_repr
= (reprfunc
)tdb_object_repr
,
549 .tp_dealloc
= (destructor
)tdb_object_dealloc
,
550 .tp_as_mapping
= &tdb_object_mapping
,
551 .tp_flags
= Py_TPFLAGS_DEFAULT
|Py_TPFLAGS_BASETYPE
|Py_TPFLAGS_HAVE_ITER
,
552 .tp_iter
= (getiterfunc
)tdb_object_iter
,
555 static PyMethodDef tdb_methods
[] = {
556 { "open", (PyCFunction
)py_tdb_open
, METH_VARARGS
|METH_KEYWORDS
, "open(name, hash_size=0, tdb_flags=TDB_DEFAULT, flags=O_RDWR, mode=0600)\n"
557 "Open a TDB file." },
566 if (PyType_Ready(&PyTdb
) < 0)
569 if (PyType_Ready(&PyTdbIterator
) < 0)
572 m
= Py_InitModule3("tdb", tdb_methods
,
573 "simple key-value database that supports multiple writers.");
577 PyModule_AddObject(m
, "REPLACE", PyInt_FromLong(TDB_REPLACE
));
578 PyModule_AddObject(m
, "INSERT", PyInt_FromLong(TDB_INSERT
));
579 PyModule_AddObject(m
, "MODIFY", PyInt_FromLong(TDB_MODIFY
));
581 PyModule_AddObject(m
, "DEFAULT", PyInt_FromLong(TDB_DEFAULT
));
582 PyModule_AddObject(m
, "CLEAR_IF_FIRST", PyInt_FromLong(TDB_CLEAR_IF_FIRST
));
583 PyModule_AddObject(m
, "INTERNAL", PyInt_FromLong(TDB_INTERNAL
));
584 PyModule_AddObject(m
, "NOLOCK", PyInt_FromLong(TDB_NOLOCK
));
585 PyModule_AddObject(m
, "NOMMAP", PyInt_FromLong(TDB_NOMMAP
));
586 PyModule_AddObject(m
, "CONVERT", PyInt_FromLong(TDB_CONVERT
));
587 PyModule_AddObject(m
, "BIGENDIAN", PyInt_FromLong(TDB_BIGENDIAN
));
588 PyModule_AddObject(m
, "NOSYNC", PyInt_FromLong(TDB_NOSYNC
));
589 PyModule_AddObject(m
, "SEQNUM", PyInt_FromLong(TDB_SEQNUM
));
590 PyModule_AddObject(m
, "VOLATILE", PyInt_FromLong(TDB_VOLATILE
));
591 PyModule_AddObject(m
, "ALLOW_NESTING", PyInt_FromLong(TDB_ALLOW_NESTING
));
592 PyModule_AddObject(m
, "DISALLOW_NESTING", PyInt_FromLong(TDB_DISALLOW_NESTING
));
593 PyModule_AddObject(m
, "INCOMPATIBLE_HASH", PyInt_FromLong(TDB_INCOMPATIBLE_HASH
));
595 PyModule_AddObject(m
, "__docformat__", PyString_FromString("restructuredText"));
597 PyModule_AddObject(m
, "__version__", PyString_FromString(PACKAGE_VERSION
));
600 PyModule_AddObject(m
, "Tdb", (PyObject
*)&PyTdb
);
602 Py_INCREF(&PyTdbIterator
);