diff options
Diffstat (limited to 'source4/lib/tdb/swig')
| -rw-r--r-- | source4/lib/tdb/swig/Tdb.py | 115 | ||||
| -rw-r--r-- | source4/lib/tdb/swig/tdb.i | 190 |
2 files changed, 305 insertions, 0 deletions
diff --git a/source4/lib/tdb/swig/Tdb.py b/source4/lib/tdb/swig/Tdb.py new file mode 100644 index 0000000000..ef0165ed8b --- /dev/null +++ b/source4/lib/tdb/swig/Tdb.py @@ -0,0 +1,115 @@ +"""Provide a more Pythonic and object-oriented interface to tdb.""" + +# +# Swig interface to Samba +# +# Copyright (C) Tim Potter 2006 +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# + +import tdb, os + +# Open flags + +DEFAULT = tdb.TDB_DEFAULT +CLEAR_IF_FIRST = tdb.TDB_CLEAR_IF_FIRST +INTERNAL = tdb.TDB_INTERNAL +NOLOCK = tdb.TDB_NOLOCK +NOMMAP = tdb.TDB_NOMMAP + +# Class representing a TDB file + +class Tdb: + + # Create and destroy Tdb objects + + def __init__(self, name, hash_size = 0, flags = tdb.TDB_DEFAULT, + open_flags = os.O_RDWR | os.O_CREAT, mode = 0600): + self.tdb = tdb.open(name, hash_size, flags, open_flags, mode) + if self.tdb is None: + raise IOError, tdb.errorstr(self.tdb) + + def __del__(self): + self.close() + + def close(self): + if hasattr(self, 'tdb') and self.tdb is not None: + if tdb.close(self.tdb) == -1: + raise IOError, tdb.errorstr(self.tdb) + self.tdb = None + + # Random access to keys, values + + def __getitem__(self, key): + result = tdb.fetch(self.tdb, key) + if result is None: + raise KeyError, '%s: %s' % (key, tdb.errorstr(self.tdb)) + return result + + def __setitem__(self, key, item): + if tdb.store(self.tdb, key, item) == -1: + raise IOError, tdb.errorstr(self.tdb) + + def __delitem__(self, key): + if not tdb.exists(self.tdb, key): + raise KeyError, '%s: %s' % (key, tdb.errorstr(self.tdb)) + tdb.delete(self.tdb, key) + + def has_key(self, key): + return tdb.exists(self.tdb, key) + + # Tdb iterator + + class TdbIterator: + def __init__(self, tdb): + self.tdb = tdb + self.key = None + + def __iter__(self): + return self + + def next(self): + if self.key is None: + self.key = tdb.firstkey(self.tdb) + if self.key is None: + raise StopIteration + return self.key + else: + self.key = tdb.nextkey(self.tdb, self.key) + if self.key is None: + raise StopIteration + return self.key + + def __iter__(self): + return Tdb.TdbIterator(self.tdb) + + # Implement other dict functions using TdbIterator + + def keys(self): + return [k for k in iter(self)] + + def values(self): + return [self[k] for k in iter(self)] + + def items(self): + return [(k, self[k]) for k in iter(self)] + + def __len__(self): + return len(self.keys()) + + def clear(self): + for k in iter(self): + del(self[k]) diff --git a/source4/lib/tdb/swig/tdb.i b/source4/lib/tdb/swig/tdb.i new file mode 100644 index 0000000000..8f473c61e6 --- /dev/null +++ b/source4/lib/tdb/swig/tdb.i @@ -0,0 +1,190 @@ +/* + Unix SMB/CIFS implementation. + + Swig interface to tdb. + + Copyright (C) 2004,2005 Tim Potter <tpot@samba.org> + + ** NOTE! The following LGPL license applies to the tdb + ** library. This does NOT imply that all of Samba is released + ** under the LGPL + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +*/ + +%module tdb + +%{ + +/* This symbol is used in both includes.h and Python.h which causes an + annoying compiler warning. */ + +#ifdef HAVE_FSTAT +#undef HAVE_FSTAT +#endif + +#if (__GNUC__ >= 3) +/** Use gcc attribute to check printf fns. a1 is the 1-based index of + * the parameter containing the format, and a2 the index of the first + * argument. Note that some gcc 2.x versions don't handle this + * properly **/ +#define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2))) +#else +#define PRINTF_ATTRIBUTE(a1, a2) +#endif + +/* Include tdb headers */ + +#include "lib/tdb/include/tdb.h" + +%} + +/* The tdb functions will crash if a NULL tdb context is passed */ + +%include exception.i + +%typemap(check) TDB_CONTEXT* { + if ($1 == NULL) + SWIG_exception(SWIG_ValueError, + "tdb context must be non-NULL"); +} + +/* In and out typemaps for the TDB_DATA structure. This is converted to + and from the Python string type which can contain arbitrary binary + data.. */ + +%typemap(in) TDB_DATA { + if (!PyString_Check($input)) { + PyErr_SetString(PyExc_TypeError, "string arg expected"); + return NULL; + } + $1.dsize = PyString_Size($input); + $1.dptr = PyString_AsString($input); +} + +%typemap(out) TDB_DATA { + if ($1.dptr == NULL && $1.dsize == 0) { + $result = Py_None; + } else { + $result = PyString_FromStringAndSize($1.dptr, $1.dsize); + free($1.dptr); + } +} + +/* Treat a mode_t as an unsigned integer */ + +typedef int mode_t; + +/* flags to tdb_store() */ + +#define TDB_REPLACE 1 +#define TDB_INSERT 2 +#define TDB_MODIFY 3 + +/* flags for tdb_open() */ + +#define TDB_DEFAULT 0 /* just a readability place holder */ +#define TDB_CLEAR_IF_FIRST 1 +#define TDB_INTERNAL 2 /* don't store on disk */ +#define TDB_NOLOCK 4 /* don't do any locking */ +#define TDB_NOMMAP 8 /* don't use mmap */ +#define TDB_CONVERT 16 /* convert endian (internal use) */ +#define TDB_BIGENDIAN 32 /* header is big-endian (internal use) */ + +/* Throw an IOError exception if tdb_open() or tdb_open_ex() returns NULL */ + +%exception { + $action + if (result == NULL) { + PyErr_SetFromErrno(PyExc_IOError); + SWIG_fail; + } +} + +%rename tdb_open open; +TDB_CONTEXT *tdb_open(const char *name, int hash_size, int tdb_flags, + int open_flags, mode_t mode); + +%rename tdb_open_ex open_ex; +TDB_CONTEXT *tdb_open_ex(const char *name, int hash_size, int tdb_flags, + int open_flags, mode_t mode, + tdb_log_func log_fn, + tdb_hash_func hash_fn); + +%exception; + +%rename tdb_reopen reopen; +int tdb_reopen(TDB_CONTEXT *tdb); + +%rename tdb_reopen_all reopen_all; +int tdb_reopen_all(void); + +%rename tdb_logging_function logging_function; +void tdb_logging_function(TDB_CONTEXT *tdb, tdb_log_func); + +%rename tdb_error error; +enum TDB_ERROR tdb_error(TDB_CONTEXT *tdb); + +%rename tdb_errorstr errorstr; +const char *tdb_errorstr(TDB_CONTEXT *tdb); + +%rename tdb_fetch fetch; +TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key); + +%rename tdb_delete delete; +int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key); + +%rename tdb_store store; +int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag = TDB_REPLACE); + +%rename tdb_append append; +int tdb_append(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA new_dbuf); + +%rename tdb_close close; +int tdb_close(TDB_CONTEXT *tdb); + +%rename tdb_firstkey firstkey; +TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb); + +%rename tdb_nextkey nextkey; +TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA key); + +%rename tdb_traverse traverse; +int tdb_traverse(TDB_CONTEXT *tdb, tdb_traverse_func fn, void *state); + +%rename tdb_exists exists; +int tdb_exists(TDB_CONTEXT *tdb, TDB_DATA key); + +%rename tdb_lockall lockall; +int tdb_lockall(TDB_CONTEXT *tdb); + +%rename tdb_unlockall unlockall; +void tdb_unlockall(TDB_CONTEXT *tdb); + +/* Low level locking functions: use with care */ + +%rename tdb_chainlock chainlock; +int tdb_chainlock(TDB_CONTEXT *tdb, TDB_DATA key); + +%rename tdb_chainunlock chainunlock; +int tdb_chainunlock(TDB_CONTEXT *tdb, TDB_DATA key); + +/* Debug functions. Not used in production. */ + +%rename tdb_dump_all dump_all; +void tdb_dump_all(TDB_CONTEXT *tdb); + +%rename tdb_printfreelist printfreelist; +int tdb_printfreelist(TDB_CONTEXT *tdb); |