2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-08 09:55:22 +00:00
Files
kea/src/lib/python/isc/datasrc/iterator_python.cc
JINMEI Tatuya ba3695664a [2309] unrelated cleanup: rename datasrc/itearator.h zone_iterator.h
in accordance with the previous cleanup for zone_finder.  "iterator" is
too generic and should have been renamed.  now is probably a good opportunity.
2013-01-22 22:30:12 -08:00

243 lines
8.6 KiB
C++

// Copyright (C) 2011 Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
// Enable this if you use s# variants with PyArg_ParseTuple(), see
// http://docs.python.org/py3k/c-api/arg.html#strings-and-buffers
//#define PY_SSIZE_T_CLEAN
// Python.h needs to be placed at the head of the program file, see:
// http://docs.python.org/py3k/extending/extending.html#a-simple-example
#include <Python.h>
#include <util/python/pycppwrapper_util.h>
#include <datasrc/client.h>
#include <datasrc/database.h>
#include <datasrc/sqlite3_accessor.h>
#include <datasrc/zone_iterator.h>
#include <dns/python/name_python.h>
#include <dns/python/rrset_python.h>
#include "datasrc.h"
#include "iterator_python.h"
#include "iterator_inc.cc"
using namespace std;
using namespace isc::util::python;
using namespace isc::dns::python;
using namespace isc::datasrc;
using namespace isc::datasrc::python;
namespace {
// The s_* Class simply covers one instantiation of the object
class s_ZoneIterator : public PyObject {
public:
s_ZoneIterator() : cppobj(ZoneIteratorPtr()), base_obj(NULL) {};
ZoneIteratorPtr cppobj;
// This is a reference to a base object; if the object of this class
// depends on another object to be in scope during its lifetime,
// we use INCREF the base object upon creation, and DECREF it at
// the end of the destructor
// This is an optional argument to createXXX(). If NULL, it is ignored.
PyObject* base_obj;
};
// Shortcut type which would be convenient for adding class variables safely.
typedef CPPPyObjectContainer<s_ZoneIterator, ZoneIterator>
ZoneIteratorContainer;
// General creation and destruction
int
ZoneIterator_init(s_ZoneIterator* self, PyObject* args) {
// can't be called directly
PyErr_SetString(PyExc_TypeError,
"ZoneIterator cannot be constructed directly");
return (-1);
}
void
ZoneIterator_destroy(s_ZoneIterator* const self) {
// cppobj is a shared ptr, but to make sure things are not destroyed in
// the wrong order, we reset it here.
self->cppobj.reset();
if (self->base_obj != NULL) {
Py_DECREF(self->base_obj);
}
Py_TYPE(self)->tp_free(self);
}
//
// We declare the functions here, the definitions are below
// the type definition of the object, since both can use the other
//
PyObject*
ZoneIterator_getNextRRset(PyObject* po_self, PyObject*) {
s_ZoneIterator* self = static_cast<s_ZoneIterator*>(po_self);
if (!self->cppobj) {
PyErr_SetString(getDataSourceException("Error"),
"get_next_rrset() called past end of iterator");
return (NULL);
}
try {
isc::dns::ConstRRsetPtr rrset = self->cppobj->getNextRRset();
if (!rrset) {
Py_RETURN_NONE;
}
return (createRRsetObject(*rrset));
} catch (const isc::Exception& isce) {
// isc::Unexpected is thrown when we call getNextRRset() when we are
// already done iterating ('iterating past end')
// We could also simply return None again
PyErr_SetString(getDataSourceException("Error"), isce.what());
return (NULL);
} catch (const std::exception& exc) {
PyErr_SetString(getDataSourceException("Error"), exc.what());
return (NULL);
} catch (...) {
PyErr_SetString(getDataSourceException("Error"),
"Unexpected exception");
return (NULL);
}
}
PyObject*
ZoneIterator_iter(PyObject *self) {
Py_INCREF(self);
return (self);
}
PyObject*
ZoneIterator_next(PyObject* self) {
PyObject *result = ZoneIterator_getNextRRset(self, NULL);
// iter_next must return NULL without error instead of Py_None
if (result == Py_None) {
Py_DECREF(result);
return (NULL);
} else {
return (result);
}
}
PyObject*
ZoneIterator_getSOA(PyObject* po_self, PyObject*) {
s_ZoneIterator* self = static_cast<s_ZoneIterator*>(po_self);
try {
isc::dns::ConstRRsetPtr rrset = self->cppobj->getSOA();
if (!rrset) {
Py_RETURN_NONE;
}
return (createRRsetObject(*rrset));
} catch (const isc::Exception& isce) {
// isc::Unexpected is thrown when we call getNextRRset() when we are
// already done iterating ('iterating past end')
// We could also simply return None again
PyErr_SetString(getDataSourceException("Error"), isce.what());
return (NULL);
} catch (const std::exception& exc) {
PyErr_SetString(getDataSourceException("Error"), exc.what());
return (NULL);
} catch (...) {
PyErr_SetString(getDataSourceException("Error"),
"Unexpected exception");
return (NULL);
}
}
PyMethodDef ZoneIterator_methods[] = {
{ "get_next_rrset", ZoneIterator_getNextRRset, METH_NOARGS,
ZoneIterator_getNextRRset_doc },
{ "get_soa", ZoneIterator_getSOA, METH_NOARGS, ZoneIterator_getSOA_doc },
{ NULL, NULL, 0, NULL }
};
} // end of unnamed namespace
namespace isc {
namespace datasrc {
namespace python {
PyTypeObject zoneiterator_type = {
PyVarObject_HEAD_INIT(NULL, 0)
"datasrc.ZoneIterator",
sizeof(s_ZoneIterator), // tp_basicsize
0, // tp_itemsize
reinterpret_cast<destructor>(ZoneIterator_destroy),// tp_dealloc
NULL, // tp_print
NULL, // tp_getattr
NULL, // tp_setattr
NULL, // tp_reserved
NULL, // tp_repr
NULL, // tp_as_number
NULL, // tp_as_sequence
NULL, // tp_as_mapping
NULL, // tp_hash
NULL, // tp_call
NULL, // tp_str
NULL, // tp_getattro
NULL, // tp_setattro
NULL, // tp_as_buffer
Py_TPFLAGS_DEFAULT, // tp_flags
ZoneIterator_doc,
NULL, // tp_traverse
NULL, // tp_clear
NULL, // tp_richcompare
0, // tp_weaklistoffset
ZoneIterator_iter, // tp_iter
ZoneIterator_next, // tp_iternext
ZoneIterator_methods, // tp_methods
NULL, // tp_members
NULL, // tp_getset
NULL, // tp_base
NULL, // tp_dict
NULL, // tp_descr_get
NULL, // tp_descr_set
0, // tp_dictoffset
reinterpret_cast<initproc>(ZoneIterator_init),// tp_init
NULL, // tp_alloc
PyType_GenericNew, // tp_new
NULL, // tp_free
NULL, // tp_is_gc
NULL, // tp_bases
NULL, // tp_mro
NULL, // tp_cache
NULL, // tp_subclasses
NULL, // tp_weaklist
NULL, // tp_del
0 // tp_version_tag
};
PyObject*
createZoneIteratorObject(isc::datasrc::ZoneIteratorPtr source,
PyObject* base_obj)
{
s_ZoneIterator* py_zi = static_cast<s_ZoneIterator*>(
zoneiterator_type.tp_alloc(&zoneiterator_type, 0));
if (py_zi != NULL) {
py_zi->cppobj = source;
py_zi->base_obj = base_obj;
if (base_obj != NULL) {
Py_INCREF(base_obj);
}
}
return (py_zi);
}
} // namespace python
} // namespace datasrc
} // namespace isc