2 Unix SMB/CIFS implementation.
4 Python interface to ldb.
6 Copyright (C) 2005,2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2006 Simo Sorce <idra@samba.org>
8 Copyright (C) 2007-2009 Jelmer Vernooij <jelmer@samba.org>
9 Copyright (C) 2009 Matthias Dieter Wallnöfer
11 ** NOTE! The following LGPL license applies to the ldb
12 ** library. This does NOT imply that all of Samba is released
15 This library is free software; you can redistribute it and/or
16 modify it under the terms of the GNU Lesser General Public
17 License as published by the Free Software Foundation; either
18 version 3 of the License, or (at your option) any later version.
20 This library is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 Lesser General Public License for more details.
25 You should have received a copy of the GNU Lesser General Public
26 License along with this library; if not, see <http://www.gnu.org/licenses/>.
31 #include "ldb_private.h"
34 /* There's no Py_ssize_t in 2.4, apparently */
35 #if PY_MAJOR_VERSION == 2 && PY_MINOR_VERSION < 5
36 typedef int Py_ssize_t;
37 typedef inquiry lenfunc;
38 typedef intargfunc ssizeargfunc;
41 #ifndef Py_RETURN_NONE
42 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
45 static void PyErr_SetLdbError(PyObject *error, int ret, struct ldb_context *ldb_ctx)
47 if (ret == LDB_ERR_PYTHON_EXCEPTION)
48 return; /* Python exception should already be set, just keep that */
50 PyErr_SetObject(error,
51 Py_BuildValue(discard_const_p(char, "(i,s)"), ret,
52 ldb_ctx == NULL?ldb_strerror(ret):ldb_errstring(ldb_ctx)));
55 static PyObject *PyExc_LdbError;
57 PyAPI_DATA(PyTypeObject) PyLdbMessage;
58 PyAPI_DATA(PyTypeObject) PyLdbModule;
59 PyAPI_DATA(PyTypeObject) PyLdbDn;
60 PyAPI_DATA(PyTypeObject) PyLdb;
61 PyAPI_DATA(PyTypeObject) PyLdbMessageElement;
62 PyAPI_DATA(PyTypeObject) PyLdbTree;
64 static PyObject *PyObject_FromLdbValue(struct ldb_context *ldb_ctx,
65 struct ldb_message_element *el,
68 struct ldb_val new_val;
69 TALLOC_CTX *mem_ctx = talloc_new(NULL);
74 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
82 * Obtain a ldb DN from a Python object.
84 * @param mem_ctx Memory context
85 * @param object Python object
86 * @param ldb_ctx LDB context
87 * @return Whether or not the conversion succeeded
89 bool PyObject_AsDn(TALLOC_CTX *mem_ctx, PyObject *object,
90 struct ldb_context *ldb_ctx, struct ldb_dn **dn)
94 if (ldb_ctx != NULL && PyString_Check(object)) {
95 odn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
100 if (PyLdbDn_Check(object)) {
101 *dn = PyLdbDn_AsDn(object);
105 PyErr_SetString(PyExc_TypeError, "Expected DN");
110 * Create a Python object from a ldb_result.
112 * @param result LDB result to convert
113 * @return Python object with converted result (a list object)
115 static PyObject *PyLdbResult_FromResult(struct ldb_result *result)
119 if (result == NULL) {
122 ret = PyList_New(result->count);
123 for (i = 0; i < result->count; i++) {
124 PyList_SetItem(ret, i, PyLdbMessage_FromMessage(result->msgs[i])
131 * Create a LDB Result from a Python object.
132 * If conversion fails, NULL will be returned and a Python exception set.
134 * @param mem_ctx Memory context in which to allocate the LDB Result
135 * @param obj Python object to convert
136 * @return a ldb_result, or NULL if the conversion failed
138 static struct ldb_result *PyLdbResult_AsResult(TALLOC_CTX *mem_ctx,
141 struct ldb_result *res;
147 res = talloc_zero(mem_ctx, struct ldb_result);
148 res->count = PyList_Size(obj);
149 res->msgs = talloc_array(res, struct ldb_message *, res->count);
150 for (i = 0; i < res->count; i++) {
151 PyObject *item = PyList_GetItem(obj, i);
152 res->msgs[i] = PyLdbMessage_AsMessage(item);
157 static PyObject *py_ldb_dn_validate(PyLdbDnObject *self)
159 return PyBool_FromLong(ldb_dn_validate(self->dn));
162 static PyObject *py_ldb_dn_is_valid(PyLdbDnObject *self)
164 return PyBool_FromLong(ldb_dn_is_valid(self->dn));
167 static PyObject *py_ldb_dn_is_special(PyLdbDnObject *self)
169 return PyBool_FromLong(ldb_dn_is_special(self->dn));
172 static PyObject *py_ldb_dn_is_null(PyLdbDnObject *self)
174 return PyBool_FromLong(ldb_dn_is_null(self->dn));
177 static PyObject *py_ldb_dn_get_casefold(PyLdbDnObject *self)
179 return PyString_FromString(ldb_dn_get_casefold(self->dn));
182 static PyObject *py_ldb_dn_get_linearized(PyLdbDnObject *self)
184 return PyString_FromString(ldb_dn_get_linearized(self->dn));
187 static PyObject *py_ldb_dn_canonical_str(PyLdbDnObject *self)
189 return PyString_FromString(ldb_dn_canonical_string(self->dn, self->dn));
192 static PyObject *py_ldb_dn_canonical_ex_str(PyLdbDnObject *self)
194 return PyString_FromString(ldb_dn_canonical_ex_string(self->dn, self->dn));
197 static PyObject *py_ldb_dn_repr(PyLdbDnObject *self)
199 return PyString_FromFormat("Dn(%s)", PyObject_REPR(PyString_FromString(ldb_dn_get_linearized(self->dn))));
202 static PyObject *py_ldb_dn_check_special(PyLdbDnObject *self, PyObject *args)
206 if (!PyArg_ParseTuple(args, "s", &name))
209 return ldb_dn_check_special(self->dn, name)?Py_True:Py_False;
212 static int py_ldb_dn_compare(PyLdbDnObject *dn1, PyLdbDnObject *dn2)
215 ret = ldb_dn_compare(dn1->dn, dn2->dn);
216 if (ret < 0) ret = -1;
217 if (ret > 0) ret = 1;
221 static PyObject *py_ldb_dn_get_parent(PyLdbDnObject *self)
223 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self);
224 struct ldb_dn *parent;
225 PyLdbDnObject *py_ret;
226 TALLOC_CTX *mem_ctx = talloc_new(NULL);
228 parent = ldb_dn_get_parent(mem_ctx, dn);
229 if (parent == NULL) {
230 talloc_free(mem_ctx);
234 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
235 if (py_ret == NULL) {
237 talloc_free(mem_ctx);
240 py_ret->mem_ctx = mem_ctx;
242 return (PyObject *)py_ret;
245 #define dn_ldb_ctx(dn) ((struct ldb_context *)dn)
247 static PyObject *py_ldb_dn_add_child(PyLdbDnObject *self, PyObject *args)
250 struct ldb_dn *dn, *other;
251 if (!PyArg_ParseTuple(args, "O", &py_other))
254 dn = PyLdbDn_AsDn((PyObject *)self);
256 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
259 return ldb_dn_add_child(dn, other)?Py_True:Py_False;
262 static PyObject *py_ldb_dn_add_base(PyLdbDnObject *self, PyObject *args)
265 struct ldb_dn *other, *dn;
266 if (!PyArg_ParseTuple(args, "O", &py_other))
269 dn = PyLdbDn_AsDn((PyObject *)self);
271 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
274 return ldb_dn_add_base(dn, other)?Py_True:Py_False;
277 static PyMethodDef py_ldb_dn_methods[] = {
278 { "validate", (PyCFunction)py_ldb_dn_validate, METH_NOARGS,
279 "S.validate() -> bool\n"
280 "Validate DN is correct." },
281 { "is_valid", (PyCFunction)py_ldb_dn_is_valid, METH_NOARGS,
282 "S.is_valid() -> bool\n" },
283 { "is_special", (PyCFunction)py_ldb_dn_is_special, METH_NOARGS,
284 "S.is_special() -> bool\n"
285 "Check whether this is a special LDB DN." },
286 { "is_null", (PyCFunction)py_ldb_dn_is_null, METH_NOARGS,
287 "Check whether this is a null DN." },
288 { "get_casefold", (PyCFunction)py_ldb_dn_get_casefold, METH_NOARGS,
290 { "get_linearized", (PyCFunction)py_ldb_dn_get_linearized, METH_NOARGS,
292 { "canonical_str", (PyCFunction)py_ldb_dn_canonical_str, METH_NOARGS,
293 "S.canonical_str() -> string\n"
294 "Canonical version of this DN (like a posix path)." },
295 { "canonical_ex_str", (PyCFunction)py_ldb_dn_canonical_ex_str, METH_NOARGS,
296 "S.canonical_ex_str() -> string\n"
297 "Canonical version of this DN (like a posix path, with terminating newline)." },
298 { "check_special", (PyCFunction)py_ldb_dn_is_special, METH_VARARGS,
300 { "parent", (PyCFunction)py_ldb_dn_get_parent, METH_NOARGS,
302 "Get the parent for this DN." },
303 { "add_child", (PyCFunction)py_ldb_dn_add_child, METH_VARARGS,
304 "S.add_child(dn) -> None\n"
305 "Add a child DN to this DN." },
306 { "add_base", (PyCFunction)py_ldb_dn_add_base, METH_VARARGS,
307 "S.add_base(dn) -> None\n"
308 "Add a base DN to this DN." },
309 { "check_special", (PyCFunction)py_ldb_dn_check_special, METH_VARARGS,
314 static Py_ssize_t py_ldb_dn_len(PyLdbDnObject *self)
316 return ldb_dn_get_comp_num(PyLdbDn_AsDn((PyObject *)self));
319 static PyObject *py_ldb_dn_concat(PyLdbDnObject *self, PyObject *py_other)
321 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self),
323 PyLdbDnObject *py_ret;
325 if (!PyObject_AsDn(NULL, py_other, NULL, &other))
328 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
329 if (py_ret == NULL) {
333 py_ret->mem_ctx = talloc_new(NULL);
334 py_ret->dn = ldb_dn_copy(py_ret->mem_ctx, dn);
335 ldb_dn_add_child(py_ret->dn, other);
336 return (PyObject *)py_ret;
339 static PySequenceMethods py_ldb_dn_seq = {
340 .sq_length = (lenfunc)py_ldb_dn_len,
341 .sq_concat = (binaryfunc)py_ldb_dn_concat,
344 static PyObject *py_ldb_dn_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
349 struct ldb_context *ldb_ctx;
351 PyLdbDnObject *py_ret;
352 const char * const kwnames[] = { "ldb", "dn", NULL };
354 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Os",
355 discard_const_p(char *, kwnames),
359 ldb_ctx = PyLdb_AsLdbContext(py_ldb);
361 mem_ctx = talloc_new(NULL);
362 if (mem_ctx == NULL) {
367 ret = ldb_dn_new(mem_ctx, ldb_ctx, str);
369 if (ret == NULL || !ldb_dn_validate(ret)) {
370 talloc_free(mem_ctx);
371 PyErr_SetString(PyExc_ValueError, "unable to parse dn string");
375 py_ret = (PyLdbDnObject *)type->tp_alloc(type, 0);
377 talloc_free(mem_ctx);
381 py_ret->mem_ctx = mem_ctx;
383 return (PyObject *)py_ret;
386 PyObject *PyLdbDn_FromDn(struct ldb_dn *dn)
388 PyLdbDnObject *py_ret;
394 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
395 if (py_ret == NULL) {
399 py_ret->mem_ctx = talloc_new(NULL);
400 py_ret->dn = talloc_reference(py_ret->mem_ctx, dn);
401 return (PyObject *)py_ret;
404 static void py_ldb_dn_dealloc(PyLdbDnObject *self)
406 talloc_free(self->mem_ctx);
407 self->ob_type->tp_free(self);
410 PyTypeObject PyLdbDn = {
412 .tp_methods = py_ldb_dn_methods,
413 .tp_str = (reprfunc)py_ldb_dn_get_linearized,
414 .tp_repr = (reprfunc)py_ldb_dn_repr,
415 .tp_compare = (cmpfunc)py_ldb_dn_compare,
416 .tp_as_sequence = &py_ldb_dn_seq,
417 .tp_doc = "A LDB distinguished name.",
418 .tp_new = py_ldb_dn_new,
419 .tp_dealloc = (destructor)py_ldb_dn_dealloc,
420 .tp_basicsize = sizeof(PyLdbObject),
421 .tp_flags = Py_TPFLAGS_DEFAULT,
425 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
426 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
428 PyObject *fn = (PyObject *)context;
429 PyObject_CallFunction(fn, discard_const_p(char, "(i,O)"), level, PyString_FromFormatV(fmt, ap));
432 static PyObject *py_ldb_set_debug(PyLdbObject *self, PyObject *args)
436 if (!PyArg_ParseTuple(args, "O", &cb))
440 /* FIXME: Where do we DECREF cb ? */
441 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_set_debug(self->ldb_ctx, py_ldb_debug, cb), PyLdb_AsLdbContext(self));
446 static PyObject *py_ldb_set_create_perms(PyTypeObject *self, PyObject *args)
449 if (!PyArg_ParseTuple(args, "I", &perms))
452 ldb_set_create_perms(PyLdb_AsLdbContext(self), perms);
457 static PyObject *py_ldb_set_modules_dir(PyTypeObject *self, PyObject *args)
460 if (!PyArg_ParseTuple(args, "s", &modules_dir))
463 ldb_set_modules_dir(PyLdb_AsLdbContext(self), modules_dir);
468 static PyObject *py_ldb_transaction_start(PyLdbObject *self)
470 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_start(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
474 static PyObject *py_ldb_transaction_commit(PyLdbObject *self)
476 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
480 static PyObject *py_ldb_transaction_prepare_commit(PyLdbObject *self)
482 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_prepare_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
486 static PyObject *py_ldb_transaction_cancel(PyLdbObject *self)
488 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_cancel(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
492 static PyObject *py_ldb_setup_wellknown_attributes(PyLdbObject *self)
494 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_setup_wellknown_attributes(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
498 static PyObject *py_ldb_repr(PyLdbObject *self)
500 return PyString_FromFormat("<ldb connection>");
503 static PyObject *py_ldb_get_root_basedn(PyLdbObject *self)
505 struct ldb_dn *dn = ldb_get_root_basedn(PyLdb_AsLdbContext(self));
508 return PyLdbDn_FromDn(dn);
512 static PyObject *py_ldb_get_schema_basedn(PyLdbObject *self)
514 struct ldb_dn *dn = ldb_get_schema_basedn(PyLdb_AsLdbContext(self));
517 return PyLdbDn_FromDn(dn);
520 static PyObject *py_ldb_get_config_basedn(PyLdbObject *self)
522 struct ldb_dn *dn = ldb_get_config_basedn(PyLdb_AsLdbContext(self));
525 return PyLdbDn_FromDn(dn);
528 static PyObject *py_ldb_get_default_basedn(PyLdbObject *self)
530 struct ldb_dn *dn = ldb_get_default_basedn(PyLdb_AsLdbContext(self));
533 return PyLdbDn_FromDn(dn);
536 static const char **PyList_AsStringList(TALLOC_CTX *mem_ctx, PyObject *list,
537 const char *paramname)
541 if (!PyList_Check(list)) {
542 PyErr_Format(PyExc_TypeError, "%s is not a list", paramname);
545 ret = talloc_array(NULL, const char *, PyList_Size(list)+1);
546 for (i = 0; i < PyList_Size(list); i++) {
547 PyObject *item = PyList_GetItem(list, i);
548 if (!PyString_Check(item)) {
549 PyErr_Format(PyExc_TypeError, "%s should be strings", paramname);
552 ret[i] = talloc_strndup(ret, PyString_AsString(item),
553 PyString_Size(item));
559 static int py_ldb_init(PyLdbObject *self, PyObject *args, PyObject *kwargs)
561 const char * const kwnames[] = { "url", "flags", "options", NULL };
563 PyObject *py_options = Py_None;
564 const char **options;
567 struct ldb_context *ldb;
569 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO:Ldb.__init__",
570 discard_const_p(char *, kwnames),
571 &url, &flags, &py_options))
574 ldb = PyLdb_AsLdbContext(self);
576 if (py_options == Py_None) {
579 options = PyList_AsStringList(ldb, py_options, "options");
585 ret = ldb_connect(ldb, url, flags, options);
586 if (ret != LDB_SUCCESS) {
587 PyErr_SetLdbError(PyExc_LdbError, ret, ldb);
592 talloc_free(options);
596 static PyObject *py_ldb_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
599 struct ldb_context *ldb;
600 ret = (PyLdbObject *)type->tp_alloc(type, 0);
605 ret->mem_ctx = talloc_new(NULL);
606 ldb = ldb_init(ret->mem_ctx, NULL);
614 return (PyObject *)ret;
617 static PyObject *py_ldb_connect(PyLdbObject *self, PyObject *args, PyObject *kwargs)
621 PyObject *py_options = Py_None;
623 const char **options;
624 const char * const kwnames[] = { "url", "flags", "options", NULL };
626 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO",
627 discard_const_p(char *, kwnames),
628 &url, &flags, &py_options))
631 if (py_options == Py_None) {
634 options = PyList_AsStringList(NULL, py_options, "options");
639 ret = ldb_connect(PyLdb_AsLdbContext(self), url, flags, options);
640 talloc_free(options);
642 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
647 static PyObject *py_ldb_modify(PyLdbObject *self, PyObject *args)
650 PyObject *py_controls = Py_None;
651 struct ldb_context *ldb_ctx;
652 struct ldb_request *req;
653 struct ldb_control **parsed_controls;
654 struct ldb_message *msg;
656 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls))
659 ldb_ctx = PyLdb_AsLdbContext(self);
661 if (py_controls == Py_None) {
662 parsed_controls = NULL;
664 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
665 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
666 talloc_free(controls);
669 if (!PyLdbMessage_Check(py_msg)) {
670 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message");
673 msg = PyLdbMessage_AsMessage(py_msg);
675 ret = ldb_msg_sanity_check(ldb_ctx, msg);
676 if (ret != LDB_SUCCESS) {
677 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
681 ret = ldb_build_mod_req(&req, ldb_ctx, ldb_ctx,
685 ldb_op_default_callback,
688 if (ret != LDB_SUCCESS) {
689 PyErr_SetString(PyExc_TypeError, "failed to build request");
693 /* do request and autostart a transaction */
694 /* Then let's LDB handle the message error in case of pb as they are meaningful */
696 ret = ldb_transaction_start(ldb_ctx);
697 if (ret != LDB_SUCCESS) {
699 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
702 ret = ldb_request(ldb_ctx, req);
703 if (ret == LDB_SUCCESS) {
704 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
707 if (ret == LDB_SUCCESS) {
708 ret = ldb_transaction_commit(ldb_ctx);
710 ldb_transaction_cancel(ldb_ctx);
711 if (ldb_ctx->err_string == NULL) {
712 /* no error string was setup by the backend */
713 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
717 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
723 static PyObject *py_ldb_add(PyLdbObject *self, PyObject *args)
727 Py_ssize_t dict_pos, msg_pos;
728 struct ldb_message_element *msgel;
729 struct ldb_message *msg;
730 struct ldb_context *ldb_ctx;
731 struct ldb_request *req;
732 PyObject *key, *value;
733 PyObject *py_controls = Py_None;
735 struct ldb_control **parsed_controls;
737 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls ))
739 ldb_ctx = PyLdb_AsLdbContext(self);
741 mem_ctx = talloc_new(NULL);
742 if (py_controls == Py_None) {
743 parsed_controls = NULL;
745 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
746 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
747 talloc_free(controls);
749 if (PyDict_Check(py_msg)) {
750 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
751 msg = ldb_msg_new(mem_ctx);
752 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
753 msg_pos = dict_pos = 0;
755 if (!PyObject_AsDn(msg, dn_value, ldb_ctx, &msg->dn)) {
756 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
757 talloc_free(mem_ctx);
760 if (msg->dn == NULL) {
761 PyErr_SetString(PyExc_TypeError, "dn set but not found");
762 talloc_free(mem_ctx);
767 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
768 char *key_str = PyString_AsString(key);
769 if (strcmp(key_str, "dn") != 0) {
770 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
772 PyErr_SetString(PyExc_TypeError, "unable to import element");
773 talloc_free(mem_ctx);
776 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
781 if (msg->dn == NULL) {
782 PyErr_SetString(PyExc_TypeError, "no dn set");
783 talloc_free(mem_ctx);
787 msg->num_elements = msg_pos;
789 msg = PyLdbMessage_AsMessage(py_msg);
792 ret = ldb_msg_sanity_check(ldb_ctx, msg);
793 if (ret != LDB_SUCCESS) {
794 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
795 talloc_free(mem_ctx);
799 ret = ldb_build_add_req(&req, ldb_ctx, ldb_ctx,
803 ldb_op_default_callback,
806 if (ret != LDB_SUCCESS) {
807 PyErr_SetString(PyExc_TypeError, "failed to build request");
808 talloc_free(mem_ctx);
812 /* do request and autostart a transaction */
813 /* Then let's LDB handle the message error in case of pb as they are meaningful */
815 ret = ldb_transaction_start(ldb_ctx);
816 if (ret != LDB_SUCCESS) {
818 talloc_free(mem_ctx);
819 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
822 ret = ldb_request(ldb_ctx, req);
823 if (ret == LDB_SUCCESS) {
824 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
827 if (ret == LDB_SUCCESS) {
828 ret = ldb_transaction_commit(ldb_ctx);
830 ldb_transaction_cancel(ldb_ctx);
831 if (ldb_ctx->err_string == NULL) {
832 /* no error string was setup by the backend */
833 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
837 talloc_free(mem_ctx);
838 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
843 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
848 struct ldb_context *ldb;
850 if (!PyArg_ParseTuple(args, "O", &py_dn))
853 mem_ctx = talloc_new(NULL);
854 if (mem_ctx == NULL) {
858 ldb = PyLdb_AsLdbContext(self);
859 if (!PyObject_AsDn(mem_ctx, py_dn, ldb, &dn)) {
860 talloc_free(mem_ctx);
864 ret = ldb_delete(ldb, dn);
865 talloc_free(mem_ctx);
866 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
871 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
873 PyObject *py_dn1, *py_dn2;
874 struct ldb_dn *dn1, *dn2;
876 struct ldb_context *ldb;
878 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
881 mem_ctx = talloc_new(NULL);
882 if (mem_ctx == NULL) {
886 ldb = PyLdb_AsLdbContext(self);
887 if (!PyObject_AsDn(mem_ctx, py_dn1, ldb, &dn1)) {
888 talloc_free(mem_ctx);
892 if (!PyObject_AsDn(mem_ctx, py_dn2, ldb, &dn2)) {
893 talloc_free(mem_ctx);
897 ret = ldb_rename(ldb, dn1, dn2);
898 talloc_free(mem_ctx);
899 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
904 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
907 if (!PyArg_ParseTuple(args, "s", &name))
910 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
915 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
917 char *attribute, *syntax;
920 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
923 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
925 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
930 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
935 /* We don't want this attached to the 'ldb' any more */
936 return Py_BuildValue(discard_const_p(char, "(iO)"),
938 PyLdbMessage_FromMessage(ldif->msg));
943 static PyObject *py_ldb_write_ldif(PyLdbMessageObject *self, PyObject *args)
947 struct ldb_ldif ldif;
952 if (!PyArg_ParseTuple(args, "Oi", &py_msg, &changetype))
955 if (!PyLdbMessage_Check(py_msg)) {
956 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for msg");
960 ldif.msg = PyLdbMessage_AsMessage(py_msg);
961 ldif.changetype = changetype;
963 mem_ctx = talloc_new(NULL);
965 string = ldb_ldif_write_string(PyLdb_AsLdbContext(self), mem_ctx, &ldif);
967 PyErr_SetString(PyExc_KeyError, "Failed to generate LDIF");
971 ret = PyString_FromString(string);
973 talloc_free(mem_ctx);
978 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
981 struct ldb_ldif *ldif;
986 if (!PyArg_ParseTuple(args, "s", &s))
989 mem_ctx = talloc_new(NULL);
994 list = PyList_New(0);
995 while (s && *s != '\0') {
996 ldif = ldb_ldif_read_string(self->ldb_ctx, &s);
997 talloc_steal(mem_ctx, ldif);
999 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
1001 PyErr_SetString(PyExc_ValueError, "unable to parse ldif string");
1002 talloc_free(mem_ctx);
1006 talloc_free(mem_ctx); /* The pyobject already has a reference to the things it needs */
1007 return PyObject_GetIter(list);
1010 static PyObject *py_ldb_msg_diff(PyLdbObject *self, PyObject *args)
1012 PyObject *py_msg_old;
1013 PyObject *py_msg_new;
1014 struct ldb_message *diff;
1017 if (!PyArg_ParseTuple(args, "OO", &py_msg_old, &py_msg_new))
1020 if (!PyLdbMessage_Check(py_msg_old)) {
1021 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for old message");
1025 if (!PyLdbMessage_Check(py_msg_new)) {
1026 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for new message");
1030 diff = ldb_msg_diff(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg_old), PyLdbMessage_AsMessage(py_msg_new));
1032 PyErr_SetString(PyExc_RuntimeError, "Failed to generate the Ldb Message diff");
1036 py_ret = PyLdbMessage_FromMessage(diff);
1041 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
1043 const struct ldb_schema_attribute *a;
1044 struct ldb_val old_val;
1045 struct ldb_val new_val;
1046 TALLOC_CTX *mem_ctx;
1051 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
1054 mem_ctx = talloc_new(NULL);
1056 old_val.data = (uint8_t *)PyString_AsString(val);
1057 old_val.length = PyString_Size(val);
1059 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
1065 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
1066 talloc_free(mem_ctx);
1070 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
1072 talloc_free(mem_ctx);
1077 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
1079 PyObject *py_base = Py_None;
1080 int scope = LDB_SCOPE_DEFAULT;
1082 PyObject *py_attrs = Py_None;
1083 PyObject *py_controls = Py_None;
1084 const char * const kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
1086 struct ldb_result *res;
1087 struct ldb_request *req;
1089 struct ldb_context *ldb_ctx;
1090 struct ldb_control **parsed_controls;
1091 struct ldb_dn *base;
1094 /* type "int" rather than "enum" for "scope" is intentional */
1095 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO",
1096 discard_const_p(char *, kwnames),
1097 &py_base, &scope, &expr, &py_attrs, &py_controls))
1100 ldb_ctx = PyLdb_AsLdbContext(self);
1102 if (py_attrs == Py_None) {
1105 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1110 if (py_base == Py_None) {
1111 base = ldb_get_default_basedn(ldb_ctx);
1113 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base)) {
1119 if (py_controls == Py_None) {
1120 parsed_controls = NULL;
1122 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
1123 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
1124 talloc_free(controls);
1127 res = talloc_zero(ldb_ctx, struct ldb_result);
1134 ret = ldb_build_search_req(&req, ldb_ctx, ldb_ctx,
1141 ldb_search_default_callback,
1144 talloc_steal(req, attrs);
1146 if (ret != LDB_SUCCESS) {
1148 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1152 ret = ldb_request(ldb_ctx, req);
1154 if (ret == LDB_SUCCESS) {
1155 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1160 if (ret != LDB_SUCCESS) {
1162 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1166 py_ret = PyLdbResult_FromResult(res);
1173 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
1178 if (!PyArg_ParseTuple(args, "s", &name))
1181 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
1186 /* FIXME: More interpretation */
1191 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
1196 if (!PyArg_ParseTuple(args, "sO", &name, &data))
1199 /* FIXME: More interpretation */
1201 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
1206 static PyObject *py_ldb_modules(PyLdbObject *self)
1208 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
1209 PyObject *ret = PyList_New(0);
1210 struct ldb_module *mod;
1212 for (mod = ldb->modules; mod; mod = mod->next) {
1213 PyList_Append(ret, PyLdbModule_FromModule(mod));
1219 static PyMethodDef py_ldb_methods[] = {
1220 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
1221 "S.set_debug(callback) -> None\n"
1222 "Set callback for LDB debug messages.\n"
1223 "The callback should accept a debug level and debug text." },
1224 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
1225 "S.set_create_perms(mode) -> None\n"
1226 "Set mode to use when creating new LDB files." },
1227 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
1228 "S.set_modules_dir(path) -> None\n"
1229 "Set path LDB should search for modules" },
1230 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
1231 "S.transaction_start() -> None\n"
1232 "Start a new transaction." },
1233 { "transaction_prepare_commit", (PyCFunction)py_ldb_transaction_prepare_commit, METH_NOARGS,
1234 "S.transaction_prepare_commit() -> None\n"
1235 "prepare to commit a new transaction (2-stage commit)." },
1236 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
1237 "S.transaction_commit() -> None\n"
1238 "commit a new transaction." },
1239 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
1240 "S.transaction_cancel() -> None\n"
1241 "cancel a new transaction." },
1242 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
1244 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
1246 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
1248 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
1250 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
1252 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
1253 "S.connect(url, flags=0, options=None) -> None\n"
1254 "Connect to a LDB URL." },
1255 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
1256 "S.modify(message) -> None\n"
1257 "Modify an entry." },
1258 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
1259 "S.add(message) -> None\n"
1261 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
1262 "S.delete(dn) -> None\n"
1263 "Remove an entry." },
1264 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
1265 "S.rename(old_dn, new_dn) -> None\n"
1266 "Rename an entry." },
1267 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
1268 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
1269 "Search in a database.\n"
1271 ":param base: Optional base DN to search\n"
1272 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
1273 ":param expression: Optional search expression\n"
1274 ":param attrs: Attributes to return (defaults to all)\n"
1275 ":param controls: Optional list of controls\n"
1276 ":return: Iterator over Message objects\n"
1278 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
1280 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
1282 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
1284 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
1285 "S.parse_ldif(ldif) -> iter(messages)\n"
1286 "Parse a string formatted using LDIF." },
1287 { "write_ldif", (PyCFunction)py_ldb_write_ldif, METH_VARARGS,
1288 "S.write_ldif(message, changetype) -> ldif\n"
1289 "Print the message as a string formatted using LDIF." },
1290 { "msg_diff", (PyCFunction)py_ldb_msg_diff, METH_VARARGS,
1291 "S.msg_diff(Message) -> Message\n"
1292 "Return an LDB Message of the difference between two Message objects." },
1293 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
1294 "S.get_opaque(name) -> value\n"
1295 "Get an opaque value set on this LDB connection. \n"
1296 ":note: The returned value may not be useful in Python."
1298 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
1299 "S.set_opaque(name, value) -> None\n"
1300 "Set an opaque value on this LDB connection. \n"
1301 ":note: Passing incorrect values may cause crashes." },
1302 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
1303 "S.modules() -> list\n"
1304 "Return the list of modules on this LDB connection " },
1308 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
1310 PyLdbModuleObject *ret;
1312 ret = (PyLdbModuleObject *)PyLdbModule.tp_alloc(&PyLdbModule, 0);
1317 ret->mem_ctx = talloc_new(NULL);
1318 ret->mod = talloc_reference(ret->mem_ctx, mod);
1319 return (PyObject *)ret;
1322 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
1324 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
1327 static PyGetSetDef py_ldb_getset[] = {
1328 { discard_const_p(char, "firstmodule"), (getter)py_ldb_get_firstmodule, NULL, NULL },
1332 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
1334 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
1336 struct ldb_result *result;
1340 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
1343 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
1344 if (ret != LDB_SUCCESS) {
1345 PyErr_SetLdbError(PyExc_LdbError, ret, ldb_ctx);
1349 count = result->count;
1351 talloc_free(result);
1356 static PySequenceMethods py_ldb_seq = {
1357 .sq_contains = (objobjproc)py_ldb_contains,
1360 PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
1364 ret = (PyLdbObject *)PyLdb.tp_alloc(&PyLdb, 0);
1369 ret->mem_ctx = talloc_new(NULL);
1370 ret->ldb_ctx = talloc_reference(ret->mem_ctx, ldb_ctx);
1371 return (PyObject *)ret;
1374 static void py_ldb_dealloc(PyLdbObject *self)
1376 talloc_free(self->mem_ctx);
1377 self->ob_type->tp_free(self);
1380 PyTypeObject PyLdb = {
1382 .tp_methods = py_ldb_methods,
1383 .tp_repr = (reprfunc)py_ldb_repr,
1384 .tp_new = py_ldb_new,
1385 .tp_init = (initproc)py_ldb_init,
1386 .tp_dealloc = (destructor)py_ldb_dealloc,
1387 .tp_getset = py_ldb_getset,
1388 .tp_getattro = PyObject_GenericGetAttr,
1389 .tp_basicsize = sizeof(PyLdbObject),
1390 .tp_doc = "Connection to a LDB database.",
1391 .tp_as_sequence = &py_ldb_seq,
1392 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1395 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1397 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1400 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1402 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1405 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1407 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1411 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1413 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1417 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1419 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1423 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1425 PyObject *py_base, *py_tree, *py_attrs, *py_ret;
1427 struct ldb_request *req;
1428 const char * const kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1429 struct ldb_module *mod;
1430 const char * const*attrs;
1432 /* type "int" rather than "enum" for "scope" is intentional */
1433 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO",
1434 discard_const_p(char *, kwnames),
1435 &py_base, &scope, &py_tree, &py_attrs))
1440 if (py_attrs == Py_None) {
1443 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1448 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1449 scope, NULL /* expr */, attrs,
1450 NULL /* controls */, NULL, NULL, NULL);
1452 talloc_steal(req, attrs);
1454 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1456 req->op.search.res = NULL;
1458 ret = mod->ops->search(mod, req);
1460 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1462 py_ret = PyLdbResult_FromResult(req->op.search.res);
1470 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1472 struct ldb_request *req;
1473 PyObject *py_message;
1475 struct ldb_module *mod;
1477 if (!PyArg_ParseTuple(args, "O", &py_message))
1480 req = talloc_zero(NULL, struct ldb_request);
1481 req->operation = LDB_ADD;
1482 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1484 mod = PyLdbModule_AsModule(self);
1485 ret = mod->ops->add(mod, req);
1487 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1492 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1495 struct ldb_request *req;
1496 PyObject *py_message;
1497 struct ldb_module *mod;
1499 if (!PyArg_ParseTuple(args, "O", &py_message))
1502 req = talloc_zero(NULL, struct ldb_request);
1503 req->operation = LDB_MODIFY;
1504 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1506 mod = PyLdbModule_AsModule(self);
1507 ret = mod->ops->modify(mod, req);
1509 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1514 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1517 struct ldb_request *req;
1520 if (!PyArg_ParseTuple(args, "O", &py_dn))
1523 req = talloc_zero(NULL, struct ldb_request);
1524 req->operation = LDB_DELETE;
1525 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1527 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1529 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1534 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1537 struct ldb_request *req;
1538 PyObject *py_dn1, *py_dn2;
1540 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1543 req = talloc_zero(NULL, struct ldb_request);
1545 req->operation = LDB_RENAME;
1546 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1547 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1549 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1551 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1556 static PyMethodDef py_ldb_module_methods[] = {
1557 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1558 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1559 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1560 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1561 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1562 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1563 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1564 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1568 static void py_ldb_module_dealloc(PyLdbModuleObject *self)
1570 talloc_free(self->mem_ctx);
1571 self->ob_type->tp_free(self);
1574 PyTypeObject PyLdbModule = {
1575 .tp_name = "LdbModule",
1576 .tp_methods = py_ldb_module_methods,
1577 .tp_repr = (reprfunc)py_ldb_module_repr,
1578 .tp_str = (reprfunc)py_ldb_module_str,
1579 .tp_basicsize = sizeof(PyLdbModuleObject),
1580 .tp_dealloc = (destructor)py_ldb_module_dealloc,
1581 .tp_flags = Py_TPFLAGS_DEFAULT,
1586 * Create a ldb_message_element from a Python object.
1588 * This will accept any sequence objects that contains strings, or
1591 * A reference to set_obj will be borrowed.
1593 * @param mem_ctx Memory context
1594 * @param set_obj Python object to convert
1595 * @param flags ldb_message_element flags to set
1596 * @param attr_name Name of the attribute
1597 * @return New ldb_message_element, allocated as child of mem_ctx
1599 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1600 PyObject *set_obj, int flags,
1601 const char *attr_name)
1603 struct ldb_message_element *me;
1605 if (PyLdbMessageElement_Check(set_obj))
1606 return talloc_reference(mem_ctx,
1607 PyLdbMessageElement_AsMessageElement(set_obj));
1609 me = talloc(mem_ctx, struct ldb_message_element);
1611 me->name = talloc_strdup(me, attr_name);
1613 if (PyString_Check(set_obj)) {
1615 me->values = talloc_array(me, struct ldb_val, me->num_values);
1616 me->values[0].length = PyString_Size(set_obj);
1617 me->values[0].data = talloc_memdup(me,
1618 (uint8_t *)PyString_AsString(set_obj), me->values[0].length);
1619 } else if (PySequence_Check(set_obj)) {
1621 me->num_values = PySequence_Size(set_obj);
1622 me->values = talloc_array(me, struct ldb_val, me->num_values);
1623 for (i = 0; i < me->num_values; i++) {
1624 PyObject *obj = PySequence_GetItem(set_obj, i);
1626 me->values[i].length = PyString_Size(obj);
1627 me->values[i].data = talloc_memdup(me,
1628 (uint8_t *)PyString_AsString(obj), me->values[i].length);
1639 static PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1640 struct ldb_message_element *me)
1645 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1646 result = PyList_New(me->num_values);
1648 for (i = 0; i < me->num_values; i++) {
1649 PyList_SetItem(result, i,
1650 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1656 static PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1659 if (!PyArg_ParseTuple(args, "i", &i))
1661 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1664 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1665 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1668 static PyObject *py_ldb_msg_element_flags(PyLdbMessageElementObject *self, PyObject *args)
1670 struct ldb_message_element *el;
1672 el = PyLdbMessageElement_AsMessageElement(self);
1673 return PyInt_FromLong(el->flags);
1676 static PyObject *py_ldb_msg_element_set_flags(PyLdbMessageElementObject *self, PyObject *args)
1679 struct ldb_message_element *el;
1680 if (!PyArg_ParseTuple(args, "i", &flags))
1683 el = PyLdbMessageElement_AsMessageElement(self);
1688 static PyMethodDef py_ldb_msg_element_methods[] = {
1689 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1690 { "set_flags", (PyCFunction)py_ldb_msg_element_set_flags, METH_VARARGS, NULL },
1691 { "flags", (PyCFunction)py_ldb_msg_element_flags, METH_NOARGS, NULL },
1695 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1697 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1700 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1702 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1703 if (idx < 0 || idx >= el->num_values) {
1704 PyErr_SetString(PyExc_IndexError, "Out of range");
1707 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1710 static PySequenceMethods py_ldb_msg_element_seq = {
1711 .sq_length = (lenfunc)py_ldb_msg_element_len,
1712 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1715 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1717 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1718 PyLdbMessageElement_AsMessageElement(other));
1721 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1723 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1726 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el, TALLOC_CTX *mem_ctx)
1728 PyLdbMessageElementObject *ret;
1729 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1734 ret->mem_ctx = talloc_new(NULL);
1735 if (talloc_reference(ret->mem_ctx, mem_ctx) == NULL) {
1740 return (PyObject *)ret;
1743 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1745 PyObject *py_elements = NULL;
1746 struct ldb_message_element *el;
1749 const char * const kwnames[] = { "elements", "flags", "name", NULL };
1750 PyLdbMessageElementObject *ret;
1751 TALLOC_CTX *mem_ctx;
1753 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois",
1754 discard_const_p(char *, kwnames),
1755 &py_elements, &flags, &name))
1758 mem_ctx = talloc_new(NULL);
1759 if (mem_ctx == NULL) {
1764 el = talloc_zero(mem_ctx, struct ldb_message_element);
1766 if (py_elements != NULL) {
1768 if (PyString_Check(py_elements)) {
1770 el->values = talloc_array(el, struct ldb_val, 1);
1771 el->values[0].length = PyString_Size(py_elements);
1772 el->values[0].data = talloc_memdup(el,
1773 (uint8_t *)PyString_AsString(py_elements), el->values[0].length);
1774 } else if (PySequence_Check(py_elements)) {
1775 el->num_values = PySequence_Size(py_elements);
1776 el->values = talloc_array(el, struct ldb_val, el->num_values);
1777 for (i = 0; i < el->num_values; i++) {
1778 PyObject *item = PySequence_GetItem(py_elements, i);
1779 if (!PyString_Check(item)) {
1780 PyErr_Format(PyExc_TypeError,
1781 "Expected string as element %d in list",
1783 talloc_free(mem_ctx);
1786 el->values[i].length = PyString_Size(item);
1787 el->values[i].data = talloc_memdup(el,
1788 (uint8_t *)PyString_AsString(item), el->values[i].length);
1791 PyErr_SetString(PyExc_TypeError,
1792 "Expected string or list");
1793 talloc_free(mem_ctx);
1799 el->name = talloc_strdup(el, name);
1801 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1804 talloc_free(mem_ctx);
1808 ret->mem_ctx = mem_ctx;
1810 return (PyObject *)ret;
1813 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1815 char *element_str = NULL;
1817 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1820 for (i = 0; i < el->num_values; i++) {
1821 PyObject *o = py_ldb_msg_element_find(self, i);
1822 if (element_str == NULL)
1823 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1825 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1828 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1830 talloc_free(element_str);
1835 static PyObject *py_ldb_msg_element_str(PyLdbMessageElementObject *self)
1837 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1839 if (el->num_values == 1)
1840 return PyString_FromStringAndSize((char *)el->values[0].data, el->values[0].length);
1845 static void py_ldb_msg_element_dealloc(PyLdbMessageElementObject *self)
1847 talloc_free(self->mem_ctx);
1848 self->ob_type->tp_free(self);
1851 PyTypeObject PyLdbMessageElement = {
1852 .tp_name = "MessageElement",
1853 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1854 .tp_dealloc = (destructor)py_ldb_msg_element_dealloc,
1855 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1856 .tp_str = (reprfunc)py_ldb_msg_element_str,
1857 .tp_methods = py_ldb_msg_element_methods,
1858 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1859 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1860 .tp_as_sequence = &py_ldb_msg_element_seq,
1861 .tp_new = py_ldb_msg_element_new,
1862 .tp_flags = Py_TPFLAGS_DEFAULT,
1865 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1868 if (!PyArg_ParseTuple(args, "s", &name))
1871 ldb_msg_remove_attr(self->msg, name);
1876 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1878 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1880 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1881 if (msg->dn != NULL) {
1882 PyList_SetItem(obj, j, PyString_FromString("dn"));
1885 for (i = 0; i < msg->num_elements; i++) {
1886 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1892 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1894 struct ldb_message_element *el;
1896 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1897 if (!PyString_Check(py_name)) {
1898 PyErr_SetNone(PyExc_TypeError);
1901 name = PyString_AsString(py_name);
1902 if (!strcmp(name, "dn"))
1903 return PyLdbDn_FromDn(msg->dn);
1904 el = ldb_msg_find_element(msg, name);
1908 return (PyObject *)PyLdbMessageElement_FromMessageElement(el, msg);
1911 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1913 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1915 PyErr_SetString(PyExc_KeyError, "No such element");
1921 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1923 PyObject *name, *ret;
1924 if (!PyArg_ParseTuple(args, "O", &name))
1927 ret = py_ldb_msg_getitem_helper(self, name);
1929 if (PyErr_Occurred())
1936 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1938 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1940 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1942 if (msg->dn != NULL) {
1943 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1946 for (i = 0; i < msg->num_elements; i++, j++) {
1947 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i], self->msg)));
1952 static PyMethodDef py_ldb_msg_methods[] = {
1953 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1954 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1955 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
1956 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
1960 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
1962 PyObject *list, *iter;
1964 list = py_ldb_msg_keys(self);
1965 iter = PyObject_GetIter(list);
1970 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
1974 if (!PyString_Check(name)) {
1975 PyErr_SetNone(PyExc_TypeError);
1979 attr_name = PyString_AsString(name);
1980 if (value == NULL) {
1982 ldb_msg_remove_attr(self->msg, attr_name);
1984 struct ldb_message_element *el = PyObject_AsMessageElement(self->msg,
1985 value, 0, attr_name);
1988 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
1989 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
1994 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
1996 return PyLdbMessage_AsMessage(self)->num_elements;
1999 static PyMappingMethods py_ldb_msg_mapping = {
2000 .mp_length = (lenfunc)py_ldb_msg_length,
2001 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
2002 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
2005 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
2007 const char * const kwnames[] = { "dn", NULL };
2008 struct ldb_message *ret;
2009 TALLOC_CTX *mem_ctx;
2010 PyObject *pydn = NULL;
2011 PyLdbMessageObject *py_ret;
2013 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O",
2014 discard_const_p(char *, kwnames),
2018 mem_ctx = talloc_new(NULL);
2019 if (mem_ctx == NULL) {
2024 ret = ldb_msg_new(mem_ctx);
2026 talloc_free(mem_ctx);
2033 if (!PyObject_AsDn(NULL, pydn, NULL, &dn)) {
2034 talloc_free(mem_ctx);
2037 ret->dn = talloc_reference(ret, dn);
2040 py_ret = (PyLdbMessageObject *)type->tp_alloc(type, 0);
2041 if (py_ret == NULL) {
2043 talloc_free(mem_ctx);
2047 py_ret->mem_ctx = mem_ctx;
2049 return (PyObject *)py_ret;
2052 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
2054 PyLdbMessageObject *ret;
2056 ret = (PyLdbMessageObject *)PyLdbMessage.tp_alloc(&PyLdbMessage, 0);
2061 ret->mem_ctx = talloc_new(NULL);
2062 ret->msg = talloc_reference(ret->mem_ctx, msg);
2063 return (PyObject *)ret;
2066 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
2068 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2069 return PyLdbDn_FromDn(msg->dn);
2072 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
2074 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2075 if (!PyLdbDn_Check(value)) {
2076 PyErr_SetNone(PyExc_TypeError);
2080 msg->dn = talloc_reference(msg, PyLdbDn_AsDn(value));
2084 static PyGetSetDef py_ldb_msg_getset[] = {
2085 { discard_const_p(char, "dn"), (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
2089 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
2091 PyObject *dict = PyDict_New(), *ret;
2092 if (PyDict_Update(dict, (PyObject *)self) != 0)
2094 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
2099 static void py_ldb_msg_dealloc(PyLdbMessageObject *self)
2101 talloc_free(self->mem_ctx);
2102 self->ob_type->tp_free(self);
2105 PyTypeObject PyLdbMessage = {
2106 .tp_name = "Message",
2107 .tp_methods = py_ldb_msg_methods,
2108 .tp_getset = py_ldb_msg_getset,
2109 .tp_as_mapping = &py_ldb_msg_mapping,
2110 .tp_basicsize = sizeof(PyLdbMessageObject),
2111 .tp_dealloc = (destructor)py_ldb_msg_dealloc,
2112 .tp_new = py_ldb_msg_new,
2113 .tp_repr = (reprfunc)py_ldb_msg_repr,
2114 .tp_flags = Py_TPFLAGS_DEFAULT,
2115 .tp_iter = (getiterfunc)py_ldb_msg_iter,
2118 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
2120 PyLdbTreeObject *ret;
2122 ret = (PyLdbTreeObject *)PyLdbTree.tp_alloc(&PyLdbTree, 0);
2128 ret->mem_ctx = talloc_new(NULL);
2129 ret->tree = talloc_reference(ret->mem_ctx, tree);
2130 return (PyObject *)ret;
2133 static void py_ldb_tree_dealloc(PyLdbTreeObject *self)
2135 talloc_free(self->mem_ctx);
2136 self->ob_type->tp_free(self);
2139 PyTypeObject PyLdbTree = {
2141 .tp_basicsize = sizeof(PyLdbTreeObject),
2142 .tp_dealloc = (destructor)py_ldb_tree_dealloc,
2143 .tp_flags = Py_TPFLAGS_DEFAULT,
2147 static int py_module_search(struct ldb_module *mod, struct ldb_request *req)
2149 PyObject *py_ldb = (PyObject *)mod->private_data;
2150 PyObject *py_result, *py_base, *py_attrs, *py_tree;
2152 py_base = PyLdbDn_FromDn(req->op.search.base);
2154 if (py_base == NULL)
2155 return LDB_ERR_OPERATIONS_ERROR;
2157 py_tree = PyLdbTree_FromTree(req->op.search.tree);
2159 if (py_tree == NULL)
2160 return LDB_ERR_OPERATIONS_ERROR;
2162 if (req->op.search.attrs == NULL) {
2166 for (len = 0; req->op.search.attrs[len]; len++);
2167 py_attrs = PyList_New(len);
2168 for (i = 0; i < len; i++)
2169 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
2172 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "search"),
2173 discard_const_p(char, "OiOO"),
2174 py_base, req->op.search.scope, py_tree, py_attrs);
2176 Py_DECREF(py_attrs);
2180 if (py_result == NULL) {
2181 return LDB_ERR_PYTHON_EXCEPTION;
2184 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
2185 if (req->op.search.res == NULL) {
2186 return LDB_ERR_PYTHON_EXCEPTION;
2189 Py_DECREF(py_result);
2194 static int py_module_add(struct ldb_module *mod, struct ldb_request *req)
2196 PyObject *py_ldb = (PyObject *)mod->private_data;
2197 PyObject *py_result, *py_msg;
2199 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.add.message));
2201 if (py_msg == NULL) {
2202 return LDB_ERR_OPERATIONS_ERROR;
2205 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "add"),
2206 discard_const_p(char, "O"),
2211 if (py_result == NULL) {
2212 return LDB_ERR_PYTHON_EXCEPTION;
2215 Py_DECREF(py_result);
2220 static int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
2222 PyObject *py_ldb = (PyObject *)mod->private_data;
2223 PyObject *py_result, *py_msg;
2225 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.mod.message));
2227 if (py_msg == NULL) {
2228 return LDB_ERR_OPERATIONS_ERROR;
2231 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "modify"),
2232 discard_const_p(char, "O"),
2237 if (py_result == NULL) {
2238 return LDB_ERR_PYTHON_EXCEPTION;
2241 Py_DECREF(py_result);
2246 static int py_module_del(struct ldb_module *mod, struct ldb_request *req)
2248 PyObject *py_ldb = (PyObject *)mod->private_data;
2249 PyObject *py_result, *py_dn;
2251 py_dn = PyLdbDn_FromDn(req->op.del.dn);
2254 return LDB_ERR_OPERATIONS_ERROR;
2256 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "delete"),
2257 discard_const_p(char, "O"),
2260 if (py_result == NULL) {
2261 return LDB_ERR_PYTHON_EXCEPTION;
2264 Py_DECREF(py_result);
2269 static int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
2271 PyObject *py_ldb = (PyObject *)mod->private_data;
2272 PyObject *py_result, *py_olddn, *py_newdn;
2274 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
2276 if (py_olddn == NULL)
2277 return LDB_ERR_OPERATIONS_ERROR;
2279 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
2281 if (py_newdn == NULL)
2282 return LDB_ERR_OPERATIONS_ERROR;
2284 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "rename"),
2285 discard_const_p(char, "OO"),
2286 py_olddn, py_newdn);
2288 Py_DECREF(py_olddn);
2289 Py_DECREF(py_newdn);
2291 if (py_result == NULL) {
2292 return LDB_ERR_PYTHON_EXCEPTION;
2295 Py_DECREF(py_result);
2300 static int py_module_request(struct ldb_module *mod, struct ldb_request *req)
2302 PyObject *py_ldb = (PyObject *)mod->private_data;
2303 PyObject *py_result;
2305 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "request"),
2306 discard_const_p(char, ""));
2308 return LDB_ERR_OPERATIONS_ERROR;
2311 static int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
2313 PyObject *py_ldb = (PyObject *)mod->private_data;
2314 PyObject *py_result;
2316 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "extended"),
2317 discard_const_p(char, ""));
2319 return LDB_ERR_OPERATIONS_ERROR;
2322 static int py_module_start_transaction(struct ldb_module *mod)
2324 PyObject *py_ldb = (PyObject *)mod->private_data;
2325 PyObject *py_result;
2327 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "start_transaction"),
2328 discard_const_p(char, ""));
2330 if (py_result == NULL) {
2331 return LDB_ERR_PYTHON_EXCEPTION;
2334 Py_DECREF(py_result);
2339 static int py_module_end_transaction(struct ldb_module *mod)
2341 PyObject *py_ldb = (PyObject *)mod->private_data;
2342 PyObject *py_result;
2344 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "end_transaction"),
2345 discard_const_p(char, ""));
2347 if (py_result == NULL) {
2348 return LDB_ERR_PYTHON_EXCEPTION;
2351 Py_DECREF(py_result);
2356 static int py_module_del_transaction(struct ldb_module *mod)
2358 PyObject *py_ldb = (PyObject *)mod->private_data;
2359 PyObject *py_result;
2361 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "del_transaction"),
2362 discard_const_p(char, ""));
2364 if (py_result == NULL) {
2365 return LDB_ERR_PYTHON_EXCEPTION;
2368 Py_DECREF(py_result);
2373 static int py_module_destructor(struct ldb_module *mod)
2375 Py_DECREF((PyObject *)mod->private_data);
2379 static int py_module_init(struct ldb_module *mod)
2381 PyObject *py_class = (PyObject *)mod->ops->private_data;
2382 PyObject *py_result, *py_next, *py_ldb;
2384 py_ldb = PyLdb_FromLdbContext(mod->ldb);
2387 return LDB_ERR_OPERATIONS_ERROR;
2389 py_next = PyLdbModule_FromModule(mod->next);
2391 if (py_next == NULL)
2392 return LDB_ERR_OPERATIONS_ERROR;
2394 py_result = PyObject_CallFunction(py_class, discard_const_p(char, "OO"),
2397 if (py_result == NULL) {
2398 return LDB_ERR_PYTHON_EXCEPTION;
2401 mod->private_data = py_result;
2403 talloc_set_destructor(mod, py_module_destructor);
2405 return ldb_next_init(mod);
2408 static PyObject *py_register_module(PyObject *module, PyObject *args)
2411 struct ldb_module_ops *ops;
2414 if (!PyArg_ParseTuple(args, "O", &input))
2417 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
2423 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, discard_const_p(char, "name"))));
2426 ops->private_data = input;
2427 ops->init_context = py_module_init;
2428 ops->search = py_module_search;
2429 ops->add = py_module_add;
2430 ops->modify = py_module_modify;
2431 ops->del = py_module_del;
2432 ops->rename = py_module_rename;
2433 ops->request = py_module_request;
2434 ops->extended = py_module_extended;
2435 ops->start_transaction = py_module_start_transaction;
2436 ops->end_transaction = py_module_end_transaction;
2437 ops->del_transaction = py_module_del_transaction;
2439 ret = ldb_register_module(ops);
2441 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
2446 static PyObject *py_timestring(PyObject *module, PyObject *args)
2452 if (!PyArg_ParseTuple(args, "l", &val))
2455 tresult = ldb_timestring(NULL, t);
2456 ret = PyString_FromString(tresult);
2457 talloc_free(tresult);
2461 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
2464 if (!PyArg_ParseTuple(args, "s", &str))
2467 return PyInt_FromLong(ldb_string_to_time(str));
2470 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
2473 if (!PyArg_ParseTuple(args, "s", &name))
2475 return PyBool_FromLong(ldb_valid_attr_name(name));
2478 static PyMethodDef py_ldb_global_methods[] = {
2479 { "register_module", py_register_module, METH_VARARGS,
2480 "S.register_module(module) -> None\n"
2481 "Register a LDB module."},
2482 { "timestring", py_timestring, METH_VARARGS,
2483 "S.timestring(int) -> string\n"
2484 "Generate a LDAP time string from a UNIX timestamp" },
2485 { "string_to_time", py_string_to_time, METH_VARARGS,
2486 "S.string_to_time(string) -> int\n"
2487 "Parse a LDAP time string into a UNIX timestamp." },
2488 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
2489 "S.valid_attr_name(name) -> bool\n"
2490 "Check whether the supplied name is a valid attribute name." },
2491 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
2500 if (PyType_Ready(&PyLdbDn) < 0)
2503 if (PyType_Ready(&PyLdbMessage) < 0)
2506 if (PyType_Ready(&PyLdbMessageElement) < 0)
2509 if (PyType_Ready(&PyLdb) < 0)
2512 if (PyType_Ready(&PyLdbModule) < 0)
2515 if (PyType_Ready(&PyLdbTree) < 0)
2518 m = Py_InitModule3("ldb", py_ldb_global_methods,
2519 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
2523 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
2524 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
2525 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
2526 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
2528 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
2529 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
2530 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
2531 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
2533 PyModule_AddObject(m, "FLAG_MOD_ADD", PyInt_FromLong(LDB_FLAG_MOD_ADD));
2534 PyModule_AddObject(m, "FLAG_MOD_REPLACE", PyInt_FromLong(LDB_FLAG_MOD_REPLACE));
2535 PyModule_AddObject(m, "FLAG_MOD_DELETE", PyInt_FromLong(LDB_FLAG_MOD_DELETE));
2537 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
2538 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
2539 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
2540 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
2541 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
2542 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
2543 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
2544 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
2545 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
2546 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
2547 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
2548 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
2549 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
2550 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
2551 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
2552 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
2553 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
2554 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
2555 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
2556 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
2557 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
2558 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
2559 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
2560 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
2561 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
2562 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
2563 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
2564 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
2565 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
2566 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
2567 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
2568 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
2569 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
2570 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
2571 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
2572 PyModule_AddObject(m, "ERR_ENTRY_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
2573 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
2574 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
2575 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
2577 PyModule_AddObject(m, "FLG_RDONLY", PyInt_FromLong(LDB_FLG_RDONLY));
2578 PyModule_AddObject(m, "FLG_NOSYNC", PyInt_FromLong(LDB_FLG_NOSYNC));
2579 PyModule_AddObject(m, "FLG_RECONNECT", PyInt_FromLong(LDB_FLG_RECONNECT));
2580 PyModule_AddObject(m, "FLG_NOMMAP", PyInt_FromLong(LDB_FLG_NOMMAP));
2583 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
2585 PyExc_LdbError = PyErr_NewException(discard_const_p(char, "_ldb.LdbError"), NULL, NULL);
2586 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
2589 Py_INCREF(&PyLdbDn);
2590 Py_INCREF(&PyLdbModule);
2591 Py_INCREF(&PyLdbMessage);
2592 Py_INCREF(&PyLdbMessageElement);
2593 Py_INCREF(&PyLdbTree);
2595 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
2596 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
2597 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
2598 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
2599 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
2600 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);