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-2010 Jelmer Vernooij <jelmer@samba.org>
9 Copyright (C) 2009-2010 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 *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx);
66 static PyObject *PyObject_FromLdbValue(struct ldb_context *ldb_ctx,
67 struct ldb_message_element *el,
70 struct ldb_val new_val;
71 TALLOC_CTX *mem_ctx = talloc_new(NULL);
76 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
84 * Create a Python object from a ldb_result.
86 * @param result LDB result to convert
87 * @return Python object with converted result (a list object)
89 static PyObject *PyLdbResult_FromResult(struct ldb_result *result)
96 ret = PyList_New(result->count);
97 for (i = 0; i < result->count; i++) {
98 PyList_SetItem(ret, i, PyLdbMessage_FromMessage(result->msgs[i])
105 * Create a LDB Result from a Python object.
106 * If conversion fails, NULL will be returned and a Python exception set.
108 * @param mem_ctx Memory context in which to allocate the LDB Result
109 * @param obj Python object to convert
110 * @return a ldb_result, or NULL if the conversion failed
112 static struct ldb_result *PyLdbResult_AsResult(TALLOC_CTX *mem_ctx,
115 struct ldb_result *res;
121 res = talloc_zero(mem_ctx, struct ldb_result);
122 res->count = PyList_Size(obj);
123 res->msgs = talloc_array(res, struct ldb_message *, res->count);
124 for (i = 0; i < res->count; i++) {
125 PyObject *item = PyList_GetItem(obj, i);
126 res->msgs[i] = PyLdbMessage_AsMessage(item);
131 static PyObject *py_ldb_dn_validate(PyLdbDnObject *self)
133 return PyBool_FromLong(ldb_dn_validate(self->dn));
136 static PyObject *py_ldb_dn_is_valid(PyLdbDnObject *self)
138 return PyBool_FromLong(ldb_dn_is_valid(self->dn));
141 static PyObject *py_ldb_dn_is_special(PyLdbDnObject *self)
143 return PyBool_FromLong(ldb_dn_is_special(self->dn));
146 static PyObject *py_ldb_dn_is_null(PyLdbDnObject *self)
148 return PyBool_FromLong(ldb_dn_is_null(self->dn));
151 static PyObject *py_ldb_dn_get_casefold(PyLdbDnObject *self)
153 return PyString_FromString(ldb_dn_get_casefold(self->dn));
156 static PyObject *py_ldb_dn_get_linearized(PyLdbDnObject *self)
158 return PyString_FromString(ldb_dn_get_linearized(self->dn));
161 static PyObject *py_ldb_dn_canonical_str(PyLdbDnObject *self)
163 return PyString_FromString(ldb_dn_canonical_string(self->dn, self->dn));
166 static PyObject *py_ldb_dn_canonical_ex_str(PyLdbDnObject *self)
168 return PyString_FromString(ldb_dn_canonical_ex_string(self->dn, self->dn));
171 static PyObject *py_ldb_dn_repr(PyLdbDnObject *self)
173 return PyString_FromFormat("Dn(%s)", PyObject_REPR(PyString_FromString(ldb_dn_get_linearized(self->dn))));
176 static PyObject *py_ldb_dn_check_special(PyLdbDnObject *self, PyObject *args)
180 if (!PyArg_ParseTuple(args, "s", &name))
183 return ldb_dn_check_special(self->dn, name)?Py_True:Py_False;
186 static int py_ldb_dn_compare(PyLdbDnObject *dn1, PyLdbDnObject *dn2)
189 ret = ldb_dn_compare(dn1->dn, dn2->dn);
190 if (ret < 0) ret = -1;
191 if (ret > 0) ret = 1;
195 static PyObject *py_ldb_dn_get_parent(PyLdbDnObject *self)
197 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self);
198 struct ldb_dn *parent;
199 PyLdbDnObject *py_ret;
200 TALLOC_CTX *mem_ctx = talloc_new(NULL);
202 parent = ldb_dn_get_parent(mem_ctx, dn);
203 if (parent == NULL) {
204 talloc_free(mem_ctx);
208 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
209 if (py_ret == NULL) {
211 talloc_free(mem_ctx);
214 py_ret->mem_ctx = mem_ctx;
216 return (PyObject *)py_ret;
219 #define dn_ldb_ctx(dn) ((struct ldb_context *)dn)
221 static PyObject *py_ldb_dn_add_child(PyLdbDnObject *self, PyObject *args)
224 struct ldb_dn *dn, *other;
225 if (!PyArg_ParseTuple(args, "O", &py_other))
228 dn = PyLdbDn_AsDn((PyObject *)self);
230 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
233 return ldb_dn_add_child(dn, other)?Py_True:Py_False;
236 static PyObject *py_ldb_dn_add_base(PyLdbDnObject *self, PyObject *args)
239 struct ldb_dn *other, *dn;
240 if (!PyArg_ParseTuple(args, "O", &py_other))
243 dn = PyLdbDn_AsDn((PyObject *)self);
245 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
248 return ldb_dn_add_base(dn, other)?Py_True:Py_False;
251 static PyMethodDef py_ldb_dn_methods[] = {
252 { "validate", (PyCFunction)py_ldb_dn_validate, METH_NOARGS,
253 "S.validate() -> bool\n"
254 "Validate DN is correct." },
255 { "is_valid", (PyCFunction)py_ldb_dn_is_valid, METH_NOARGS,
256 "S.is_valid() -> bool\n" },
257 { "is_special", (PyCFunction)py_ldb_dn_is_special, METH_NOARGS,
258 "S.is_special() -> bool\n"
259 "Check whether this is a special LDB DN." },
260 { "is_null", (PyCFunction)py_ldb_dn_is_null, METH_NOARGS,
261 "Check whether this is a null DN." },
262 { "get_casefold", (PyCFunction)py_ldb_dn_get_casefold, METH_NOARGS,
264 { "get_linearized", (PyCFunction)py_ldb_dn_get_linearized, METH_NOARGS,
266 { "canonical_str", (PyCFunction)py_ldb_dn_canonical_str, METH_NOARGS,
267 "S.canonical_str() -> string\n"
268 "Canonical version of this DN (like a posix path)." },
269 { "canonical_ex_str", (PyCFunction)py_ldb_dn_canonical_ex_str, METH_NOARGS,
270 "S.canonical_ex_str() -> string\n"
271 "Canonical version of this DN (like a posix path, with terminating newline)." },
272 { "check_special", (PyCFunction)py_ldb_dn_is_special, METH_VARARGS,
274 { "parent", (PyCFunction)py_ldb_dn_get_parent, METH_NOARGS,
276 "Get the parent for this DN." },
277 { "add_child", (PyCFunction)py_ldb_dn_add_child, METH_VARARGS,
278 "S.add_child(dn) -> None\n"
279 "Add a child DN to this DN." },
280 { "add_base", (PyCFunction)py_ldb_dn_add_base, METH_VARARGS,
281 "S.add_base(dn) -> None\n"
282 "Add a base DN to this DN." },
283 { "check_special", (PyCFunction)py_ldb_dn_check_special, METH_VARARGS,
288 static Py_ssize_t py_ldb_dn_len(PyLdbDnObject *self)
290 return ldb_dn_get_comp_num(PyLdbDn_AsDn((PyObject *)self));
293 static PyObject *py_ldb_dn_concat(PyLdbDnObject *self, PyObject *py_other)
295 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self),
297 PyLdbDnObject *py_ret;
299 if (!PyObject_AsDn(NULL, py_other, NULL, &other))
302 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
303 if (py_ret == NULL) {
307 py_ret->mem_ctx = talloc_new(NULL);
308 py_ret->dn = ldb_dn_copy(py_ret->mem_ctx, dn);
309 ldb_dn_add_child(py_ret->dn, other);
310 return (PyObject *)py_ret;
313 static PySequenceMethods py_ldb_dn_seq = {
314 .sq_length = (lenfunc)py_ldb_dn_len,
315 .sq_concat = (binaryfunc)py_ldb_dn_concat,
318 static PyObject *py_ldb_dn_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
323 struct ldb_context *ldb_ctx;
325 PyLdbDnObject *py_ret;
326 const char * const kwnames[] = { "ldb", "dn", NULL };
328 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Os",
329 discard_const_p(char *, kwnames),
333 ldb_ctx = PyLdb_AsLdbContext(py_ldb);
335 mem_ctx = talloc_new(NULL);
336 if (mem_ctx == NULL) {
341 ret = ldb_dn_new(mem_ctx, ldb_ctx, str);
343 if (ret == NULL || !ldb_dn_validate(ret)) {
344 talloc_free(mem_ctx);
345 PyErr_SetString(PyExc_ValueError, "unable to parse dn string");
349 py_ret = (PyLdbDnObject *)type->tp_alloc(type, 0);
351 talloc_free(mem_ctx);
355 py_ret->mem_ctx = mem_ctx;
357 return (PyObject *)py_ret;
360 PyObject *PyLdbDn_FromDn(struct ldb_dn *dn)
362 PyLdbDnObject *py_ret;
368 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
369 if (py_ret == NULL) {
373 py_ret->mem_ctx = talloc_new(NULL);
374 py_ret->dn = talloc_reference(py_ret->mem_ctx, dn);
375 return (PyObject *)py_ret;
378 static void py_ldb_dn_dealloc(PyLdbDnObject *self)
380 talloc_free(self->mem_ctx);
381 self->ob_type->tp_free(self);
384 PyTypeObject PyLdbDn = {
386 .tp_methods = py_ldb_dn_methods,
387 .tp_str = (reprfunc)py_ldb_dn_get_linearized,
388 .tp_repr = (reprfunc)py_ldb_dn_repr,
389 .tp_compare = (cmpfunc)py_ldb_dn_compare,
390 .tp_as_sequence = &py_ldb_dn_seq,
391 .tp_doc = "A LDB distinguished name.",
392 .tp_new = py_ldb_dn_new,
393 .tp_dealloc = (destructor)py_ldb_dn_dealloc,
394 .tp_basicsize = sizeof(PyLdbObject),
395 .tp_flags = Py_TPFLAGS_DEFAULT,
399 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
400 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
402 PyObject *fn = (PyObject *)context;
403 PyObject_CallFunction(fn, discard_const_p(char, "(i,O)"), level, PyString_FromFormatV(fmt, ap));
406 static PyObject *py_ldb_set_debug(PyLdbObject *self, PyObject *args)
410 if (!PyArg_ParseTuple(args, "O", &cb))
414 /* FIXME: Where do we DECREF cb ? */
415 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_set_debug(self->ldb_ctx, py_ldb_debug, cb), PyLdb_AsLdbContext(self));
420 static PyObject *py_ldb_set_create_perms(PyTypeObject *self, PyObject *args)
423 if (!PyArg_ParseTuple(args, "I", &perms))
426 ldb_set_create_perms(PyLdb_AsLdbContext(self), perms);
431 static PyObject *py_ldb_set_modules_dir(PyTypeObject *self, PyObject *args)
434 if (!PyArg_ParseTuple(args, "s", &modules_dir))
437 ldb_set_modules_dir(PyLdb_AsLdbContext(self), modules_dir);
442 static PyObject *py_ldb_transaction_start(PyLdbObject *self)
444 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_start(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
448 static PyObject *py_ldb_transaction_commit(PyLdbObject *self)
450 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
454 static PyObject *py_ldb_transaction_prepare_commit(PyLdbObject *self)
456 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_prepare_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
460 static PyObject *py_ldb_transaction_cancel(PyLdbObject *self)
462 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_cancel(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
466 static PyObject *py_ldb_setup_wellknown_attributes(PyLdbObject *self)
468 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_setup_wellknown_attributes(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
472 static PyObject *py_ldb_repr(PyLdbObject *self)
474 return PyString_FromFormat("<ldb connection>");
477 static PyObject *py_ldb_get_root_basedn(PyLdbObject *self)
479 struct ldb_dn *dn = ldb_get_root_basedn(PyLdb_AsLdbContext(self));
482 return PyLdbDn_FromDn(dn);
486 static PyObject *py_ldb_get_schema_basedn(PyLdbObject *self)
488 struct ldb_dn *dn = ldb_get_schema_basedn(PyLdb_AsLdbContext(self));
491 return PyLdbDn_FromDn(dn);
494 static PyObject *py_ldb_get_config_basedn(PyLdbObject *self)
496 struct ldb_dn *dn = ldb_get_config_basedn(PyLdb_AsLdbContext(self));
499 return PyLdbDn_FromDn(dn);
502 static PyObject *py_ldb_get_default_basedn(PyLdbObject *self)
504 struct ldb_dn *dn = ldb_get_default_basedn(PyLdb_AsLdbContext(self));
507 return PyLdbDn_FromDn(dn);
510 static const char **PyList_AsStringList(TALLOC_CTX *mem_ctx, PyObject *list,
511 const char *paramname)
515 if (!PyList_Check(list)) {
516 PyErr_Format(PyExc_TypeError, "%s is not a list", paramname);
519 ret = talloc_array(NULL, const char *, PyList_Size(list)+1);
520 for (i = 0; i < PyList_Size(list); i++) {
521 PyObject *item = PyList_GetItem(list, i);
522 if (!PyString_Check(item)) {
523 PyErr_Format(PyExc_TypeError, "%s should be strings", paramname);
526 ret[i] = talloc_strndup(ret, PyString_AsString(item),
527 PyString_Size(item));
533 static int py_ldb_init(PyLdbObject *self, PyObject *args, PyObject *kwargs)
535 const char * const kwnames[] = { "url", "flags", "options", NULL };
537 PyObject *py_options = Py_None;
538 const char **options;
541 struct ldb_context *ldb;
543 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO:Ldb.__init__",
544 discard_const_p(char *, kwnames),
545 &url, &flags, &py_options))
548 ldb = PyLdb_AsLdbContext(self);
550 if (py_options == Py_None) {
553 options = PyList_AsStringList(ldb, py_options, "options");
559 ret = ldb_connect(ldb, url, flags, options);
560 if (ret != LDB_SUCCESS) {
561 PyErr_SetLdbError(PyExc_LdbError, ret, ldb);
566 talloc_free(options);
570 static PyObject *py_ldb_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
573 struct ldb_context *ldb;
574 ret = (PyLdbObject *)type->tp_alloc(type, 0);
579 ret->mem_ctx = talloc_new(NULL);
580 ldb = ldb_init(ret->mem_ctx, NULL);
588 return (PyObject *)ret;
591 static PyObject *py_ldb_connect(PyLdbObject *self, PyObject *args, PyObject *kwargs)
595 PyObject *py_options = Py_None;
597 const char **options;
598 const char * const kwnames[] = { "url", "flags", "options", NULL };
600 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO",
601 discard_const_p(char *, kwnames),
602 &url, &flags, &py_options))
605 if (py_options == Py_None) {
608 options = PyList_AsStringList(NULL, py_options, "options");
613 ret = ldb_connect(PyLdb_AsLdbContext(self), url, flags, options);
614 talloc_free(options);
616 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
621 static PyObject *py_ldb_modify(PyLdbObject *self, PyObject *args)
624 PyObject *py_controls = Py_None;
625 struct ldb_context *ldb_ctx;
626 struct ldb_request *req;
627 struct ldb_control **parsed_controls;
628 struct ldb_message *msg;
632 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls))
635 mem_ctx = talloc_new(NULL);
636 if (mem_ctx == NULL) {
640 ldb_ctx = PyLdb_AsLdbContext(self);
642 if (py_controls == Py_None) {
643 parsed_controls = NULL;
645 const char **controls = PyList_AsStringList(mem_ctx, py_controls, "controls");
646 parsed_controls = ldb_parse_control_strings(ldb_ctx, mem_ctx, controls);
647 talloc_free(controls);
650 if (!PyLdbMessage_Check(py_msg)) {
651 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message");
652 talloc_free(mem_ctx);
655 msg = PyLdbMessage_AsMessage(py_msg);
657 ret = ldb_msg_sanity_check(ldb_ctx, msg);
658 if (ret != LDB_SUCCESS) {
659 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
660 talloc_free(mem_ctx);
664 ret = ldb_build_mod_req(&req, ldb_ctx, mem_ctx, msg, parsed_controls,
665 NULL, ldb_op_default_callback, NULL);
666 if (ret != LDB_SUCCESS) {
667 PyErr_SetString(PyExc_TypeError, "failed to build request");
668 talloc_free(mem_ctx);
672 /* do request and autostart a transaction */
673 /* Then let's LDB handle the message error in case of pb as they are meaningful */
675 ret = ldb_transaction_start(ldb_ctx);
676 if (ret != LDB_SUCCESS) {
677 talloc_free(mem_ctx);
678 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
681 ret = ldb_request(ldb_ctx, req);
682 if (ret == LDB_SUCCESS) {
683 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
686 if (ret == LDB_SUCCESS) {
687 ret = ldb_transaction_commit(ldb_ctx);
689 ldb_transaction_cancel(ldb_ctx);
690 if (ldb_ctx->err_string == NULL) {
691 /* no error string was setup by the backend */
692 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
696 talloc_free(mem_ctx);
697 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
703 static PyObject *py_ldb_add(PyLdbObject *self, PyObject *args)
707 Py_ssize_t dict_pos, msg_pos;
708 struct ldb_message_element *msgel;
709 struct ldb_message *msg;
710 struct ldb_context *ldb_ctx;
711 struct ldb_request *req;
712 PyObject *key, *value;
713 PyObject *py_controls = Py_None;
715 struct ldb_control **parsed_controls;
717 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls ))
720 mem_ctx = talloc_new(NULL);
721 if (mem_ctx == NULL) {
725 ldb_ctx = PyLdb_AsLdbContext(self);
727 if (py_controls == Py_None) {
728 parsed_controls = NULL;
730 const char **controls = PyList_AsStringList(mem_ctx, py_controls, "controls");
731 parsed_controls = ldb_parse_control_strings(ldb_ctx, mem_ctx, controls);
732 talloc_free(controls);
734 if (PyDict_Check(py_msg)) {
735 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
736 msg = ldb_msg_new(mem_ctx);
737 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
738 msg_pos = dict_pos = 0;
740 if (!PyObject_AsDn(msg, dn_value, ldb_ctx, &msg->dn)) {
741 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
742 talloc_free(mem_ctx);
745 if (msg->dn == NULL) {
746 PyErr_SetString(PyExc_TypeError, "dn set but not found");
747 talloc_free(mem_ctx);
752 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
753 char *key_str = PyString_AsString(key);
754 if (strcmp(key_str, "dn") != 0) {
755 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
757 PyErr_SetString(PyExc_TypeError, "unable to import element");
758 talloc_free(mem_ctx);
761 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
766 if (msg->dn == NULL) {
767 PyErr_SetString(PyExc_TypeError, "no dn set");
768 talloc_free(mem_ctx);
772 msg->num_elements = msg_pos;
774 msg = PyLdbMessage_AsMessage(py_msg);
777 ret = ldb_msg_sanity_check(ldb_ctx, msg);
778 if (ret != LDB_SUCCESS) {
779 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
780 talloc_free(mem_ctx);
784 ret = ldb_build_add_req(&req, ldb_ctx, mem_ctx, msg, parsed_controls,
785 NULL, ldb_op_default_callback, NULL);
786 if (ret != LDB_SUCCESS) {
787 PyErr_SetString(PyExc_TypeError, "failed to build request");
788 talloc_free(mem_ctx);
792 /* do request and autostart a transaction */
793 /* Then let's LDB handle the message error in case of pb as they are meaningful */
795 ret = ldb_transaction_start(ldb_ctx);
796 if (ret != LDB_SUCCESS) {
797 talloc_free(mem_ctx);
798 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
801 ret = ldb_request(ldb_ctx, req);
802 if (ret == LDB_SUCCESS) {
803 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
806 if (ret == LDB_SUCCESS) {
807 ret = ldb_transaction_commit(ldb_ctx);
809 ldb_transaction_cancel(ldb_ctx);
810 if (ldb_ctx->err_string == NULL) {
811 /* no error string was setup by the backend */
812 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
816 talloc_free(mem_ctx);
817 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
822 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
827 struct ldb_context *ldb_ctx;
828 struct ldb_request *req;
829 PyObject *py_controls = Py_None;
831 struct ldb_control **parsed_controls;
833 if (!PyArg_ParseTuple(args, "O|O", &py_dn, &py_controls))
836 mem_ctx = talloc_new(NULL);
837 if (mem_ctx == NULL) {
841 ldb_ctx = PyLdb_AsLdbContext(self);
843 if (py_controls == Py_None) {
844 parsed_controls = NULL;
846 const char **controls = PyList_AsStringList(mem_ctx, py_controls, "controls");
847 parsed_controls = ldb_parse_control_strings(ldb_ctx, mem_ctx, controls);
848 talloc_free(controls);
851 if (!PyObject_AsDn(mem_ctx, py_dn, ldb_ctx, &dn)) {
852 talloc_free(mem_ctx);
856 ret = ldb_build_del_req(&req, ldb_ctx, mem_ctx, dn, parsed_controls,
857 NULL, ldb_op_default_callback, NULL);
858 if (ret != LDB_SUCCESS) {
859 PyErr_SetString(PyExc_TypeError, "failed to build request");
860 talloc_free(mem_ctx);
864 /* do request and autostart a transaction */
865 /* Then let's LDB handle the message error in case of pb as they are meaningful */
867 ret = ldb_transaction_start(ldb_ctx);
868 if (ret != LDB_SUCCESS) {
869 talloc_free(mem_ctx);
870 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
873 ret = ldb_request(ldb_ctx, req);
874 if (ret == LDB_SUCCESS) {
875 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
878 if (ret == LDB_SUCCESS) {
879 ret = ldb_transaction_commit(ldb_ctx);
881 ldb_transaction_cancel(ldb_ctx);
882 if (ldb_ctx->err_string == NULL) {
883 /* no error string was setup by the backend */
884 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
888 talloc_free(mem_ctx);
889 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
894 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
896 PyObject *py_dn1, *py_dn2;
897 struct ldb_dn *dn1, *dn2;
899 struct ldb_context *ldb;
902 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
905 mem_ctx = talloc_new(NULL);
906 if (mem_ctx == NULL) {
911 ldb = PyLdb_AsLdbContext(self);
913 if (!PyObject_AsDn(mem_ctx, py_dn1, ldb, &dn1)) {
914 talloc_free(mem_ctx);
918 if (!PyObject_AsDn(mem_ctx, py_dn2, ldb, &dn2)) {
919 talloc_free(mem_ctx);
923 ret = ldb_rename(ldb, dn1, dn2);
924 talloc_free(mem_ctx);
925 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
930 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
933 if (!PyArg_ParseTuple(args, "s", &name))
936 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
941 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
943 char *attribute, *syntax;
946 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
949 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
951 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
956 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
961 /* We don't want this attached to the 'ldb' any more */
962 return Py_BuildValue(discard_const_p(char, "(iO)"),
964 PyLdbMessage_FromMessage(ldif->msg));
969 static PyObject *py_ldb_write_ldif(PyLdbMessageObject *self, PyObject *args)
973 struct ldb_ldif ldif;
978 if (!PyArg_ParseTuple(args, "Oi", &py_msg, &changetype))
981 if (!PyLdbMessage_Check(py_msg)) {
982 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for msg");
986 ldif.msg = PyLdbMessage_AsMessage(py_msg);
987 ldif.changetype = changetype;
989 mem_ctx = talloc_new(NULL);
991 string = ldb_ldif_write_string(PyLdb_AsLdbContext(self), mem_ctx, &ldif);
993 PyErr_SetString(PyExc_KeyError, "Failed to generate LDIF");
997 ret = PyString_FromString(string);
999 talloc_free(mem_ctx);
1004 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
1007 struct ldb_ldif *ldif;
1010 TALLOC_CTX *mem_ctx;
1012 if (!PyArg_ParseTuple(args, "s", &s))
1015 mem_ctx = talloc_new(NULL);
1020 list = PyList_New(0);
1021 while (s && *s != '\0') {
1022 ldif = ldb_ldif_read_string(self->ldb_ctx, &s);
1023 talloc_steal(mem_ctx, ldif);
1025 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
1027 PyErr_SetString(PyExc_ValueError, "unable to parse ldif string");
1028 talloc_free(mem_ctx);
1032 talloc_free(mem_ctx); /* The pyobject already has a reference to the things it needs */
1033 return PyObject_GetIter(list);
1036 static PyObject *py_ldb_msg_diff(PyLdbObject *self, PyObject *args)
1039 PyObject *py_msg_old;
1040 PyObject *py_msg_new;
1041 struct ldb_message *diff;
1042 struct ldb_context *ldb;
1045 if (!PyArg_ParseTuple(args, "OO", &py_msg_old, &py_msg_new))
1048 if (!PyLdbMessage_Check(py_msg_old)) {
1049 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for old message");
1053 if (!PyLdbMessage_Check(py_msg_new)) {
1054 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for new message");
1058 ldb = PyLdb_AsLdbContext(self);
1059 ldb_ret = ldb_msg_diff_ex(ldb,
1060 PyLdbMessage_AsMessage(py_msg_old),
1061 PyLdbMessage_AsMessage(py_msg_new),
1062 (TALLOC_CTX*)ldb, &diff);
1063 if (ldb_ret != LDB_SUCCESS) {
1064 PyErr_SetString(PyExc_RuntimeError, "Failed to generate the Ldb Message diff");
1068 py_ret = PyLdbMessage_FromMessage(diff);
1070 talloc_unlink(ldb, diff);
1075 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
1077 const struct ldb_schema_attribute *a;
1078 struct ldb_val old_val;
1079 struct ldb_val new_val;
1080 TALLOC_CTX *mem_ctx;
1085 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
1088 mem_ctx = talloc_new(NULL);
1090 old_val.data = (uint8_t *)PyString_AsString(val);
1091 old_val.length = PyString_Size(val);
1093 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
1099 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
1100 talloc_free(mem_ctx);
1104 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
1106 talloc_free(mem_ctx);
1111 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
1113 PyObject *py_base = Py_None;
1114 int scope = LDB_SCOPE_DEFAULT;
1116 PyObject *py_attrs = Py_None;
1117 PyObject *py_controls = Py_None;
1118 const char * const kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
1120 struct ldb_result *res;
1121 struct ldb_request *req;
1123 struct ldb_context *ldb_ctx;
1124 struct ldb_control **parsed_controls;
1125 struct ldb_dn *base;
1127 TALLOC_CTX *mem_ctx;
1129 /* type "int" rather than "enum" for "scope" is intentional */
1130 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO",
1131 discard_const_p(char *, kwnames),
1132 &py_base, &scope, &expr, &py_attrs, &py_controls))
1136 mem_ctx = talloc_new(NULL);
1137 if (mem_ctx == NULL) {
1141 ldb_ctx = PyLdb_AsLdbContext(self);
1143 if (py_attrs == Py_None) {
1146 attrs = PyList_AsStringList(mem_ctx, py_attrs, "attrs");
1147 if (attrs == NULL) {
1148 talloc_free(mem_ctx);
1153 if (py_base == Py_None) {
1154 base = ldb_get_default_basedn(ldb_ctx);
1156 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base)) {
1162 if (py_controls == Py_None) {
1163 parsed_controls = NULL;
1165 const char **controls = PyList_AsStringList(mem_ctx, py_controls, "controls");
1166 parsed_controls = ldb_parse_control_strings(ldb_ctx, mem_ctx, controls);
1167 talloc_free(controls);
1170 res = talloc_zero(mem_ctx, struct ldb_result);
1173 talloc_free(mem_ctx);
1177 ret = ldb_build_search_req(&req, ldb_ctx, mem_ctx,
1184 ldb_search_default_callback,
1187 talloc_steal(req, attrs);
1189 if (ret != LDB_SUCCESS) {
1190 talloc_free(mem_ctx);
1191 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1195 ret = ldb_request(ldb_ctx, req);
1197 if (ret == LDB_SUCCESS) {
1198 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1201 if (ret != LDB_SUCCESS) {
1202 talloc_free(mem_ctx);
1203 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1207 py_ret = PyLdbResult_FromResult(res);
1209 talloc_free(mem_ctx);
1214 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
1219 if (!PyArg_ParseTuple(args, "s", &name))
1222 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
1227 /* FIXME: More interpretation */
1232 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
1237 if (!PyArg_ParseTuple(args, "sO", &name, &data))
1240 /* FIXME: More interpretation */
1242 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
1247 static PyObject *py_ldb_modules(PyLdbObject *self)
1249 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
1250 PyObject *ret = PyList_New(0);
1251 struct ldb_module *mod;
1253 for (mod = ldb->modules; mod; mod = mod->next) {
1254 PyList_Append(ret, PyLdbModule_FromModule(mod));
1260 static PyMethodDef py_ldb_methods[] = {
1261 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
1262 "S.set_debug(callback) -> None\n"
1263 "Set callback for LDB debug messages.\n"
1264 "The callback should accept a debug level and debug text." },
1265 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
1266 "S.set_create_perms(mode) -> None\n"
1267 "Set mode to use when creating new LDB files." },
1268 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
1269 "S.set_modules_dir(path) -> None\n"
1270 "Set path LDB should search for modules" },
1271 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
1272 "S.transaction_start() -> None\n"
1273 "Start a new transaction." },
1274 { "transaction_prepare_commit", (PyCFunction)py_ldb_transaction_prepare_commit, METH_NOARGS,
1275 "S.transaction_prepare_commit() -> None\n"
1276 "prepare to commit a new transaction (2-stage commit)." },
1277 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
1278 "S.transaction_commit() -> None\n"
1279 "commit a new transaction." },
1280 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
1281 "S.transaction_cancel() -> None\n"
1282 "cancel a new transaction." },
1283 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
1285 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
1287 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
1289 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
1291 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
1293 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
1294 "S.connect(url, flags=0, options=None) -> None\n"
1295 "Connect to a LDB URL." },
1296 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
1297 "S.modify(message) -> None\n"
1298 "Modify an entry." },
1299 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
1300 "S.add(message) -> None\n"
1302 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
1303 "S.delete(dn) -> None\n"
1304 "Remove an entry." },
1305 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
1306 "S.rename(old_dn, new_dn) -> None\n"
1307 "Rename an entry." },
1308 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
1309 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
1310 "Search in a database.\n"
1312 ":param base: Optional base DN to search\n"
1313 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
1314 ":param expression: Optional search expression\n"
1315 ":param attrs: Attributes to return (defaults to all)\n"
1316 ":param controls: Optional list of controls\n"
1317 ":return: Iterator over Message objects\n"
1319 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
1321 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
1323 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
1325 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
1326 "S.parse_ldif(ldif) -> iter(messages)\n"
1327 "Parse a string formatted using LDIF." },
1328 { "write_ldif", (PyCFunction)py_ldb_write_ldif, METH_VARARGS,
1329 "S.write_ldif(message, changetype) -> ldif\n"
1330 "Print the message as a string formatted using LDIF." },
1331 { "msg_diff", (PyCFunction)py_ldb_msg_diff, METH_VARARGS,
1332 "S.msg_diff(Message) -> Message\n"
1333 "Return an LDB Message of the difference between two Message objects." },
1334 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
1335 "S.get_opaque(name) -> value\n"
1336 "Get an opaque value set on this LDB connection. \n"
1337 ":note: The returned value may not be useful in Python."
1339 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
1340 "S.set_opaque(name, value) -> None\n"
1341 "Set an opaque value on this LDB connection. \n"
1342 ":note: Passing incorrect values may cause crashes." },
1343 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
1344 "S.modules() -> list\n"
1345 "Return the list of modules on this LDB connection " },
1349 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
1351 PyLdbModuleObject *ret;
1353 ret = (PyLdbModuleObject *)PyLdbModule.tp_alloc(&PyLdbModule, 0);
1358 ret->mem_ctx = talloc_new(NULL);
1359 ret->mod = talloc_reference(ret->mem_ctx, mod);
1360 return (PyObject *)ret;
1363 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
1365 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
1368 static PyGetSetDef py_ldb_getset[] = {
1369 { discard_const_p(char, "firstmodule"), (getter)py_ldb_get_firstmodule, NULL, NULL },
1373 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
1375 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
1377 struct ldb_result *result;
1381 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
1384 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
1385 if (ret != LDB_SUCCESS) {
1386 PyErr_SetLdbError(PyExc_LdbError, ret, ldb_ctx);
1390 count = result->count;
1392 talloc_free(result);
1397 static PySequenceMethods py_ldb_seq = {
1398 .sq_contains = (objobjproc)py_ldb_contains,
1401 static PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
1405 ret = (PyLdbObject *)PyLdb.tp_alloc(&PyLdb, 0);
1410 ret->mem_ctx = talloc_new(NULL);
1411 ret->ldb_ctx = talloc_reference(ret->mem_ctx, ldb_ctx);
1412 return (PyObject *)ret;
1415 static void py_ldb_dealloc(PyLdbObject *self)
1417 talloc_free(self->mem_ctx);
1418 self->ob_type->tp_free(self);
1421 PyTypeObject PyLdb = {
1422 .tp_name = "ldb.Ldb",
1423 .tp_methods = py_ldb_methods,
1424 .tp_repr = (reprfunc)py_ldb_repr,
1425 .tp_new = py_ldb_new,
1426 .tp_init = (initproc)py_ldb_init,
1427 .tp_dealloc = (destructor)py_ldb_dealloc,
1428 .tp_getset = py_ldb_getset,
1429 .tp_getattro = PyObject_GenericGetAttr,
1430 .tp_basicsize = sizeof(PyLdbObject),
1431 .tp_doc = "Connection to a LDB database.",
1432 .tp_as_sequence = &py_ldb_seq,
1433 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1436 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1438 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1441 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1443 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1446 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1448 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1452 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1454 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1458 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1460 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1464 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1466 PyObject *py_base, *py_tree, *py_attrs, *py_ret;
1468 struct ldb_request *req;
1469 const char * const kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1470 struct ldb_module *mod;
1471 const char * const*attrs;
1473 /* type "int" rather than "enum" for "scope" is intentional */
1474 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO",
1475 discard_const_p(char *, kwnames),
1476 &py_base, &scope, &py_tree, &py_attrs))
1481 if (py_attrs == Py_None) {
1484 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1489 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1490 scope, NULL /* expr */, attrs,
1491 NULL /* controls */, NULL, NULL, NULL);
1493 talloc_steal(req, attrs);
1495 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1497 req->op.search.res = NULL;
1499 ret = mod->ops->search(mod, req);
1501 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1503 py_ret = PyLdbResult_FromResult(req->op.search.res);
1511 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1513 struct ldb_request *req;
1514 PyObject *py_message;
1516 struct ldb_module *mod;
1518 if (!PyArg_ParseTuple(args, "O", &py_message))
1521 req = talloc_zero(NULL, struct ldb_request);
1522 req->operation = LDB_ADD;
1523 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1525 mod = PyLdbModule_AsModule(self);
1526 ret = mod->ops->add(mod, req);
1528 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1533 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1536 struct ldb_request *req;
1537 PyObject *py_message;
1538 struct ldb_module *mod;
1540 if (!PyArg_ParseTuple(args, "O", &py_message))
1543 req = talloc_zero(NULL, struct ldb_request);
1544 req->operation = LDB_MODIFY;
1545 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1547 mod = PyLdbModule_AsModule(self);
1548 ret = mod->ops->modify(mod, req);
1550 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1555 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1558 struct ldb_request *req;
1561 if (!PyArg_ParseTuple(args, "O", &py_dn))
1564 req = talloc_zero(NULL, struct ldb_request);
1565 req->operation = LDB_DELETE;
1566 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1568 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1570 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1575 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1578 struct ldb_request *req;
1579 PyObject *py_dn1, *py_dn2;
1581 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1584 req = talloc_zero(NULL, struct ldb_request);
1586 req->operation = LDB_RENAME;
1587 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1588 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1590 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1592 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1597 static PyMethodDef py_ldb_module_methods[] = {
1598 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1599 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1600 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1601 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1602 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1603 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1604 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1605 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1609 static void py_ldb_module_dealloc(PyLdbModuleObject *self)
1611 talloc_free(self->mem_ctx);
1612 self->ob_type->tp_free(self);
1615 PyTypeObject PyLdbModule = {
1616 .tp_name = "ldb.LdbModule",
1617 .tp_methods = py_ldb_module_methods,
1618 .tp_repr = (reprfunc)py_ldb_module_repr,
1619 .tp_str = (reprfunc)py_ldb_module_str,
1620 .tp_basicsize = sizeof(PyLdbModuleObject),
1621 .tp_dealloc = (destructor)py_ldb_module_dealloc,
1622 .tp_flags = Py_TPFLAGS_DEFAULT,
1627 * Create a ldb_message_element from a Python object.
1629 * This will accept any sequence objects that contains strings, or
1632 * A reference to set_obj will be borrowed.
1634 * @param mem_ctx Memory context
1635 * @param set_obj Python object to convert
1636 * @param flags ldb_message_element flags to set
1637 * @param attr_name Name of the attribute
1638 * @return New ldb_message_element, allocated as child of mem_ctx
1640 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1641 PyObject *set_obj, int flags,
1642 const char *attr_name)
1644 struct ldb_message_element *me;
1646 if (PyLdbMessageElement_Check(set_obj))
1647 return talloc_reference(mem_ctx,
1648 PyLdbMessageElement_AsMessageElement(set_obj));
1650 me = talloc(mem_ctx, struct ldb_message_element);
1652 me->name = talloc_strdup(me, attr_name);
1654 if (PyString_Check(set_obj)) {
1656 me->values = talloc_array(me, struct ldb_val, me->num_values);
1657 me->values[0].length = PyString_Size(set_obj);
1658 me->values[0].data = talloc_memdup(me,
1659 (uint8_t *)PyString_AsString(set_obj), me->values[0].length+1);
1660 } else if (PySequence_Check(set_obj)) {
1662 me->num_values = PySequence_Size(set_obj);
1663 me->values = talloc_array(me, struct ldb_val, me->num_values);
1664 for (i = 0; i < me->num_values; i++) {
1665 PyObject *obj = PySequence_GetItem(set_obj, i);
1667 me->values[i].length = PyString_Size(obj);
1668 me->values[i].data = talloc_memdup(me,
1669 (uint8_t *)PyString_AsString(obj), me->values[i].length+1);
1680 static PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1681 struct ldb_message_element *me)
1686 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1687 result = PyList_New(me->num_values);
1689 for (i = 0; i < me->num_values; i++) {
1690 PyList_SetItem(result, i,
1691 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1697 static PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1700 if (!PyArg_ParseTuple(args, "i", &i))
1702 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1705 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1706 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1709 static PyObject *py_ldb_msg_element_flags(PyLdbMessageElementObject *self, PyObject *args)
1711 struct ldb_message_element *el;
1713 el = PyLdbMessageElement_AsMessageElement(self);
1714 return PyInt_FromLong(el->flags);
1717 static PyObject *py_ldb_msg_element_set_flags(PyLdbMessageElementObject *self, PyObject *args)
1720 struct ldb_message_element *el;
1721 if (!PyArg_ParseTuple(args, "i", &flags))
1724 el = PyLdbMessageElement_AsMessageElement(self);
1729 static PyMethodDef py_ldb_msg_element_methods[] = {
1730 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1731 { "set_flags", (PyCFunction)py_ldb_msg_element_set_flags, METH_VARARGS, NULL },
1732 { "flags", (PyCFunction)py_ldb_msg_element_flags, METH_NOARGS, NULL },
1736 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1738 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1741 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1743 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1744 if (idx < 0 || idx >= el->num_values) {
1745 PyErr_SetString(PyExc_IndexError, "Out of range");
1748 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1751 static PySequenceMethods py_ldb_msg_element_seq = {
1752 .sq_length = (lenfunc)py_ldb_msg_element_len,
1753 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1756 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1758 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1759 PyLdbMessageElement_AsMessageElement(other));
1762 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1764 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1767 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el, TALLOC_CTX *mem_ctx)
1769 PyLdbMessageElementObject *ret;
1770 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1775 ret->mem_ctx = talloc_new(NULL);
1776 if (talloc_reference(ret->mem_ctx, mem_ctx) == NULL) {
1781 return (PyObject *)ret;
1784 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1786 PyObject *py_elements = NULL;
1787 struct ldb_message_element *el;
1790 const char * const kwnames[] = { "elements", "flags", "name", NULL };
1791 PyLdbMessageElementObject *ret;
1792 TALLOC_CTX *mem_ctx;
1794 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois",
1795 discard_const_p(char *, kwnames),
1796 &py_elements, &flags, &name))
1799 mem_ctx = talloc_new(NULL);
1800 if (mem_ctx == NULL) {
1805 el = talloc_zero(mem_ctx, struct ldb_message_element);
1807 if (py_elements != NULL) {
1809 if (PyString_Check(py_elements)) {
1811 el->values = talloc_array(el, struct ldb_val, 1);
1812 el->values[0].length = PyString_Size(py_elements);
1813 el->values[0].data = talloc_memdup(el,
1814 (uint8_t *)PyString_AsString(py_elements), el->values[0].length+1);
1815 } else if (PySequence_Check(py_elements)) {
1816 el->num_values = PySequence_Size(py_elements);
1817 el->values = talloc_array(el, struct ldb_val, el->num_values);
1818 for (i = 0; i < el->num_values; i++) {
1819 PyObject *item = PySequence_GetItem(py_elements, i);
1820 if (!PyString_Check(item)) {
1821 PyErr_Format(PyExc_TypeError,
1822 "Expected string as element %d in list",
1824 talloc_free(mem_ctx);
1827 el->values[i].length = PyString_Size(item);
1828 el->values[i].data = talloc_memdup(el,
1829 (uint8_t *)PyString_AsString(item), el->values[i].length+1);
1832 PyErr_SetString(PyExc_TypeError,
1833 "Expected string or list");
1834 talloc_free(mem_ctx);
1840 el->name = talloc_strdup(el, name);
1842 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1845 talloc_free(mem_ctx);
1849 ret->mem_ctx = mem_ctx;
1851 return (PyObject *)ret;
1854 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1856 char *element_str = NULL;
1858 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1861 for (i = 0; i < el->num_values; i++) {
1862 PyObject *o = py_ldb_msg_element_find(self, i);
1863 if (element_str == NULL)
1864 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1866 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1869 if (element_str != NULL) {
1870 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1871 talloc_free(element_str);
1873 ret = PyString_FromString("MessageElement([])");
1879 static PyObject *py_ldb_msg_element_str(PyLdbMessageElementObject *self)
1881 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1883 if (el->num_values == 1)
1884 return PyString_FromStringAndSize((char *)el->values[0].data, el->values[0].length);
1889 static void py_ldb_msg_element_dealloc(PyLdbMessageElementObject *self)
1891 talloc_free(self->mem_ctx);
1892 self->ob_type->tp_free(self);
1895 PyTypeObject PyLdbMessageElement = {
1896 .tp_name = "ldb.MessageElement",
1897 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1898 .tp_dealloc = (destructor)py_ldb_msg_element_dealloc,
1899 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1900 .tp_str = (reprfunc)py_ldb_msg_element_str,
1901 .tp_methods = py_ldb_msg_element_methods,
1902 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1903 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1904 .tp_as_sequence = &py_ldb_msg_element_seq,
1905 .tp_new = py_ldb_msg_element_new,
1906 .tp_flags = Py_TPFLAGS_DEFAULT,
1909 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1912 if (!PyArg_ParseTuple(args, "s", &name))
1915 ldb_msg_remove_attr(self->msg, name);
1920 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1922 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1924 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1925 if (msg->dn != NULL) {
1926 PyList_SetItem(obj, j, PyString_FromString("dn"));
1929 for (i = 0; i < msg->num_elements; i++) {
1930 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1936 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1938 struct ldb_message_element *el;
1940 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1941 if (!PyString_Check(py_name)) {
1942 PyErr_SetNone(PyExc_TypeError);
1945 name = PyString_AsString(py_name);
1946 if (!strcmp(name, "dn"))
1947 return PyLdbDn_FromDn(msg->dn);
1948 el = ldb_msg_find_element(msg, name);
1952 return (PyObject *)PyLdbMessageElement_FromMessageElement(el, msg);
1955 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1957 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1959 PyErr_SetString(PyExc_KeyError, "No such element");
1965 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1967 PyObject *name, *ret;
1968 if (!PyArg_ParseTuple(args, "O", &name))
1971 ret = py_ldb_msg_getitem_helper(self, name);
1973 if (PyErr_Occurred())
1980 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1982 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1984 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1986 if (msg->dn != NULL) {
1987 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1990 for (i = 0; i < msg->num_elements; i++, j++) {
1991 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i], self->msg)));
1996 static PyMethodDef py_ldb_msg_methods[] = {
1997 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1998 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1999 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
2000 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
2004 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
2006 PyObject *list, *iter;
2008 list = py_ldb_msg_keys(self);
2009 iter = PyObject_GetIter(list);
2014 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
2018 if (!PyString_Check(name)) {
2019 PyErr_SetNone(PyExc_TypeError);
2023 attr_name = PyString_AsString(name);
2024 if (value == NULL) {
2026 ldb_msg_remove_attr(self->msg, attr_name);
2028 struct ldb_message_element *el = PyObject_AsMessageElement(self->msg,
2029 value, 0, attr_name);
2032 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
2033 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
2038 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
2040 return PyLdbMessage_AsMessage(self)->num_elements;
2043 static PyMappingMethods py_ldb_msg_mapping = {
2044 .mp_length = (lenfunc)py_ldb_msg_length,
2045 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
2046 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
2049 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
2051 const char * const kwnames[] = { "dn", NULL };
2052 struct ldb_message *ret;
2053 TALLOC_CTX *mem_ctx;
2054 PyObject *pydn = NULL;
2055 PyLdbMessageObject *py_ret;
2057 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O",
2058 discard_const_p(char *, kwnames),
2062 mem_ctx = talloc_new(NULL);
2063 if (mem_ctx == NULL) {
2068 ret = ldb_msg_new(mem_ctx);
2070 talloc_free(mem_ctx);
2077 if (!PyObject_AsDn(NULL, pydn, NULL, &dn)) {
2078 talloc_free(mem_ctx);
2081 ret->dn = talloc_reference(ret, dn);
2084 py_ret = (PyLdbMessageObject *)type->tp_alloc(type, 0);
2085 if (py_ret == NULL) {
2087 talloc_free(mem_ctx);
2091 py_ret->mem_ctx = mem_ctx;
2093 return (PyObject *)py_ret;
2096 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
2098 PyLdbMessageObject *ret;
2100 ret = (PyLdbMessageObject *)PyLdbMessage.tp_alloc(&PyLdbMessage, 0);
2105 ret->mem_ctx = talloc_new(NULL);
2106 ret->msg = talloc_reference(ret->mem_ctx, msg);
2107 return (PyObject *)ret;
2110 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
2112 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2113 return PyLdbDn_FromDn(msg->dn);
2116 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
2118 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2119 if (!PyLdbDn_Check(value)) {
2120 PyErr_SetNone(PyExc_TypeError);
2124 msg->dn = talloc_reference(msg, PyLdbDn_AsDn(value));
2128 static PyGetSetDef py_ldb_msg_getset[] = {
2129 { discard_const_p(char, "dn"), (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
2133 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
2135 PyObject *dict = PyDict_New(), *ret;
2136 if (PyDict_Update(dict, (PyObject *)self) != 0)
2138 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
2143 static void py_ldb_msg_dealloc(PyLdbMessageObject *self)
2145 talloc_free(self->mem_ctx);
2146 self->ob_type->tp_free(self);
2149 static int py_ldb_msg_compare(PyLdbMessageObject *py_msg1,
2150 PyLdbMessageObject *py_msg2)
2152 struct ldb_message *msg1 = PyLdbMessage_AsMessage(py_msg1),
2153 *msg2 = PyLdbMessage_AsMessage(py_msg2);
2157 if ((msg1->dn != NULL) || (msg2->dn != NULL)) {
2158 ret = ldb_dn_compare(msg1->dn, msg2->dn);
2164 ret = msg1->num_elements - msg2->num_elements;
2169 for (i = 0; i < msg1->num_elements; i++) {
2170 ret = ldb_msg_element_compare_name(&msg1->elements[i],
2171 &msg2->elements[i]);
2176 ret = ldb_msg_element_compare(&msg1->elements[i],
2177 &msg2->elements[i]);
2186 PyTypeObject PyLdbMessage = {
2187 .tp_name = "ldb.Message",
2188 .tp_methods = py_ldb_msg_methods,
2189 .tp_getset = py_ldb_msg_getset,
2190 .tp_as_mapping = &py_ldb_msg_mapping,
2191 .tp_basicsize = sizeof(PyLdbMessageObject),
2192 .tp_dealloc = (destructor)py_ldb_msg_dealloc,
2193 .tp_new = py_ldb_msg_new,
2194 .tp_repr = (reprfunc)py_ldb_msg_repr,
2195 .tp_flags = Py_TPFLAGS_DEFAULT,
2196 .tp_iter = (getiterfunc)py_ldb_msg_iter,
2197 .tp_compare = (cmpfunc)py_ldb_msg_compare,
2200 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
2202 PyLdbTreeObject *ret;
2204 ret = (PyLdbTreeObject *)PyLdbTree.tp_alloc(&PyLdbTree, 0);
2210 ret->mem_ctx = talloc_new(NULL);
2211 ret->tree = talloc_reference(ret->mem_ctx, tree);
2212 return (PyObject *)ret;
2215 static void py_ldb_tree_dealloc(PyLdbTreeObject *self)
2217 talloc_free(self->mem_ctx);
2218 self->ob_type->tp_free(self);
2221 PyTypeObject PyLdbTree = {
2222 .tp_name = "ldb.Tree",
2223 .tp_basicsize = sizeof(PyLdbTreeObject),
2224 .tp_dealloc = (destructor)py_ldb_tree_dealloc,
2225 .tp_flags = Py_TPFLAGS_DEFAULT,
2229 static int py_module_search(struct ldb_module *mod, struct ldb_request *req)
2231 PyObject *py_ldb = (PyObject *)mod->private_data;
2232 PyObject *py_result, *py_base, *py_attrs, *py_tree;
2234 py_base = PyLdbDn_FromDn(req->op.search.base);
2236 if (py_base == NULL)
2237 return LDB_ERR_OPERATIONS_ERROR;
2239 py_tree = PyLdbTree_FromTree(req->op.search.tree);
2241 if (py_tree == NULL)
2242 return LDB_ERR_OPERATIONS_ERROR;
2244 if (req->op.search.attrs == NULL) {
2248 for (len = 0; req->op.search.attrs[len]; len++);
2249 py_attrs = PyList_New(len);
2250 for (i = 0; i < len; i++)
2251 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
2254 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "search"),
2255 discard_const_p(char, "OiOO"),
2256 py_base, req->op.search.scope, py_tree, py_attrs);
2258 Py_DECREF(py_attrs);
2262 if (py_result == NULL) {
2263 return LDB_ERR_PYTHON_EXCEPTION;
2266 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
2267 if (req->op.search.res == NULL) {
2268 return LDB_ERR_PYTHON_EXCEPTION;
2271 Py_DECREF(py_result);
2276 static int py_module_add(struct ldb_module *mod, struct ldb_request *req)
2278 PyObject *py_ldb = (PyObject *)mod->private_data;
2279 PyObject *py_result, *py_msg;
2281 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.add.message));
2283 if (py_msg == NULL) {
2284 return LDB_ERR_OPERATIONS_ERROR;
2287 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "add"),
2288 discard_const_p(char, "O"),
2293 if (py_result == NULL) {
2294 return LDB_ERR_PYTHON_EXCEPTION;
2297 Py_DECREF(py_result);
2302 static int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
2304 PyObject *py_ldb = (PyObject *)mod->private_data;
2305 PyObject *py_result, *py_msg;
2307 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.mod.message));
2309 if (py_msg == NULL) {
2310 return LDB_ERR_OPERATIONS_ERROR;
2313 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "modify"),
2314 discard_const_p(char, "O"),
2319 if (py_result == NULL) {
2320 return LDB_ERR_PYTHON_EXCEPTION;
2323 Py_DECREF(py_result);
2328 static int py_module_del(struct ldb_module *mod, struct ldb_request *req)
2330 PyObject *py_ldb = (PyObject *)mod->private_data;
2331 PyObject *py_result, *py_dn;
2333 py_dn = PyLdbDn_FromDn(req->op.del.dn);
2336 return LDB_ERR_OPERATIONS_ERROR;
2338 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "delete"),
2339 discard_const_p(char, "O"),
2342 if (py_result == NULL) {
2343 return LDB_ERR_PYTHON_EXCEPTION;
2346 Py_DECREF(py_result);
2351 static int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
2353 PyObject *py_ldb = (PyObject *)mod->private_data;
2354 PyObject *py_result, *py_olddn, *py_newdn;
2356 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
2358 if (py_olddn == NULL)
2359 return LDB_ERR_OPERATIONS_ERROR;
2361 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
2363 if (py_newdn == NULL)
2364 return LDB_ERR_OPERATIONS_ERROR;
2366 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "rename"),
2367 discard_const_p(char, "OO"),
2368 py_olddn, py_newdn);
2370 Py_DECREF(py_olddn);
2371 Py_DECREF(py_newdn);
2373 if (py_result == NULL) {
2374 return LDB_ERR_PYTHON_EXCEPTION;
2377 Py_DECREF(py_result);
2382 static int py_module_request(struct ldb_module *mod, struct ldb_request *req)
2384 PyObject *py_ldb = (PyObject *)mod->private_data;
2385 PyObject *py_result;
2387 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "request"),
2388 discard_const_p(char, ""));
2390 return LDB_ERR_OPERATIONS_ERROR;
2393 static int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
2395 PyObject *py_ldb = (PyObject *)mod->private_data;
2396 PyObject *py_result;
2398 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "extended"),
2399 discard_const_p(char, ""));
2401 return LDB_ERR_OPERATIONS_ERROR;
2404 static int py_module_start_transaction(struct ldb_module *mod)
2406 PyObject *py_ldb = (PyObject *)mod->private_data;
2407 PyObject *py_result;
2409 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "start_transaction"),
2410 discard_const_p(char, ""));
2412 if (py_result == NULL) {
2413 return LDB_ERR_PYTHON_EXCEPTION;
2416 Py_DECREF(py_result);
2421 static int py_module_end_transaction(struct ldb_module *mod)
2423 PyObject *py_ldb = (PyObject *)mod->private_data;
2424 PyObject *py_result;
2426 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "end_transaction"),
2427 discard_const_p(char, ""));
2429 if (py_result == NULL) {
2430 return LDB_ERR_PYTHON_EXCEPTION;
2433 Py_DECREF(py_result);
2438 static int py_module_del_transaction(struct ldb_module *mod)
2440 PyObject *py_ldb = (PyObject *)mod->private_data;
2441 PyObject *py_result;
2443 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "del_transaction"),
2444 discard_const_p(char, ""));
2446 if (py_result == NULL) {
2447 return LDB_ERR_PYTHON_EXCEPTION;
2450 Py_DECREF(py_result);
2455 static int py_module_destructor(struct ldb_module *mod)
2457 Py_DECREF((PyObject *)mod->private_data);
2461 static int py_module_init(struct ldb_module *mod)
2463 PyObject *py_class = (PyObject *)mod->ops->private_data;
2464 PyObject *py_result, *py_next, *py_ldb;
2466 py_ldb = PyLdb_FromLdbContext(mod->ldb);
2469 return LDB_ERR_OPERATIONS_ERROR;
2471 py_next = PyLdbModule_FromModule(mod->next);
2473 if (py_next == NULL)
2474 return LDB_ERR_OPERATIONS_ERROR;
2476 py_result = PyObject_CallFunction(py_class, discard_const_p(char, "OO"),
2479 if (py_result == NULL) {
2480 return LDB_ERR_PYTHON_EXCEPTION;
2483 mod->private_data = py_result;
2485 talloc_set_destructor(mod, py_module_destructor);
2487 return ldb_next_init(mod);
2490 static PyObject *py_register_module(PyObject *module, PyObject *args)
2493 struct ldb_module_ops *ops;
2496 if (!PyArg_ParseTuple(args, "O", &input))
2499 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
2505 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, discard_const_p(char, "name"))));
2508 ops->private_data = input;
2509 ops->init_context = py_module_init;
2510 ops->search = py_module_search;
2511 ops->add = py_module_add;
2512 ops->modify = py_module_modify;
2513 ops->del = py_module_del;
2514 ops->rename = py_module_rename;
2515 ops->request = py_module_request;
2516 ops->extended = py_module_extended;
2517 ops->start_transaction = py_module_start_transaction;
2518 ops->end_transaction = py_module_end_transaction;
2519 ops->del_transaction = py_module_del_transaction;
2521 ret = ldb_register_module(ops);
2523 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
2528 static PyObject *py_timestring(PyObject *module, PyObject *args)
2534 if (!PyArg_ParseTuple(args, "l", &val))
2537 tresult = ldb_timestring(NULL, t);
2538 ret = PyString_FromString(tresult);
2539 talloc_free(tresult);
2543 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
2546 if (!PyArg_ParseTuple(args, "s", &str))
2549 return PyInt_FromLong(ldb_string_to_time(str));
2552 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
2555 if (!PyArg_ParseTuple(args, "s", &name))
2557 return PyBool_FromLong(ldb_valid_attr_name(name));
2560 static PyMethodDef py_ldb_global_methods[] = {
2561 { "register_module", py_register_module, METH_VARARGS,
2562 "S.register_module(module) -> None\n"
2563 "Register a LDB module."},
2564 { "timestring", py_timestring, METH_VARARGS,
2565 "S.timestring(int) -> string\n"
2566 "Generate a LDAP time string from a UNIX timestamp" },
2567 { "string_to_time", py_string_to_time, METH_VARARGS,
2568 "S.string_to_time(string) -> int\n"
2569 "Parse a LDAP time string into a UNIX timestamp." },
2570 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
2571 "S.valid_attr_name(name) -> bool\n"
2572 "Check whether the supplied name is a valid attribute name." },
2573 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
2582 if (PyType_Ready(&PyLdbDn) < 0)
2585 if (PyType_Ready(&PyLdbMessage) < 0)
2588 if (PyType_Ready(&PyLdbMessageElement) < 0)
2591 if (PyType_Ready(&PyLdb) < 0)
2594 if (PyType_Ready(&PyLdbModule) < 0)
2597 if (PyType_Ready(&PyLdbTree) < 0)
2600 m = Py_InitModule3("ldb", py_ldb_global_methods,
2601 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
2605 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
2606 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
2607 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
2608 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
2610 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
2611 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
2612 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
2613 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
2615 PyModule_AddObject(m, "FLAG_MOD_ADD", PyInt_FromLong(LDB_FLAG_MOD_ADD));
2616 PyModule_AddObject(m, "FLAG_MOD_REPLACE", PyInt_FromLong(LDB_FLAG_MOD_REPLACE));
2617 PyModule_AddObject(m, "FLAG_MOD_DELETE", PyInt_FromLong(LDB_FLAG_MOD_DELETE));
2619 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
2620 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
2621 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
2622 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
2623 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
2624 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
2625 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
2626 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
2627 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
2628 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
2629 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
2630 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
2631 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
2632 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
2633 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
2634 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
2635 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
2636 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
2637 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
2638 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
2639 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
2640 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
2641 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
2642 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
2643 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
2644 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
2645 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
2646 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
2647 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
2648 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
2649 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
2650 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
2651 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
2652 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
2653 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
2654 PyModule_AddObject(m, "ERR_ENTRY_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
2655 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
2656 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
2657 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
2659 PyModule_AddObject(m, "FLG_RDONLY", PyInt_FromLong(LDB_FLG_RDONLY));
2660 PyModule_AddObject(m, "FLG_NOSYNC", PyInt_FromLong(LDB_FLG_NOSYNC));
2661 PyModule_AddObject(m, "FLG_RECONNECT", PyInt_FromLong(LDB_FLG_RECONNECT));
2662 PyModule_AddObject(m, "FLG_NOMMAP", PyInt_FromLong(LDB_FLG_NOMMAP));
2664 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
2666 PyExc_LdbError = PyErr_NewException(discard_const_p(char, "_ldb.LdbError"), NULL, NULL);
2667 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
2670 Py_INCREF(&PyLdbDn);
2671 Py_INCREF(&PyLdbModule);
2672 Py_INCREF(&PyLdbMessage);
2673 Py_INCREF(&PyLdbMessageElement);
2674 Py_INCREF(&PyLdbTree);
2676 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
2677 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
2678 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
2679 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
2680 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
2681 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);