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;
630 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls))
633 ldb_ctx = PyLdb_AsLdbContext(self);
635 if (py_controls == Py_None) {
636 parsed_controls = NULL;
638 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
639 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
640 talloc_free(controls);
643 if (!PyLdbMessage_Check(py_msg)) {
644 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message");
647 msg = PyLdbMessage_AsMessage(py_msg);
649 ret = ldb_msg_sanity_check(ldb_ctx, msg);
650 if (ret != LDB_SUCCESS) {
651 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
655 ret = ldb_build_mod_req(&req, ldb_ctx, ldb_ctx,
659 ldb_op_default_callback,
662 if (ret != LDB_SUCCESS) {
663 PyErr_SetString(PyExc_TypeError, "failed to build request");
667 /* do request and autostart a transaction */
668 /* Then let's LDB handle the message error in case of pb as they are meaningful */
670 ret = ldb_transaction_start(ldb_ctx);
671 if (ret != LDB_SUCCESS) {
673 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
676 ret = ldb_request(ldb_ctx, req);
677 if (ret == LDB_SUCCESS) {
678 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
681 if (ret == LDB_SUCCESS) {
682 ret = ldb_transaction_commit(ldb_ctx);
684 ldb_transaction_cancel(ldb_ctx);
685 if (ldb_ctx->err_string == NULL) {
686 /* no error string was setup by the backend */
687 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
691 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
697 static PyObject *py_ldb_add(PyLdbObject *self, PyObject *args)
701 Py_ssize_t dict_pos, msg_pos;
702 struct ldb_message_element *msgel;
703 struct ldb_message *msg;
704 struct ldb_context *ldb_ctx;
705 struct ldb_request *req;
706 PyObject *key, *value;
707 PyObject *py_controls = Py_None;
709 struct ldb_control **parsed_controls;
711 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls ))
713 ldb_ctx = PyLdb_AsLdbContext(self);
715 mem_ctx = talloc_new(NULL);
716 if (py_controls == Py_None) {
717 parsed_controls = NULL;
719 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
720 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
721 talloc_free(controls);
723 if (PyDict_Check(py_msg)) {
724 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
725 msg = ldb_msg_new(mem_ctx);
726 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
727 msg_pos = dict_pos = 0;
729 if (!PyObject_AsDn(msg, dn_value, ldb_ctx, &msg->dn)) {
730 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
731 talloc_free(mem_ctx);
734 if (msg->dn == NULL) {
735 PyErr_SetString(PyExc_TypeError, "dn set but not found");
736 talloc_free(mem_ctx);
741 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
742 char *key_str = PyString_AsString(key);
743 if (strcmp(key_str, "dn") != 0) {
744 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
746 PyErr_SetString(PyExc_TypeError, "unable to import element");
747 talloc_free(mem_ctx);
750 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
755 if (msg->dn == NULL) {
756 PyErr_SetString(PyExc_TypeError, "no dn set");
757 talloc_free(mem_ctx);
761 msg->num_elements = msg_pos;
763 msg = PyLdbMessage_AsMessage(py_msg);
766 ret = ldb_msg_sanity_check(ldb_ctx, msg);
767 if (ret != LDB_SUCCESS) {
768 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
769 talloc_free(mem_ctx);
773 ret = ldb_build_add_req(&req, ldb_ctx, ldb_ctx,
777 ldb_op_default_callback,
780 if (ret != LDB_SUCCESS) {
781 PyErr_SetString(PyExc_TypeError, "failed to build request");
782 talloc_free(mem_ctx);
786 /* do request and autostart a transaction */
787 /* Then let's LDB handle the message error in case of pb as they are meaningful */
789 ret = ldb_transaction_start(ldb_ctx);
790 if (ret != LDB_SUCCESS) {
792 talloc_free(mem_ctx);
793 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
796 ret = ldb_request(ldb_ctx, req);
797 if (ret == LDB_SUCCESS) {
798 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
801 if (ret == LDB_SUCCESS) {
802 ret = ldb_transaction_commit(ldb_ctx);
804 ldb_transaction_cancel(ldb_ctx);
805 if (ldb_ctx->err_string == NULL) {
806 /* no error string was setup by the backend */
807 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
811 talloc_free(mem_ctx);
812 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
817 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
822 struct ldb_context *ldb;
824 if (!PyArg_ParseTuple(args, "O", &py_dn))
827 mem_ctx = talloc_new(NULL);
828 if (mem_ctx == NULL) {
832 ldb = PyLdb_AsLdbContext(self);
833 if (!PyObject_AsDn(mem_ctx, py_dn, ldb, &dn)) {
834 talloc_free(mem_ctx);
838 ret = ldb_delete(ldb, dn);
839 talloc_free(mem_ctx);
840 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
845 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
847 PyObject *py_dn1, *py_dn2;
848 struct ldb_dn *dn1, *dn2;
850 struct ldb_context *ldb;
852 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
855 mem_ctx = talloc_new(NULL);
856 if (mem_ctx == NULL) {
860 ldb = PyLdb_AsLdbContext(self);
861 if (!PyObject_AsDn(mem_ctx, py_dn1, ldb, &dn1)) {
862 talloc_free(mem_ctx);
866 if (!PyObject_AsDn(mem_ctx, py_dn2, ldb, &dn2)) {
867 talloc_free(mem_ctx);
871 ret = ldb_rename(ldb, dn1, dn2);
872 talloc_free(mem_ctx);
873 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
878 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
881 if (!PyArg_ParseTuple(args, "s", &name))
884 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
889 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
891 char *attribute, *syntax;
894 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
897 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
899 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
904 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
909 /* We don't want this attached to the 'ldb' any more */
910 return Py_BuildValue(discard_const_p(char, "(iO)"),
912 PyLdbMessage_FromMessage(ldif->msg));
917 static PyObject *py_ldb_write_ldif(PyLdbMessageObject *self, PyObject *args)
921 struct ldb_ldif ldif;
926 if (!PyArg_ParseTuple(args, "Oi", &py_msg, &changetype))
929 if (!PyLdbMessage_Check(py_msg)) {
930 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for msg");
934 ldif.msg = PyLdbMessage_AsMessage(py_msg);
935 ldif.changetype = changetype;
937 mem_ctx = talloc_new(NULL);
939 string = ldb_ldif_write_string(PyLdb_AsLdbContext(self), mem_ctx, &ldif);
941 PyErr_SetString(PyExc_KeyError, "Failed to generate LDIF");
945 ret = PyString_FromString(string);
947 talloc_free(mem_ctx);
952 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
955 struct ldb_ldif *ldif;
960 if (!PyArg_ParseTuple(args, "s", &s))
963 mem_ctx = talloc_new(NULL);
968 list = PyList_New(0);
969 while (s && *s != '\0') {
970 ldif = ldb_ldif_read_string(self->ldb_ctx, &s);
971 talloc_steal(mem_ctx, ldif);
973 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
975 PyErr_SetString(PyExc_ValueError, "unable to parse ldif string");
976 talloc_free(mem_ctx);
980 talloc_free(mem_ctx); /* The pyobject already has a reference to the things it needs */
981 return PyObject_GetIter(list);
984 static PyObject *py_ldb_msg_diff(PyLdbObject *self, PyObject *args)
986 PyObject *py_msg_old;
987 PyObject *py_msg_new;
988 struct ldb_message *diff;
991 if (!PyArg_ParseTuple(args, "OO", &py_msg_old, &py_msg_new))
994 if (!PyLdbMessage_Check(py_msg_old)) {
995 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for old message");
999 if (!PyLdbMessage_Check(py_msg_new)) {
1000 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for new message");
1004 diff = ldb_msg_diff(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg_old), PyLdbMessage_AsMessage(py_msg_new));
1006 PyErr_SetString(PyExc_RuntimeError, "Failed to generate the Ldb Message diff");
1010 py_ret = PyLdbMessage_FromMessage(diff);
1015 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
1017 const struct ldb_schema_attribute *a;
1018 struct ldb_val old_val;
1019 struct ldb_val new_val;
1020 TALLOC_CTX *mem_ctx;
1025 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
1028 mem_ctx = talloc_new(NULL);
1030 old_val.data = (uint8_t *)PyString_AsString(val);
1031 old_val.length = PyString_Size(val);
1033 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
1039 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
1040 talloc_free(mem_ctx);
1044 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
1046 talloc_free(mem_ctx);
1051 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
1053 PyObject *py_base = Py_None;
1054 int scope = LDB_SCOPE_DEFAULT;
1056 PyObject *py_attrs = Py_None;
1057 PyObject *py_controls = Py_None;
1058 const char * const kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
1060 struct ldb_result *res;
1061 struct ldb_request *req;
1063 struct ldb_context *ldb_ctx;
1064 struct ldb_control **parsed_controls;
1065 struct ldb_dn *base;
1068 /* type "int" rather than "enum" for "scope" is intentional */
1069 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO",
1070 discard_const_p(char *, kwnames),
1071 &py_base, &scope, &expr, &py_attrs, &py_controls))
1074 ldb_ctx = PyLdb_AsLdbContext(self);
1076 if (py_attrs == Py_None) {
1079 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1084 if (py_base == Py_None) {
1085 base = ldb_get_default_basedn(ldb_ctx);
1087 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base)) {
1093 if (py_controls == Py_None) {
1094 parsed_controls = NULL;
1096 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
1097 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
1098 talloc_free(controls);
1101 res = talloc_zero(ldb_ctx, struct ldb_result);
1108 ret = ldb_build_search_req(&req, ldb_ctx, ldb_ctx,
1115 ldb_search_default_callback,
1118 talloc_steal(req, attrs);
1120 if (ret != LDB_SUCCESS) {
1122 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1126 ret = ldb_request(ldb_ctx, req);
1128 if (ret == LDB_SUCCESS) {
1129 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1134 if (ret != LDB_SUCCESS) {
1136 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1140 py_ret = PyLdbResult_FromResult(res);
1147 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
1152 if (!PyArg_ParseTuple(args, "s", &name))
1155 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
1160 /* FIXME: More interpretation */
1165 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
1170 if (!PyArg_ParseTuple(args, "sO", &name, &data))
1173 /* FIXME: More interpretation */
1175 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
1180 static PyObject *py_ldb_modules(PyLdbObject *self)
1182 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
1183 PyObject *ret = PyList_New(0);
1184 struct ldb_module *mod;
1186 for (mod = ldb->modules; mod; mod = mod->next) {
1187 PyList_Append(ret, PyLdbModule_FromModule(mod));
1193 static PyMethodDef py_ldb_methods[] = {
1194 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
1195 "S.set_debug(callback) -> None\n"
1196 "Set callback for LDB debug messages.\n"
1197 "The callback should accept a debug level and debug text." },
1198 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
1199 "S.set_create_perms(mode) -> None\n"
1200 "Set mode to use when creating new LDB files." },
1201 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
1202 "S.set_modules_dir(path) -> None\n"
1203 "Set path LDB should search for modules" },
1204 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
1205 "S.transaction_start() -> None\n"
1206 "Start a new transaction." },
1207 { "transaction_prepare_commit", (PyCFunction)py_ldb_transaction_prepare_commit, METH_NOARGS,
1208 "S.transaction_prepare_commit() -> None\n"
1209 "prepare to commit a new transaction (2-stage commit)." },
1210 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
1211 "S.transaction_commit() -> None\n"
1212 "commit a new transaction." },
1213 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
1214 "S.transaction_cancel() -> None\n"
1215 "cancel a new transaction." },
1216 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
1218 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
1220 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
1222 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
1224 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
1226 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
1227 "S.connect(url, flags=0, options=None) -> None\n"
1228 "Connect to a LDB URL." },
1229 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
1230 "S.modify(message) -> None\n"
1231 "Modify an entry." },
1232 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
1233 "S.add(message) -> None\n"
1235 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
1236 "S.delete(dn) -> None\n"
1237 "Remove an entry." },
1238 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
1239 "S.rename(old_dn, new_dn) -> None\n"
1240 "Rename an entry." },
1241 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
1242 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
1243 "Search in a database.\n"
1245 ":param base: Optional base DN to search\n"
1246 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
1247 ":param expression: Optional search expression\n"
1248 ":param attrs: Attributes to return (defaults to all)\n"
1249 ":param controls: Optional list of controls\n"
1250 ":return: Iterator over Message objects\n"
1252 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
1254 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
1256 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
1258 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
1259 "S.parse_ldif(ldif) -> iter(messages)\n"
1260 "Parse a string formatted using LDIF." },
1261 { "write_ldif", (PyCFunction)py_ldb_write_ldif, METH_VARARGS,
1262 "S.write_ldif(message, changetype) -> ldif\n"
1263 "Print the message as a string formatted using LDIF." },
1264 { "msg_diff", (PyCFunction)py_ldb_msg_diff, METH_VARARGS,
1265 "S.msg_diff(Message) -> Message\n"
1266 "Return an LDB Message of the difference between two Message objects." },
1267 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
1268 "S.get_opaque(name) -> value\n"
1269 "Get an opaque value set on this LDB connection. \n"
1270 ":note: The returned value may not be useful in Python."
1272 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
1273 "S.set_opaque(name, value) -> None\n"
1274 "Set an opaque value on this LDB connection. \n"
1275 ":note: Passing incorrect values may cause crashes." },
1276 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
1277 "S.modules() -> list\n"
1278 "Return the list of modules on this LDB connection " },
1282 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
1284 PyLdbModuleObject *ret;
1286 ret = (PyLdbModuleObject *)PyLdbModule.tp_alloc(&PyLdbModule, 0);
1291 ret->mem_ctx = talloc_new(NULL);
1292 ret->mod = talloc_reference(ret->mem_ctx, mod);
1293 return (PyObject *)ret;
1296 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
1298 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
1301 static PyGetSetDef py_ldb_getset[] = {
1302 { discard_const_p(char, "firstmodule"), (getter)py_ldb_get_firstmodule, NULL, NULL },
1306 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
1308 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
1310 struct ldb_result *result;
1314 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
1317 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
1318 if (ret != LDB_SUCCESS) {
1319 PyErr_SetLdbError(PyExc_LdbError, ret, ldb_ctx);
1323 count = result->count;
1325 talloc_free(result);
1330 static PySequenceMethods py_ldb_seq = {
1331 .sq_contains = (objobjproc)py_ldb_contains,
1334 static PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
1338 ret = (PyLdbObject *)PyLdb.tp_alloc(&PyLdb, 0);
1343 ret->mem_ctx = talloc_new(NULL);
1344 ret->ldb_ctx = talloc_reference(ret->mem_ctx, ldb_ctx);
1345 return (PyObject *)ret;
1348 static void py_ldb_dealloc(PyLdbObject *self)
1350 talloc_free(self->mem_ctx);
1351 self->ob_type->tp_free(self);
1354 PyTypeObject PyLdb = {
1355 .tp_name = "ldb.Ldb",
1356 .tp_methods = py_ldb_methods,
1357 .tp_repr = (reprfunc)py_ldb_repr,
1358 .tp_new = py_ldb_new,
1359 .tp_init = (initproc)py_ldb_init,
1360 .tp_dealloc = (destructor)py_ldb_dealloc,
1361 .tp_getset = py_ldb_getset,
1362 .tp_getattro = PyObject_GenericGetAttr,
1363 .tp_basicsize = sizeof(PyLdbObject),
1364 .tp_doc = "Connection to a LDB database.",
1365 .tp_as_sequence = &py_ldb_seq,
1366 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1369 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1371 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1374 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1376 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1379 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1381 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1385 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1387 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1391 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1393 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1397 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1399 PyObject *py_base, *py_tree, *py_attrs, *py_ret;
1401 struct ldb_request *req;
1402 const char * const kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1403 struct ldb_module *mod;
1404 const char * const*attrs;
1406 /* type "int" rather than "enum" for "scope" is intentional */
1407 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO",
1408 discard_const_p(char *, kwnames),
1409 &py_base, &scope, &py_tree, &py_attrs))
1414 if (py_attrs == Py_None) {
1417 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1422 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1423 scope, NULL /* expr */, attrs,
1424 NULL /* controls */, NULL, NULL, NULL);
1426 talloc_steal(req, attrs);
1428 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1430 req->op.search.res = NULL;
1432 ret = mod->ops->search(mod, req);
1434 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1436 py_ret = PyLdbResult_FromResult(req->op.search.res);
1444 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1446 struct ldb_request *req;
1447 PyObject *py_message;
1449 struct ldb_module *mod;
1451 if (!PyArg_ParseTuple(args, "O", &py_message))
1454 req = talloc_zero(NULL, struct ldb_request);
1455 req->operation = LDB_ADD;
1456 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1458 mod = PyLdbModule_AsModule(self);
1459 ret = mod->ops->add(mod, req);
1461 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1466 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1469 struct ldb_request *req;
1470 PyObject *py_message;
1471 struct ldb_module *mod;
1473 if (!PyArg_ParseTuple(args, "O", &py_message))
1476 req = talloc_zero(NULL, struct ldb_request);
1477 req->operation = LDB_MODIFY;
1478 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1480 mod = PyLdbModule_AsModule(self);
1481 ret = mod->ops->modify(mod, req);
1483 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1488 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1491 struct ldb_request *req;
1494 if (!PyArg_ParseTuple(args, "O", &py_dn))
1497 req = talloc_zero(NULL, struct ldb_request);
1498 req->operation = LDB_DELETE;
1499 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1501 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1503 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1508 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1511 struct ldb_request *req;
1512 PyObject *py_dn1, *py_dn2;
1514 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1517 req = talloc_zero(NULL, struct ldb_request);
1519 req->operation = LDB_RENAME;
1520 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1521 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1523 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1525 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1530 static PyMethodDef py_ldb_module_methods[] = {
1531 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1532 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1533 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1534 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1535 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1536 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1537 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1538 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1542 static void py_ldb_module_dealloc(PyLdbModuleObject *self)
1544 talloc_free(self->mem_ctx);
1545 self->ob_type->tp_free(self);
1548 PyTypeObject PyLdbModule = {
1549 .tp_name = "ldb.LdbModule",
1550 .tp_methods = py_ldb_module_methods,
1551 .tp_repr = (reprfunc)py_ldb_module_repr,
1552 .tp_str = (reprfunc)py_ldb_module_str,
1553 .tp_basicsize = sizeof(PyLdbModuleObject),
1554 .tp_dealloc = (destructor)py_ldb_module_dealloc,
1555 .tp_flags = Py_TPFLAGS_DEFAULT,
1560 * Create a ldb_message_element from a Python object.
1562 * This will accept any sequence objects that contains strings, or
1565 * A reference to set_obj will be borrowed.
1567 * @param mem_ctx Memory context
1568 * @param set_obj Python object to convert
1569 * @param flags ldb_message_element flags to set
1570 * @param attr_name Name of the attribute
1571 * @return New ldb_message_element, allocated as child of mem_ctx
1573 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1574 PyObject *set_obj, int flags,
1575 const char *attr_name)
1577 struct ldb_message_element *me;
1579 if (PyLdbMessageElement_Check(set_obj))
1580 return talloc_reference(mem_ctx,
1581 PyLdbMessageElement_AsMessageElement(set_obj));
1583 me = talloc(mem_ctx, struct ldb_message_element);
1585 me->name = talloc_strdup(me, attr_name);
1587 if (PyString_Check(set_obj)) {
1589 me->values = talloc_array(me, struct ldb_val, me->num_values);
1590 me->values[0].length = PyString_Size(set_obj);
1591 me->values[0].data = talloc_memdup(me,
1592 (uint8_t *)PyString_AsString(set_obj), me->values[0].length+1);
1593 } else if (PySequence_Check(set_obj)) {
1595 me->num_values = PySequence_Size(set_obj);
1596 me->values = talloc_array(me, struct ldb_val, me->num_values);
1597 for (i = 0; i < me->num_values; i++) {
1598 PyObject *obj = PySequence_GetItem(set_obj, i);
1600 me->values[i].length = PyString_Size(obj);
1601 me->values[i].data = talloc_memdup(me,
1602 (uint8_t *)PyString_AsString(obj), me->values[i].length+1);
1613 static PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1614 struct ldb_message_element *me)
1619 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1620 result = PyList_New(me->num_values);
1622 for (i = 0; i < me->num_values; i++) {
1623 PyList_SetItem(result, i,
1624 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1630 static PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1633 if (!PyArg_ParseTuple(args, "i", &i))
1635 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1638 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1639 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1642 static PyObject *py_ldb_msg_element_flags(PyLdbMessageElementObject *self, PyObject *args)
1644 struct ldb_message_element *el;
1646 el = PyLdbMessageElement_AsMessageElement(self);
1647 return PyInt_FromLong(el->flags);
1650 static PyObject *py_ldb_msg_element_set_flags(PyLdbMessageElementObject *self, PyObject *args)
1653 struct ldb_message_element *el;
1654 if (!PyArg_ParseTuple(args, "i", &flags))
1657 el = PyLdbMessageElement_AsMessageElement(self);
1662 static PyMethodDef py_ldb_msg_element_methods[] = {
1663 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1664 { "set_flags", (PyCFunction)py_ldb_msg_element_set_flags, METH_VARARGS, NULL },
1665 { "flags", (PyCFunction)py_ldb_msg_element_flags, METH_NOARGS, NULL },
1669 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1671 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1674 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1676 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1677 if (idx < 0 || idx >= el->num_values) {
1678 PyErr_SetString(PyExc_IndexError, "Out of range");
1681 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1684 static PySequenceMethods py_ldb_msg_element_seq = {
1685 .sq_length = (lenfunc)py_ldb_msg_element_len,
1686 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1689 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1691 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1692 PyLdbMessageElement_AsMessageElement(other));
1695 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1697 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1700 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el, TALLOC_CTX *mem_ctx)
1702 PyLdbMessageElementObject *ret;
1703 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1708 ret->mem_ctx = talloc_new(NULL);
1709 if (talloc_reference(ret->mem_ctx, mem_ctx) == NULL) {
1714 return (PyObject *)ret;
1717 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1719 PyObject *py_elements = NULL;
1720 struct ldb_message_element *el;
1723 const char * const kwnames[] = { "elements", "flags", "name", NULL };
1724 PyLdbMessageElementObject *ret;
1725 TALLOC_CTX *mem_ctx;
1727 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois",
1728 discard_const_p(char *, kwnames),
1729 &py_elements, &flags, &name))
1732 mem_ctx = talloc_new(NULL);
1733 if (mem_ctx == NULL) {
1738 el = talloc_zero(mem_ctx, struct ldb_message_element);
1740 if (py_elements != NULL) {
1742 if (PyString_Check(py_elements)) {
1744 el->values = talloc_array(el, struct ldb_val, 1);
1745 el->values[0].length = PyString_Size(py_elements);
1746 el->values[0].data = talloc_memdup(el,
1747 (uint8_t *)PyString_AsString(py_elements), el->values[0].length+1);
1748 } else if (PySequence_Check(py_elements)) {
1749 el->num_values = PySequence_Size(py_elements);
1750 el->values = talloc_array(el, struct ldb_val, el->num_values);
1751 for (i = 0; i < el->num_values; i++) {
1752 PyObject *item = PySequence_GetItem(py_elements, i);
1753 if (!PyString_Check(item)) {
1754 PyErr_Format(PyExc_TypeError,
1755 "Expected string as element %d in list",
1757 talloc_free(mem_ctx);
1760 el->values[i].length = PyString_Size(item);
1761 el->values[i].data = talloc_memdup(el,
1762 (uint8_t *)PyString_AsString(item), el->values[i].length+1);
1765 PyErr_SetString(PyExc_TypeError,
1766 "Expected string or list");
1767 talloc_free(mem_ctx);
1773 el->name = talloc_strdup(el, name);
1775 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1778 talloc_free(mem_ctx);
1782 ret->mem_ctx = mem_ctx;
1784 return (PyObject *)ret;
1787 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1789 char *element_str = NULL;
1791 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1794 for (i = 0; i < el->num_values; i++) {
1795 PyObject *o = py_ldb_msg_element_find(self, i);
1796 if (element_str == NULL)
1797 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1799 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1802 if (element_str != NULL) {
1803 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1804 talloc_free(element_str);
1806 ret = PyString_FromString("MessageElement([])");
1812 static PyObject *py_ldb_msg_element_str(PyLdbMessageElementObject *self)
1814 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1816 if (el->num_values == 1)
1817 return PyString_FromStringAndSize((char *)el->values[0].data, el->values[0].length);
1822 static void py_ldb_msg_element_dealloc(PyLdbMessageElementObject *self)
1824 talloc_free(self->mem_ctx);
1825 self->ob_type->tp_free(self);
1828 PyTypeObject PyLdbMessageElement = {
1829 .tp_name = "ldb.MessageElement",
1830 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1831 .tp_dealloc = (destructor)py_ldb_msg_element_dealloc,
1832 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1833 .tp_str = (reprfunc)py_ldb_msg_element_str,
1834 .tp_methods = py_ldb_msg_element_methods,
1835 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1836 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1837 .tp_as_sequence = &py_ldb_msg_element_seq,
1838 .tp_new = py_ldb_msg_element_new,
1839 .tp_flags = Py_TPFLAGS_DEFAULT,
1842 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1845 if (!PyArg_ParseTuple(args, "s", &name))
1848 ldb_msg_remove_attr(self->msg, name);
1853 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1855 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1857 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1858 if (msg->dn != NULL) {
1859 PyList_SetItem(obj, j, PyString_FromString("dn"));
1862 for (i = 0; i < msg->num_elements; i++) {
1863 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1869 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1871 struct ldb_message_element *el;
1873 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1874 if (!PyString_Check(py_name)) {
1875 PyErr_SetNone(PyExc_TypeError);
1878 name = PyString_AsString(py_name);
1879 if (!strcmp(name, "dn"))
1880 return PyLdbDn_FromDn(msg->dn);
1881 el = ldb_msg_find_element(msg, name);
1885 return (PyObject *)PyLdbMessageElement_FromMessageElement(el, msg);
1888 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1890 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1892 PyErr_SetString(PyExc_KeyError, "No such element");
1898 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1900 PyObject *name, *ret;
1901 if (!PyArg_ParseTuple(args, "O", &name))
1904 ret = py_ldb_msg_getitem_helper(self, name);
1906 if (PyErr_Occurred())
1913 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1915 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1917 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1919 if (msg->dn != NULL) {
1920 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1923 for (i = 0; i < msg->num_elements; i++, j++) {
1924 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i], self->msg)));
1929 static PyMethodDef py_ldb_msg_methods[] = {
1930 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1931 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1932 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
1933 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
1937 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
1939 PyObject *list, *iter;
1941 list = py_ldb_msg_keys(self);
1942 iter = PyObject_GetIter(list);
1947 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
1951 if (!PyString_Check(name)) {
1952 PyErr_SetNone(PyExc_TypeError);
1956 attr_name = PyString_AsString(name);
1957 if (value == NULL) {
1959 ldb_msg_remove_attr(self->msg, attr_name);
1961 struct ldb_message_element *el = PyObject_AsMessageElement(self->msg,
1962 value, 0, attr_name);
1965 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
1966 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
1971 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
1973 return PyLdbMessage_AsMessage(self)->num_elements;
1976 static PyMappingMethods py_ldb_msg_mapping = {
1977 .mp_length = (lenfunc)py_ldb_msg_length,
1978 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
1979 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
1982 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1984 const char * const kwnames[] = { "dn", NULL };
1985 struct ldb_message *ret;
1986 TALLOC_CTX *mem_ctx;
1987 PyObject *pydn = NULL;
1988 PyLdbMessageObject *py_ret;
1990 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O",
1991 discard_const_p(char *, kwnames),
1995 mem_ctx = talloc_new(NULL);
1996 if (mem_ctx == NULL) {
2001 ret = ldb_msg_new(mem_ctx);
2003 talloc_free(mem_ctx);
2010 if (!PyObject_AsDn(NULL, pydn, NULL, &dn)) {
2011 talloc_free(mem_ctx);
2014 ret->dn = talloc_reference(ret, dn);
2017 py_ret = (PyLdbMessageObject *)type->tp_alloc(type, 0);
2018 if (py_ret == NULL) {
2020 talloc_free(mem_ctx);
2024 py_ret->mem_ctx = mem_ctx;
2026 return (PyObject *)py_ret;
2029 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
2031 PyLdbMessageObject *ret;
2033 ret = (PyLdbMessageObject *)PyLdbMessage.tp_alloc(&PyLdbMessage, 0);
2038 ret->mem_ctx = talloc_new(NULL);
2039 ret->msg = talloc_reference(ret->mem_ctx, msg);
2040 return (PyObject *)ret;
2043 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
2045 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2046 return PyLdbDn_FromDn(msg->dn);
2049 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
2051 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
2052 if (!PyLdbDn_Check(value)) {
2053 PyErr_SetNone(PyExc_TypeError);
2057 msg->dn = talloc_reference(msg, PyLdbDn_AsDn(value));
2061 static PyGetSetDef py_ldb_msg_getset[] = {
2062 { discard_const_p(char, "dn"), (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
2066 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
2068 PyObject *dict = PyDict_New(), *ret;
2069 if (PyDict_Update(dict, (PyObject *)self) != 0)
2071 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
2076 static void py_ldb_msg_dealloc(PyLdbMessageObject *self)
2078 talloc_free(self->mem_ctx);
2079 self->ob_type->tp_free(self);
2082 static int py_ldb_msg_compare(PyLdbMessageObject *py_msg1,
2083 PyLdbMessageObject *py_msg2)
2085 struct ldb_message *msg1 = PyLdbMessage_AsMessage(py_msg1),
2086 *msg2 = PyLdbMessage_AsMessage(py_msg2);
2090 ret = ldb_dn_compare(msg1->dn, msg2->dn);
2095 ret = msg1->num_elements - msg2->num_elements;
2100 for (i = 0; i < msg1->num_elements; i++) {
2101 ret = ldb_msg_element_compare_name(&msg1->elements[i],
2102 &msg2->elements[i]);
2107 ret = ldb_msg_element_compare(&msg1->elements[i],
2108 &msg2->elements[i]);
2117 PyTypeObject PyLdbMessage = {
2118 .tp_name = "ldb.Message",
2119 .tp_methods = py_ldb_msg_methods,
2120 .tp_getset = py_ldb_msg_getset,
2121 .tp_as_mapping = &py_ldb_msg_mapping,
2122 .tp_basicsize = sizeof(PyLdbMessageObject),
2123 .tp_dealloc = (destructor)py_ldb_msg_dealloc,
2124 .tp_new = py_ldb_msg_new,
2125 .tp_repr = (reprfunc)py_ldb_msg_repr,
2126 .tp_flags = Py_TPFLAGS_DEFAULT,
2127 .tp_iter = (getiterfunc)py_ldb_msg_iter,
2128 .tp_compare = (cmpfunc)py_ldb_msg_compare,
2131 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
2133 PyLdbTreeObject *ret;
2135 ret = (PyLdbTreeObject *)PyLdbTree.tp_alloc(&PyLdbTree, 0);
2141 ret->mem_ctx = talloc_new(NULL);
2142 ret->tree = talloc_reference(ret->mem_ctx, tree);
2143 return (PyObject *)ret;
2146 static void py_ldb_tree_dealloc(PyLdbTreeObject *self)
2148 talloc_free(self->mem_ctx);
2149 self->ob_type->tp_free(self);
2152 PyTypeObject PyLdbTree = {
2153 .tp_name = "ldb.Tree",
2154 .tp_basicsize = sizeof(PyLdbTreeObject),
2155 .tp_dealloc = (destructor)py_ldb_tree_dealloc,
2156 .tp_flags = Py_TPFLAGS_DEFAULT,
2160 static int py_module_search(struct ldb_module *mod, struct ldb_request *req)
2162 PyObject *py_ldb = (PyObject *)mod->private_data;
2163 PyObject *py_result, *py_base, *py_attrs, *py_tree;
2165 py_base = PyLdbDn_FromDn(req->op.search.base);
2167 if (py_base == NULL)
2168 return LDB_ERR_OPERATIONS_ERROR;
2170 py_tree = PyLdbTree_FromTree(req->op.search.tree);
2172 if (py_tree == NULL)
2173 return LDB_ERR_OPERATIONS_ERROR;
2175 if (req->op.search.attrs == NULL) {
2179 for (len = 0; req->op.search.attrs[len]; len++);
2180 py_attrs = PyList_New(len);
2181 for (i = 0; i < len; i++)
2182 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
2185 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "search"),
2186 discard_const_p(char, "OiOO"),
2187 py_base, req->op.search.scope, py_tree, py_attrs);
2189 Py_DECREF(py_attrs);
2193 if (py_result == NULL) {
2194 return LDB_ERR_PYTHON_EXCEPTION;
2197 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
2198 if (req->op.search.res == NULL) {
2199 return LDB_ERR_PYTHON_EXCEPTION;
2202 Py_DECREF(py_result);
2207 static int py_module_add(struct ldb_module *mod, struct ldb_request *req)
2209 PyObject *py_ldb = (PyObject *)mod->private_data;
2210 PyObject *py_result, *py_msg;
2212 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.add.message));
2214 if (py_msg == NULL) {
2215 return LDB_ERR_OPERATIONS_ERROR;
2218 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "add"),
2219 discard_const_p(char, "O"),
2224 if (py_result == NULL) {
2225 return LDB_ERR_PYTHON_EXCEPTION;
2228 Py_DECREF(py_result);
2233 static int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
2235 PyObject *py_ldb = (PyObject *)mod->private_data;
2236 PyObject *py_result, *py_msg;
2238 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.mod.message));
2240 if (py_msg == NULL) {
2241 return LDB_ERR_OPERATIONS_ERROR;
2244 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "modify"),
2245 discard_const_p(char, "O"),
2250 if (py_result == NULL) {
2251 return LDB_ERR_PYTHON_EXCEPTION;
2254 Py_DECREF(py_result);
2259 static int py_module_del(struct ldb_module *mod, struct ldb_request *req)
2261 PyObject *py_ldb = (PyObject *)mod->private_data;
2262 PyObject *py_result, *py_dn;
2264 py_dn = PyLdbDn_FromDn(req->op.del.dn);
2267 return LDB_ERR_OPERATIONS_ERROR;
2269 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "delete"),
2270 discard_const_p(char, "O"),
2273 if (py_result == NULL) {
2274 return LDB_ERR_PYTHON_EXCEPTION;
2277 Py_DECREF(py_result);
2282 static int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
2284 PyObject *py_ldb = (PyObject *)mod->private_data;
2285 PyObject *py_result, *py_olddn, *py_newdn;
2287 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
2289 if (py_olddn == NULL)
2290 return LDB_ERR_OPERATIONS_ERROR;
2292 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
2294 if (py_newdn == NULL)
2295 return LDB_ERR_OPERATIONS_ERROR;
2297 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "rename"),
2298 discard_const_p(char, "OO"),
2299 py_olddn, py_newdn);
2301 Py_DECREF(py_olddn);
2302 Py_DECREF(py_newdn);
2304 if (py_result == NULL) {
2305 return LDB_ERR_PYTHON_EXCEPTION;
2308 Py_DECREF(py_result);
2313 static int py_module_request(struct ldb_module *mod, struct ldb_request *req)
2315 PyObject *py_ldb = (PyObject *)mod->private_data;
2316 PyObject *py_result;
2318 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "request"),
2319 discard_const_p(char, ""));
2321 return LDB_ERR_OPERATIONS_ERROR;
2324 static int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
2326 PyObject *py_ldb = (PyObject *)mod->private_data;
2327 PyObject *py_result;
2329 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "extended"),
2330 discard_const_p(char, ""));
2332 return LDB_ERR_OPERATIONS_ERROR;
2335 static int py_module_start_transaction(struct ldb_module *mod)
2337 PyObject *py_ldb = (PyObject *)mod->private_data;
2338 PyObject *py_result;
2340 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "start_transaction"),
2341 discard_const_p(char, ""));
2343 if (py_result == NULL) {
2344 return LDB_ERR_PYTHON_EXCEPTION;
2347 Py_DECREF(py_result);
2352 static int py_module_end_transaction(struct ldb_module *mod)
2354 PyObject *py_ldb = (PyObject *)mod->private_data;
2355 PyObject *py_result;
2357 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "end_transaction"),
2358 discard_const_p(char, ""));
2360 if (py_result == NULL) {
2361 return LDB_ERR_PYTHON_EXCEPTION;
2364 Py_DECREF(py_result);
2369 static int py_module_del_transaction(struct ldb_module *mod)
2371 PyObject *py_ldb = (PyObject *)mod->private_data;
2372 PyObject *py_result;
2374 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "del_transaction"),
2375 discard_const_p(char, ""));
2377 if (py_result == NULL) {
2378 return LDB_ERR_PYTHON_EXCEPTION;
2381 Py_DECREF(py_result);
2386 static int py_module_destructor(struct ldb_module *mod)
2388 Py_DECREF((PyObject *)mod->private_data);
2392 static int py_module_init(struct ldb_module *mod)
2394 PyObject *py_class = (PyObject *)mod->ops->private_data;
2395 PyObject *py_result, *py_next, *py_ldb;
2397 py_ldb = PyLdb_FromLdbContext(mod->ldb);
2400 return LDB_ERR_OPERATIONS_ERROR;
2402 py_next = PyLdbModule_FromModule(mod->next);
2404 if (py_next == NULL)
2405 return LDB_ERR_OPERATIONS_ERROR;
2407 py_result = PyObject_CallFunction(py_class, discard_const_p(char, "OO"),
2410 if (py_result == NULL) {
2411 return LDB_ERR_PYTHON_EXCEPTION;
2414 mod->private_data = py_result;
2416 talloc_set_destructor(mod, py_module_destructor);
2418 return ldb_next_init(mod);
2421 static PyObject *py_register_module(PyObject *module, PyObject *args)
2424 struct ldb_module_ops *ops;
2427 if (!PyArg_ParseTuple(args, "O", &input))
2430 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
2436 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, discard_const_p(char, "name"))));
2439 ops->private_data = input;
2440 ops->init_context = py_module_init;
2441 ops->search = py_module_search;
2442 ops->add = py_module_add;
2443 ops->modify = py_module_modify;
2444 ops->del = py_module_del;
2445 ops->rename = py_module_rename;
2446 ops->request = py_module_request;
2447 ops->extended = py_module_extended;
2448 ops->start_transaction = py_module_start_transaction;
2449 ops->end_transaction = py_module_end_transaction;
2450 ops->del_transaction = py_module_del_transaction;
2452 ret = ldb_register_module(ops);
2454 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
2459 static PyObject *py_timestring(PyObject *module, PyObject *args)
2465 if (!PyArg_ParseTuple(args, "l", &val))
2468 tresult = ldb_timestring(NULL, t);
2469 ret = PyString_FromString(tresult);
2470 talloc_free(tresult);
2474 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
2477 if (!PyArg_ParseTuple(args, "s", &str))
2480 return PyInt_FromLong(ldb_string_to_time(str));
2483 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
2486 if (!PyArg_ParseTuple(args, "s", &name))
2488 return PyBool_FromLong(ldb_valid_attr_name(name));
2491 static PyMethodDef py_ldb_global_methods[] = {
2492 { "register_module", py_register_module, METH_VARARGS,
2493 "S.register_module(module) -> None\n"
2494 "Register a LDB module."},
2495 { "timestring", py_timestring, METH_VARARGS,
2496 "S.timestring(int) -> string\n"
2497 "Generate a LDAP time string from a UNIX timestamp" },
2498 { "string_to_time", py_string_to_time, METH_VARARGS,
2499 "S.string_to_time(string) -> int\n"
2500 "Parse a LDAP time string into a UNIX timestamp." },
2501 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
2502 "S.valid_attr_name(name) -> bool\n"
2503 "Check whether the supplied name is a valid attribute name." },
2504 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
2513 if (PyType_Ready(&PyLdbDn) < 0)
2516 if (PyType_Ready(&PyLdbMessage) < 0)
2519 if (PyType_Ready(&PyLdbMessageElement) < 0)
2522 if (PyType_Ready(&PyLdb) < 0)
2525 if (PyType_Ready(&PyLdbModule) < 0)
2528 if (PyType_Ready(&PyLdbTree) < 0)
2531 m = Py_InitModule3("ldb", py_ldb_global_methods,
2532 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
2536 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
2537 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
2538 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
2539 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
2541 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
2542 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
2543 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
2544 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
2546 PyModule_AddObject(m, "FLAG_MOD_ADD", PyInt_FromLong(LDB_FLAG_MOD_ADD));
2547 PyModule_AddObject(m, "FLAG_MOD_REPLACE", PyInt_FromLong(LDB_FLAG_MOD_REPLACE));
2548 PyModule_AddObject(m, "FLAG_MOD_DELETE", PyInt_FromLong(LDB_FLAG_MOD_DELETE));
2550 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
2551 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
2552 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
2553 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
2554 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
2555 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
2556 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
2557 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
2558 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
2559 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
2560 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
2561 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
2562 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
2563 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
2564 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
2565 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
2566 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
2567 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
2568 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
2569 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
2570 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
2571 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
2572 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
2573 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
2574 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
2575 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
2576 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
2577 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
2578 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
2579 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
2580 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
2581 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
2582 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
2583 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
2584 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
2585 PyModule_AddObject(m, "ERR_ENTRY_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
2586 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
2587 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
2588 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
2590 PyModule_AddObject(m, "FLG_RDONLY", PyInt_FromLong(LDB_FLG_RDONLY));
2591 PyModule_AddObject(m, "FLG_NOSYNC", PyInt_FromLong(LDB_FLG_NOSYNC));
2592 PyModule_AddObject(m, "FLG_RECONNECT", PyInt_FromLong(LDB_FLG_RECONNECT));
2593 PyModule_AddObject(m, "FLG_NOMMAP", PyInt_FromLong(LDB_FLG_NOMMAP));
2595 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
2597 PyExc_LdbError = PyErr_NewException(discard_const_p(char, "_ldb.LdbError"), NULL, NULL);
2598 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
2601 Py_INCREF(&PyLdbDn);
2602 Py_INCREF(&PyLdbModule);
2603 Py_INCREF(&PyLdbMessage);
2604 Py_INCREF(&PyLdbMessageElement);
2605 Py_INCREF(&PyLdbTree);
2607 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
2608 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
2609 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
2610 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
2611 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
2612 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);