/*----------------------------------------------------------------------

Copyright (c) 1999-2001, Digital Creations, Fredericksburg, VA, USA

and Andrew Kuchling. All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are

met:

o Redistributions of source code must retain the above copyright

notice, this list of conditions, and the disclaimer that follows.

o Redistributions in binary form must reproduce the above copyright

notice, this list of conditions, and the following disclaimer in

the documentation and/or other materials provided with the

distribution.

o Neither the name of Digital Creations nor the names of its

contributors may be used to endorse or promote products derived

from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS AND CONTRIBUTORS *AS

IS* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL

CREATIONS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS

OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR

TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE

USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH

DAMAGE.

------------------------------------------------------------------------*/

/*

* Handwritten code to wrap version 3.x of the Berkeley DB library,

* written to replace a SWIG-generated file. It has since been updated

* to compile with BerkeleyDB versions 3.2 through 4.2.

*

* This module was started by Andrew Kuchling to remove the dependency

* on SWIG in a package by Gregory P. Smith who based his work on a

* similar package by Robin Dunn <[email protected]> which wrapped

* Berkeley DB 2.7.x.

*

* Development of this module then returned full circle back to Robin Dunn

* who worked on behalf of Digital Creations to complete the wrapping of

* the DB 3.x API and to build a solid unit test suite. Robin has

* since gone onto other projects (wxPython).

*

* Gregory P. Smith <[email protected]> is once again the maintainer.

*

* Use the [email protected] mailing list for all questions.

* Things can change faster than the header of this file is updated. This

* file is shared with the PyBSDDB project at SourceForge:

*

* http://pybsddb.sf.net

*

* This file should remain backward compatible with Python 2.1, but see PEP

* 291 for the most current backward compatibility requirements:

*

* http://www.python.org/peps/pep-0291.html

*

* This module contains 6 types:

*

* DB (Database)

* DBCursor (Database Cursor)

* DBEnv (database environment)

* DBTxn (An explicit database transaction)

* DBLock (A lock handle)

* DBSequence (Sequence)

*

*/

/* --------------------------------------------------------------------- */

/*

* Portions of this module, associated unit tests and build scripts are the

* result of a contract with The Written Word (http://thewrittenword.com/)

* Many thanks go out to them for causing me to raise the bar on quality and

* functionality, resulting in a better bsddb3 package for all of us to use.

*

* --Robin

*/

/* --------------------------------------------------------------------- */

#include <stddef.h> /* for offsetof() */

#include <Python.h>

#define COMPILING_BSDDB_C

#include "bsddb.h"

#undef COMPILING_BSDDB_C

static char *svn_id = "$Id$";

/* --------------------------------------------------------------------- */

/* Various macro definitions */

#if (PY_VERSION_HEX < 0x02050000)

typedef int Py_ssize_t;

#endif

#ifdef WITH_THREAD

/* These are for when calling Python --> C */

#define MYDB_BEGIN_ALLOW_THREADS Py_BEGIN_ALLOW_THREADS;

#define MYDB_END_ALLOW_THREADS Py_END_ALLOW_THREADS;

/* For 2.3, use the PyGILState_ calls */

#if (PY_VERSION_HEX >= 0x02030000)

#define MYDB_USE_GILSTATE

#endif

/* and these are for calling C --> Python */

#if defined(MYDB_USE_GILSTATE)

#define MYDB_BEGIN_BLOCK_THREADS \

PyGILState_STATE __savestate = PyGILState_Ensure();

#define MYDB_END_BLOCK_THREADS \

PyGILState_Release(__savestate);

#else /* MYDB_USE_GILSTATE */

/* Pre GILState API - do it the long old way */

static PyInterpreterState* _db_interpreterState = NULL;

#define MYDB_BEGIN_BLOCK_THREADS { \

PyThreadState* prevState; \

PyThreadState* newState; \

PyEval_AcquireLock(); \

newState = PyThreadState_New(_db_interpreterState); \

prevState = PyThreadState_Swap(newState);

#define MYDB_END_BLOCK_THREADS \

newState = PyThreadState_Swap(prevState); \

PyThreadState_Clear(newState); \

PyEval_ReleaseLock(); \

PyThreadState_Delete(newState); \

}

#endif /* MYDB_USE_GILSTATE */

#else

/* Compiled without threads - avoid all this cruft */

#define MYDB_BEGIN_ALLOW_THREADS

#define MYDB_END_ALLOW_THREADS

#define MYDB_BEGIN_BLOCK_THREADS

#define MYDB_END_BLOCK_THREADS

#endif

/* Should DB_INCOMPLETE be turned into a warning or an exception? */

#define INCOMPLETE_IS_WARNING 1

/* --------------------------------------------------------------------- */

/* Exceptions */

static PyObject* DBError; /* Base class, all others derive from this */

static PyObject* DBCursorClosedError; /* raised when trying to use a closed cursor object */

static PyObject* DBKeyEmptyError; /* DB_KEYEMPTY: also derives from KeyError */

static PyObject* DBKeyExistError; /* DB_KEYEXIST */

static PyObject* DBLockDeadlockError; /* DB_LOCK_DEADLOCK */

static PyObject* DBLockNotGrantedError; /* DB_LOCK_NOTGRANTED */

static PyObject* DBNotFoundError; /* DB_NOTFOUND: also derives from KeyError */

static PyObject* DBOldVersionError; /* DB_OLD_VERSION */

static PyObject* DBRunRecoveryError; /* DB_RUNRECOVERY */

static PyObject* DBVerifyBadError; /* DB_VERIFY_BAD */

static PyObject* DBNoServerError; /* DB_NOSERVER */

static PyObject* DBNoServerHomeError; /* DB_NOSERVER_HOME */

static PyObject* DBNoServerIDError; /* DB_NOSERVER_ID */

#if (DBVER >= 33)

static PyObject* DBPageNotFoundError; /* DB_PAGE_NOTFOUND */

static PyObject* DBSecondaryBadError; /* DB_SECONDARY_BAD */

#endif

#if !INCOMPLETE_IS_WARNING

static PyObject* DBIncompleteError; /* DB_INCOMPLETE */

#endif

static PyObject* DBInvalidArgError; /* EINVAL */

static PyObject* DBAccessError; /* EACCES */

static PyObject* DBNoSpaceError; /* ENOSPC */

static PyObject* DBNoMemoryError; /* DB_BUFFER_SMALL (ENOMEM when < 4.3) */

static PyObject* DBAgainError; /* EAGAIN */

static PyObject* DBBusyError; /* EBUSY */

static PyObject* DBFileExistsError; /* EEXIST */

static PyObject* DBNoSuchFileError; /* ENOENT */

static PyObject* DBPermissionsError; /* EPERM */

#if (DBVER < 43)

#define DB_BUFFER_SMALL ENOMEM

#endif

/* --------------------------------------------------------------------- */

/* Structure definitions */

#if PYTHON_API_VERSION < 1010

#error "Python 2.1 or later required"

#endif

/* Defaults for moduleFlags in DBEnvObject and DBObject. */

#define DEFAULT_GET_RETURNS_NONE 1

#define DEFAULT_CURSOR_SET_RETURNS_NONE 1 /* 0 in pybsddb < 4.2, python < 2.4 */

static PyTypeObject DB_Type, DBCursor_Type, DBEnv_Type, DBTxn_Type, DBLock_Type;

#define DBObject_Check(v) (Py_Type(v) == &DB_Type)

#define DBCursorObject_Check(v) (Py_Type(v) == &DBCursor_Type)

#define DBEnvObject_Check(v) (Py_Type(v) == &DBEnv_Type)

#define DBTxnObject_Check(v) (Py_Type(v) == &DBTxn_Type)

#define DBLockObject_Check(v) (Py_Type(v) == &DBLock_Type)

#if (DBVER >= 43)

#define DBSequenceObject_Check(v) (Py_Type(v) == &DBSequence_Type)

#endif

/* --------------------------------------------------------------------- */

/* Utility macros and functions */

#define RETURN_IF_ERR() \

if (makeDBError(err)) { \

return NULL; \

}

#define RETURN_NONE() Py_INCREF(Py_None); return Py_None;

#define _CHECK_OBJECT_NOT_CLOSED(nonNull, pyErrObj, name) \

if ((nonNull) == NULL) { \

PyObject *errTuple = NULL; \

errTuple = Py_BuildValue("(is)", 0, #name " object has been closed"); \

PyErr_SetObject((pyErrObj), errTuple); \

Py_DECREF(errTuple); \

return NULL; \

}

#define CHECK_DB_NOT_CLOSED(dbobj) \

_CHECK_OBJECT_NOT_CLOSED(dbobj->db, DBError, DB)

#define CHECK_ENV_NOT_CLOSED(env) \

_CHECK_OBJECT_NOT_CLOSED(env->db_env, DBError, DBEnv)

#define CHECK_CURSOR_NOT_CLOSED(curs) \

_CHECK_OBJECT_NOT_CLOSED(curs->dbc, DBCursorClosedError, DBCursor)

#if (DBVER >= 43)

#define CHECK_SEQUENCE_NOT_CLOSED(curs) \

_CHECK_OBJECT_NOT_CLOSED(curs->sequence, DBError, DBSequence)

#endif

#define CHECK_DBFLAG(mydb, flag) (((mydb)->flags & (flag)) || \

(((mydb)->myenvobj != NULL) && ((mydb)->myenvobj->flags & (flag))))

#define CLEAR_DBT(dbt) (memset(&(dbt), 0, sizeof(dbt)))

static int makeDBError(int err);

/* Return the access method type of the DBObject */

static int _DB_get_type(DBObject* self)

{

#if (DBVER >= 33)

DBTYPE type;

int err;

err = self->db->get_type(self->db, &type);

if (makeDBError(err)) {

return -1;

}

return type;

#else

return self->db->get_type(self->db);

#endif

}

/* Handy function to free a DBT and any self-allocated data within.

To be used on self created DBTs. The make_dbt and make_key_dbt

functions have their own free routines that do more that this. */

static void free_dbt(DBT *dbt)

{

if ((dbt->flags & (DB_DBT_MALLOC|DB_DBT_REALLOC)) && dbt->data != NULL) {

free(dbt->data);

dbt->data = NULL;

}

}

/* Cleanup a Python buffer API view created by make_dbt() */

static void free_buf_view(PyObject *obj, Py_buffer *view)

{

if (view) {

PyObject_ReleaseBuffer(obj, view);

PyMem_Free(view);

}

}

/* Cleanup a DBT and an associated Python buffer API view

created by make_key_dbt() */

#define FREE_DBT_VIEW(dbt, obj, view) \

do { \

free_dbt(&(dbt)); \

free_buf_view((obj), (view)); \

} while(0);

static Py_buffer * _malloc_view(PyObject *obj)

{

Py_buffer *view;

if (!(view = PyMem_Malloc(sizeof(Py_buffer)))) {

PyErr_SetString(PyExc_MemoryError,

"Py_buffer malloc failed");

return NULL;

}

/* XXX(gps): PyBUF_LOCKDATA is desired to prevent other theads from

trashing the data buffer while we release the GIL during the db

operation. see http://bugs.python.org/issue1035 */

if (PyObject_GetBuffer(obj, view, PyBUF_SIMPLE) == -1) {

PyMem_Free(view);

return NULL;

}

if (view->ndim > 1) {

PyErr_SetString(PyExc_BufferError,

"buffers must be single dimension");

PyObject_ReleaseBuffer(obj, view);

PyMem_Free(view);

return NULL;

}

return view;

}

/* Create a DBT structure (containing key and data values) from Python

strings. Returns >= 1 on success, 0 on an error. The returned_view_p

may be filled with a newly allocated Py_buffer view on success.

The caller MUST call free_buf_view() on any returned Py_buffer. */

static int make_dbt(PyObject* obj, DBT* dbt, Py_buffer** returned_view_p)

{

Py_buffer *view;

/* simple way to ensure the caller can detect if we've returned a

new buffer view or not: require their pointer to start out NULL. */

assert(*returned_view_p == NULL);

CLEAR_DBT(*dbt);

if (obj == Py_None) {

/* no need to do anything, the structure has already been zeroed */

return 1;

}

if (!PyObject_CheckBuffer(obj)) {

PyErr_SetString(PyExc_TypeError,

"Data values must support the buffer API or be None.");

return 0;

}

if ( !(view = _malloc_view(obj)) )

return 0;

dbt->data = view->buf;

dbt->size = Py_SAFE_DOWNCAST(view->len, Py_ssize_t, u_int32_t);

*returned_view_p = view;

return 1;

}

/* Recno and Queue DBs can have integer keys. This function figures out

what's been given, verifies that it's allowed, and then makes the DBT.

Caller MUST call FREE_DBT_VIEW(keydbt, keyobj, key_view) with all

returned DBT and Py_buffer values when done. */

static int

make_key_dbt(DBObject* self, PyObject* keyobj, DBT* key, int* pflags,

Py_buffer** returned_view_p)

{

db_recno_t recno;

int type;

Py_buffer *view;

/* simple way to ensure the caller can detect if we've returned a

new buffer view or not: require their pointer to start out NULL. */

assert(*returned_view_p == NULL);

CLEAR_DBT(*key);

if (keyobj == Py_None) {

type = _DB_get_type(self);

if (type == -1)

return 0;

if (type == DB_RECNO || type == DB_QUEUE) {

PyErr_SetString(

PyExc_TypeError,

"None keys not allowed for Recno and Queue DB's");

return 0;

}

/* no need to do anything, the structure has already been zeroed */

}

else if (PyLong_Check(keyobj)) {

/* verify access method type */

type = _DB_get_type(self);

if (type == -1)

return 0;

if (type == DB_BTREE && pflags != NULL) {

/* if BTREE then an Integer key is allowed with the

* DB_SET_RECNO flag */

*pflags |= DB_SET_RECNO;

}

else if (type != DB_RECNO && type != DB_QUEUE) {

PyErr_SetString(

PyExc_TypeError,

"Integer keys only allowed for Recno and Queue DB's");

return 0;

}

/* Make a key out of the requested recno, use allocated space so DB

* will be able to realloc room for the real key if needed. */

recno = PyLong_AS_LONG(keyobj);

key->data = malloc(sizeof(db_recno_t));

if (key->data == NULL) {

PyErr_SetString(PyExc_MemoryError, "Key memory allocation failed");

return 0;

}

key->ulen = key->size = sizeof(db_recno_t);

memcpy(key->data, &recno, sizeof(db_recno_t));

key->flags = DB_DBT_REALLOC;

}

else if (PyObject_CheckBuffer(keyobj)) {

/* verify access method type */

type = _DB_get_type(self);

if (type == -1)

return 0;

if (type == DB_RECNO || type == DB_QUEUE) {

PyErr_SetString(

PyExc_TypeError,

"Non-integer keys not allowed for Recno and Queue DB's");

return 0;

}

if ( !(view = _malloc_view(keyobj)) )

return 0;

/*

* NOTE(gps): I don't like doing a data copy here, it seems

* wasteful. But without a clean way to tell FREE_DBT if it

* should free key->data or not we have to. Other places in

* the code check for DB_THREAD and forceably set DBT_MALLOC

* when we otherwise would leave flags 0 to indicate that.

*/

key->size = Py_SAFE_DOWNCAST(view->len, Py_ssize_t, u_int32_t);

key->data = malloc(key->size);

if (key->data == NULL) {

PyErr_SetString(PyExc_MemoryError, "Key memory allocation failed");

key->size = 0;

return 0;

}

memcpy(key->data, view->buf, key->size);

key->flags = DB_DBT_REALLOC;

*returned_view_p = view;

}

else {

PyErr_Format(PyExc_TypeError,

"buffer or int object expected for key, %s found",

Py_Type(keyobj)->tp_name);

return 0;

}

return 1;

}

/* Add partial record access to an existing DBT data struct.

If dlen and doff are set, then the DB_DBT_PARTIAL flag will be set

and the data storage/retrieval will be done using dlen and doff. */

static int add_partial_dbt(DBT* d, int dlen, int doff) {

/* if neither were set we do nothing (-1 is the default value) */

if ((dlen == -1) && (doff == -1)) {

return 1;

}

if ((dlen < 0) || (doff < 0)) {

PyErr_SetString(PyExc_TypeError, "dlen and doff must both be >= 0");

return 0;

}

d->flags = d->flags | DB_DBT_PARTIAL;

d->dlen = (unsigned int) dlen;

d->doff = (unsigned int) doff;

return 1;

}

/* a safe strcpy() without the zeroing behaviour and semantics of strncpy. */

/* TODO: make this use the native libc strlcpy() when available (BSD) */

unsigned int our_strlcpy(char* dest, const char* src, unsigned int n)

{

unsigned int srclen, copylen;

srclen = strlen(src);

if (n <= 0)

return srclen;

copylen = (srclen > n-1) ? n-1 : srclen;

/* populate dest[0] thru dest[copylen-1] */

memcpy(dest, src, copylen);

/* guarantee null termination */

dest[copylen] = 0;

return srclen;

}

/* Callback used to save away more information about errors from the DB

* library. */

static char _db_errmsg[1024];

#if (DBVER <= 42)

static void _db_errorCallback(const char* prefix, char* msg)

#else

static void _db_errorCallback(const DB_ENV *db_env,

const char* prefix, const char* msg)

#endif

{

our_strlcpy(_db_errmsg, msg, sizeof(_db_errmsg));

}

/* make a nice exception object to raise for errors. */

static int makeDBError(int err)

{

char errTxt[2048]; /* really big, just in case... */

PyObject *errObj = NULL;

PyObject *errTuple = NULL;

int exceptionRaised = 0;

unsigned int bytes_left;

switch (err) {

case 0: /* successful, no error */ break;

#if (DBVER < 41)

case DB_INCOMPLETE:

#if INCOMPLETE_IS_WARNING

bytes_left = our_strlcpy(errTxt, db_strerror(err), sizeof(errTxt));

/* Ensure that bytes_left never goes negative */

if (_db_errmsg[0] && bytes_left < (sizeof(errTxt) - 4)) {

bytes_left = sizeof(errTxt) - bytes_left - 4 - 1;

assert(bytes_left >= 0);

strcat(errTxt, " -- ");

strncat(errTxt, _db_errmsg, bytes_left);

}

_db_errmsg[0] = 0;

exceptionRaised = PyErr_WarnEx(PyExc_RuntimeWarning, errTxt, 1);

#else /* do an exception instead */

errObj = DBIncompleteError;

#endif

break;

#endif /* DBVER < 41 */

case DB_KEYEMPTY: errObj = DBKeyEmptyError; break;

case DB_KEYEXIST: errObj = DBKeyExistError; break;

case DB_LOCK_DEADLOCK: errObj = DBLockDeadlockError; break;

case DB_LOCK_NOTGRANTED: errObj = DBLockNotGrantedError; break;

case DB_NOTFOUND: errObj = DBNotFoundError; break;

case DB_OLD_VERSION: errObj = DBOldVersionError; break;

case DB_RUNRECOVERY: errObj = DBRunRecoveryError; break;

case DB_VERIFY_BAD: errObj = DBVerifyBadError; break;

case DB_NOSERVER: errObj = DBNoServerError; break;

case DB_NOSERVER_HOME: errObj = DBNoServerHomeError; break;

case DB_NOSERVER_ID: errObj = DBNoServerIDError; break;

#if (DBVER >= 33)

case DB_PAGE_NOTFOUND: errObj = DBPageNotFoundError; break;

case DB_SECONDARY_BAD: errObj = DBSecondaryBadError; break;

#endif

case DB_BUFFER_SMALL: errObj = DBNoMemoryError; break;

#if (DBVER >= 43)

/* ENOMEM and DB_BUFFER_SMALL were one and the same until 4.3 */

case ENOMEM: errObj = PyExc_MemoryError; break;

#endif

case EINVAL: errObj = DBInvalidArgError; break;

case EACCES: errObj = DBAccessError; break;

case ENOSPC: errObj = DBNoSpaceError; break;

case EAGAIN: errObj = DBAgainError; break;

case EBUSY : errObj = DBBusyError; break;

case EEXIST: errObj = DBFileExistsError; break;

case ENOENT: errObj = DBNoSuchFileError; break;

case EPERM : errObj = DBPermissionsError; break;

default: errObj = DBError; break;

}

if (errObj != NULL) {

bytes_left = our_strlcpy(errTxt, db_strerror(err), sizeof(errTxt));

/* Ensure that bytes_left never goes negative */

if (_db_errmsg[0] && bytes_left < (sizeof(errTxt) - 4)) {

bytes_left = sizeof(errTxt) - bytes_left - 4 - 1;

assert(bytes_left >= 0);

strcat(errTxt, " -- ");

strncat(errTxt, _db_errmsg, bytes_left);

}

_db_errmsg[0] = 0;

errTuple = Py_BuildValue("(is)", err, errTxt);

PyErr_SetObject(errObj, errTuple);

Py_DECREF(errTuple);

}

return ((errObj != NULL) || exceptionRaised);

}

/* set a type exception */

static void makeTypeError(char* expected, PyObject* found)

{

PyErr_Format(PyExc_TypeError, "Expected %s argument, %s found.",

expected, Py_Type(found)->tp_name);

}

/* verify that an obj is either None or a DBTxn, and set the txn pointer */

static int checkTxnObj(PyObject* txnobj, DB_TXN** txn)

{

if (txnobj == Py_None || txnobj == NULL) {

*txn = NULL;

return 1;

}

if (DBTxnObject_Check(txnobj)) {

*txn = ((DBTxnObject*)txnobj)->txn;

return 1;

}

else

makeTypeError("DBTxn", txnobj);

return 0;

}

/* Delete a key from a database

Returns 0 on success, -1 on an error. */

static int _DB_delete(DBObject* self, DB_TXN *txn, DBT *key, int flags)

{

int err;

MYDB_BEGIN_ALLOW_THREADS;

err = self->db->del(self->db, txn, key, 0);

MYDB_END_ALLOW_THREADS;

if (makeDBError(err)) {

return -1;

}

self->haveStat = 0;

return 0;

}

/* Store a key into a database

Returns 0 on success, -1 on an error. */

static int _DB_put(DBObject* self, DB_TXN *txn, DBT *key, DBT *data, int flags)

{

int err;

MYDB_BEGIN_ALLOW_THREADS;

err = self->db->put(self->db, txn, key, data, flags);

MYDB_END_ALLOW_THREADS;

if (makeDBError(err)) {

return -1;

}

self->haveStat = 0;

return 0;

}

/* Get a key/data pair from a cursor */

static PyObject* _DBCursor_get(DBCursorObject* self, int extra_flags,

PyObject *args, PyObject *kwargs, char *format)

{

int err;

PyObject* retval = NULL;

DBT key, data;

int dlen = -1;

int doff = -1;

int flags = 0;

static char* kwnames[] = { "flags", "dlen", "doff", NULL };

if (!PyArg_ParseTupleAndKeywords(args, kwargs, format, kwnames,

&flags, &dlen, &doff))

return NULL;

CHECK_CURSOR_NOT_CLOSED(self);

flags |= extra_flags;

CLEAR_DBT(key);

CLEAR_DBT(data);

if (CHECK_DBFLAG(self->mydb, DB_THREAD)) {

/* Tell BerkeleyDB to malloc the return value (thread safe) */

data.flags = DB_DBT_MALLOC;

key.flags = DB_DBT_MALLOC;

}

if (!add_partial_dbt(&data, dlen, doff))

return NULL;

MYDB_BEGIN_ALLOW_THREADS;

err = self->dbc->c_get(self->dbc, &key, &data, flags);

MYDB_END_ALLOW_THREADS;

if ((err == DB_NOTFOUND || err == DB_KEYEMPTY)

&& self->mydb->moduleFlags.getReturnsNone) {

Py_INCREF(Py_None);

retval = Py_None;

}

else if (makeDBError(err)) {

retval = NULL;

}

else { /* otherwise, success! */

/* if Recno or Queue, return the key as an Int */

switch (_DB_get_type(self->mydb)) {

case -1:

retval = NULL;

break;

case DB_RECNO:

case DB_QUEUE:

retval = Py_BuildValue("iy#", *((db_recno_t*)key.data),

data.data, data.size);

break;

case DB_HASH:

case DB_BTREE:

default:

retval = Py_BuildValue("y#y#", key.data, key.size,

data.data, data.size);

break;

}

}

if (!err) {

free_dbt(&key);

free_dbt(&data);

}

return retval;

}

/* add an integer to a dictionary using the given name as a key */

static void _addIntToDict(PyObject* dict, char *name, int value)

{

PyObject* v = PyLong_FromLong((long) value);

if (!v || PyDict_SetItemString(dict, name, v))

PyErr_Clear();

Py_XDECREF(v);

}

/* The same, when the value is a time_t */

static void _addTimeTToDict(PyObject* dict, char *name, time_t value)

{

PyObject* v;

/* if the value fits in regular int, use that. */

#ifdef HAVE_LONG_LONG

if (sizeof(time_t) > sizeof(long))

v = PyLong_FromLongLong((PY_LONG_LONG) value);

else

#endif

v = PyLong_FromLong((long) value);

if (!v || PyDict_SetItemString(dict, name, v))

PyErr_Clear();

Py_XDECREF(v);

}

#if (DBVER >= 43)

/* add an db_seq_t to a dictionary using the given name as a key */

static void _addDb_seq_tToDict(PyObject* dict, char *name, db_seq_t value)

{

PyObject* v = PyLong_FromLongLong(value);

if (!v || PyDict_SetItemString(dict, name, v))

PyErr_Clear();

Py_XDECREF(v);

}

#endif

/* --------------------------------------------------------------------- */

/* Allocators and deallocators */

static DBObject*

newDBObject(DBEnvObject* arg, int flags)

{

DBObject* self;

DB_ENV* db_env = NULL;

int err;

self = PyObject_New(DBObject, &DB_Type);

if (self == NULL)

return NULL;

self->haveStat = 0;

self->flags = 0;

self->setflags = 0;

self->myenvobj = NULL;

#if (DBVER >= 33)

self->associateCallback = NULL;

self->btCompareCallback = NULL;

self->primaryDBType = 0;

#endif

self->in_weakreflist = NULL;

/* keep a reference to our python DBEnv object */

if (arg) {

Py_INCREF(arg);

self->myenvobj = arg;

db_env = arg->db_env;

}

if (self->myenvobj)

self->moduleFlags = self->myenvobj->moduleFlags;

else

self->moduleFlags.getReturnsNone = DEFAULT_GET_RETURNS_NONE;

self->moduleFlags.cursorSetReturnsNone = DEFAULT_CURSOR_SET_RETURNS_NONE;

MYDB_BEGIN_ALLOW_THREADS;

err = db_create(&self->db, db_env, flags);

if (self->db != NULL) {

self->db->set_errcall(self->db, _db_errorCallback);

#if (DBVER >= 33)

self->db->app_private = (void*)self;

#endif

}

MYDB_END_ALLOW_THREADS;

/* TODO add a weakref(self) to the self->myenvobj->open_child_weakrefs

* list so that a DBEnv can refuse to close without aborting any open

* DBTxns and closing any open DBs first. */

if (makeDBError(err)) {

if (self->myenvobj) {

Py_DECREF(self->myenvobj);

self->myenvobj = NULL;

}

PyObject_Del(self);

self = NULL;

}

return self;

}

static void

DB_dealloc(DBObject* self)

{

if (self->db != NULL) {

/* avoid closing a DB when its DBEnv has been closed out from under

* it */

if (!self->myenvobj ||

(self->myenvobj && self->myenvobj->db_env))

{

MYDB_BEGIN_ALLOW_THREADS;

self->db->close(self->db, 0);

MYDB_END_ALLOW_THREADS;

} else {

PyErr_WarnEx(PyExc_RuntimeWarning,

"DB could not be closed in destructor:"

" DBEnv already closed",

1);

}

self->db = NULL;

}

if (self->in_weakreflist != NULL) {

PyObject_ClearWeakRefs((PyObject *) self);

}

if (self->myenvobj) {

Py_DECREF(self->myenvobj);

self->myenvobj = NULL;

}

#if (DBVER >= 33)

if (self->associateCallback != NULL) {

Py_DECREF(self->associateCallback);

self->associateCallback = NULL;

}

if (self->btCompareCallback != NULL) {

Py_DECREF(self->btCompareCallback);

self->btCompareCallback = NULL;

}

#endif

PyObject_Del(self);

}

static DBCursorObject*

newDBCursorObject(DBC* dbc, DBObject* db)

{

DBCursorObject* self = PyObject_New(DBCursorObject, &DBCursor_Type);

if (self == NULL)

return NULL;

self->dbc = dbc;

self->mydb = db;

self->in_weakreflist = NULL;

Py_INCREF(self->mydb);

return self;

}

static void

DBCursor_dealloc(DBCursorObject* self)

{

int err;

if (self->in_weakreflist != NULL) {

PyObject_ClearWeakRefs((PyObject *) self);

}

if (self->dbc != NULL) {

MYDB_BEGIN_ALLOW_THREADS;

/* If the underlying database has been closed, we don't

need to do anything. If the environment has been closed

we need to leak, as BerkeleyDB will crash trying to access

the environment. There was an exception when the

user closed the environment even though there still was

a database open. */

if (self->mydb->db && self->mydb->myenvobj &&

!self->mydb->myenvobj->closed)

err = self->dbc->c_close(self->dbc);

self->dbc = NULL;

MYDB_END_ALLOW_THREADS;

}

Py_XDECREF( self->mydb );

PyObject_Del(self);

}

static DBEnvObject*

newDBEnvObject(int flags)

{

int err;

DBEnvObject* self = PyObject_New(DBEnvObject, &DBEnv_Type);

if (self == NULL)

return NULL;

self->closed = 1;

self->flags = flags;

self->moduleFlags.getReturnsNone = DEFAULT_GET_RETURNS_NONE;

self->moduleFlags.cursorSetReturnsNone = DEFAULT_CURSOR_SET_RETURNS_NONE;

self->in_weakreflist = NULL;

MYDB_BEGIN_ALLOW_THREADS;

err = db_env_create(&self->db_env, flags);

MYDB_END_ALLOW_THREADS;

if (makeDBError(err)) {

PyObject_Del(self);

self = NULL;

}

else {

self->db_env->set_errcall(self->db_env, _db_errorCallback);

}

return self;

}

static void

DBEnv_dealloc(DBEnvObject* self)

{

if (self->in_weakreflist != NULL) {

PyObject_ClearWeakRefs((PyObject *) self);

}

if (self->db_env && !self->closed) {

MYDB_BEGIN_ALLOW_THREADS;

self->db_env->close(self->db_env, 0);

MYDB_END_ALLOW_THREADS;

}

PyObject_Del(self);

}

static DBTxnObject*

newDBTxnObject(DBEnvObject* myenv, DB_TXN *parent, int flags)

{

int err;

DBTxnObject* self = PyObject_New(DBTxnObject, &DBTxn_Type);

if (self == NULL)

return NULL;

Py_INCREF(myenv);

self->env = (PyObject*)myenv;

self->in_weakreflist = NULL;

MYDB_BEGIN_ALLOW_THREADS;

#if (DBVER >= 40)

err = myenv->db_env->txn_begin(myenv->db_env, parent, &(self->txn), flags);

#else

err = txn_begin(myenv->db_env, parent, &(self->txn), flags);

#endif

MYDB_END_ALLOW_THREADS;

if (makeDBError(err)) {

Py_DECREF(self->env);

PyObject_Del(self);

self = NULL;

}

return self;

}

static void

DBTxn_dealloc(DBTxnObject* self)

{

if (self->in_weakreflist != NULL) {

PyObject_ClearWeakRefs((PyObject *) self);