2 Unix SMB/CIFS implementation.
6 Copyright (C) 2005,2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2006 Simo Sorce <idra@samba.org>
8 Copyright (C) 2007-2008 Jelmer Vernooij <jelmer@samba.org>
10 ** NOTE! The following LGPL license applies to the ldb
11 ** library. This does NOT imply that all of Samba is released
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
33 #include "ldb_errors.h"
34 #include "ldb_private.h"
36 /* Picked out of thin air. To do this properly, we should probably have some part of the
37 * errors in LDB be allocated to bindings ? */
38 #define LDB_ERR_PYTHON_EXCEPTION 142
40 PyObject *PyExc_LdbError;
42 void PyErr_SetLdbError(int ret, struct ldb_context *ldb_ctx)
44 if (ret == LDB_ERR_PYTHON_EXCEPTION)
45 return; /* Python exception should already be set, just keep that */
46 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", ret, ldb_ctx == NULL?ldb_strerror(ret):ldb_errstring(ldb_ctx)));
48 PyObject *PyObject_FromLdbValue(struct ldb_context *ldb_ctx,
49 struct ldb_message_element *el,
52 const struct ldb_schema_attribute *a;
53 struct ldb_val new_val;
54 TALLOC_CTX *mem_ctx = talloc_new(NULL);
59 if (ldb_ctx != NULL) {
60 a = ldb_schema_attribute_by_name(ldb_ctx, el->name);
63 if (a->syntax->ldif_write_fn(ldb_ctx, mem_ctx, val, &new_val) != 0) {
70 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
77 bool PyObject_AsDn(TALLOC_CTX *mem_ctx, PyObject *object,
78 struct ldb_context *ldb_ctx, struct ldb_dn **dn)
82 if (ldb_ctx != NULL && PyString_Check(object)) {
83 odn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
88 if (PyLdbDn_Check(object)) {
89 *dn = PyLdbDn_AsDn(object);
93 PyErr_SetString(PyExc_TypeError, "Expected DN");
97 static PyObject *PyLdbResult_FromResult(struct ldb_result *result)
101 if (result == NULL) {
104 ret = PyList_New(result->count);
105 for (i = 0; i < result->count; i++) {
106 PyList_SetItem(ret, i, PyLdbMessage_FromMessage(result->msgs[i])
112 static struct ldb_result *PyLdbResult_AsResult(TALLOC_CTX *mem_ctx, PyObject *obj)
114 struct ldb_result *res;
120 res = talloc_zero(mem_ctx, struct ldb_result);
121 res->count = PyList_Size(obj);
122 res->msgs = talloc_array(res, struct ldb_message *, res->count);
123 for (i = 0; i < res->count; i++) {
124 PyObject *item = PyList_GetItem(obj, i);
125 res->msgs[i] = PyLdbMessage_AsMessage(item);
130 static PyObject *py_ldb_dn_validate(PyLdbDnObject *self)
132 return PyBool_FromLong(ldb_dn_validate(self->ptr));
135 static PyObject *py_ldb_dn_is_valid(PyLdbDnObject *self)
137 return PyBool_FromLong(ldb_dn_is_valid(self->ptr));
140 static PyObject *py_ldb_dn_is_special(PyLdbDnObject *self)
142 return PyBool_FromLong(ldb_dn_is_special(self->ptr));
145 static PyObject *py_ldb_dn_is_null(PyLdbDnObject *self)
147 return PyBool_FromLong(ldb_dn_is_null(self->ptr));
150 static PyObject *py_ldb_dn_get_casefold(PyLdbDnObject *self)
152 return PyString_FromString(ldb_dn_get_casefold(self->ptr));
155 static PyObject *py_ldb_dn_get_linearized(PyLdbDnObject *self)
157 return PyString_FromString(ldb_dn_get_linearized(self->ptr));
160 static PyObject *py_ldb_dn_canonical_str(PyLdbDnObject *self)
162 return PyString_FromString(ldb_dn_canonical_string(self->ptr, self->ptr));
165 static PyObject *py_ldb_dn_canonical_ex_str(PyLdbDnObject *self)
167 return PyString_FromString(ldb_dn_canonical_ex_string(self->ptr, self->ptr));
170 static PyObject *py_ldb_dn_repr(PyLdbDnObject *self)
172 return PyString_FromFormat("Dn(%s)", PyObject_REPR(PyString_FromString(ldb_dn_get_linearized(self->ptr))));
175 static PyObject *py_ldb_dn_check_special(PyLdbDnObject *self, PyObject *args)
179 if (!PyArg_ParseTuple(args, "s", &name))
182 return ldb_dn_check_special(self->ptr, name)?Py_True:Py_False;
185 static int py_ldb_dn_compare(PyLdbDnObject *dn1, PyLdbDnObject *dn2)
187 return ldb_dn_compare(dn1->ptr, dn2->ptr);
190 static PyObject *py_ldb_dn_get_parent(PyLdbDnObject *self)
192 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self);
193 return PyLdbDn_FromDn(ldb_dn_get_parent(NULL, dn));
196 #define dn_ldb_ctx(dn) ((struct ldb_context *)dn)
198 static PyObject *py_ldb_dn_add_child(PyLdbDnObject *self, PyObject *args)
201 struct ldb_dn *dn, *other;
202 if (!PyArg_ParseTuple(args, "O", &py_other))
205 dn = PyLdbDn_AsDn((PyObject *)self);
207 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
210 return ldb_dn_add_child(dn, other)?Py_True:Py_False;
213 static PyObject *py_ldb_dn_add_base(PyLdbDnObject *self, PyObject *args)
216 struct ldb_dn *other, *dn;
217 if (!PyArg_ParseTuple(args, "O", &py_other))
220 dn = PyLdbDn_AsDn((PyObject *)self);
222 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
225 return ldb_dn_add_base(dn, other)?Py_True:Py_False;
228 static PyMethodDef py_ldb_dn_methods[] = {
229 { "validate", (PyCFunction)py_ldb_dn_validate, METH_NOARGS,
230 "S.validate() -> bool\n"
231 "Validate DN is correct." },
232 { "is_valid", (PyCFunction)py_ldb_dn_is_valid, METH_NOARGS,
233 "S.is_valid() -> bool\n" },
234 { "is_special", (PyCFunction)py_ldb_dn_is_special, METH_NOARGS,
235 "S.is_special() -> bool\n"
236 "Check whether this is a special LDB DN." },
237 { "is_null", (PyCFunction)py_ldb_dn_is_null, METH_NOARGS,
238 "Check whether this is a null DN." },
239 { "get_casefold", (PyCFunction)py_ldb_dn_get_casefold, METH_NOARGS,
241 { "get_linearized", (PyCFunction)py_ldb_dn_get_linearized, METH_NOARGS,
243 { "canonical_str", (PyCFunction)py_ldb_dn_canonical_str, METH_NOARGS,
244 "S.canonical_str() -> string\n"
245 "Canonical version of this DN (like a posix path)." },
246 { "canonical_ex_str", (PyCFunction)py_ldb_dn_canonical_ex_str, METH_NOARGS,
247 "S.canonical_ex_str() -> string\n"
248 "Canonical version of this DN (like a posix path, with terminating newline)." },
249 { "check_special", (PyCFunction)py_ldb_dn_is_special, METH_VARARGS,
251 { "parent", (PyCFunction)py_ldb_dn_get_parent, METH_NOARGS,
253 "Get the parent for this DN." },
254 { "add_child", (PyCFunction)py_ldb_dn_add_child, METH_VARARGS,
255 "S.add_child(dn) -> None\n"
256 "Add a child DN to this DN." },
257 { "add_base", (PyCFunction)py_ldb_dn_add_base, METH_VARARGS,
258 "S.add_base(dn) -> None\n"
259 "Add a base DN to this DN." },
260 { "check_special", (PyCFunction)py_ldb_dn_check_special, METH_VARARGS,
265 static Py_ssize_t py_ldb_dn_len(PyLdbDnObject *self)
267 return ldb_dn_get_comp_num(PyLdbDn_AsDn((PyObject *)self));
270 static PyObject *py_ldb_dn_concat(PyLdbDnObject *self, PyObject *py_other)
272 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self),
274 struct ldb_dn *ret = ldb_dn_copy(NULL, dn);
275 if (!PyObject_AsDn(NULL, py_other, NULL, &other))
277 ldb_dn_add_child(ret, other);
278 return PyLdbDn_FromDn(ret);
281 static PySequenceMethods py_ldb_dn_seq = {
282 .sq_length = (lenfunc)py_ldb_dn_len,
283 .sq_concat = (binaryfunc)py_ldb_dn_concat,
286 static PyObject *py_ldb_dn_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
291 struct ldb_context *ldb_ctx;
292 const char *kwnames[] = { "ldb", "dn", NULL };
294 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Os", (char **)kwnames, &py_ldb, &str))
297 ldb_ctx = PyLdb_AsLdbContext(py_ldb);
299 ret = ldb_dn_new(ldb_ctx, ldb_ctx, str);
300 /* ldb_dn_new() doesn't accept NULL as memory context, so
301 we do it this way... */
302 talloc_steal(NULL, ret);
304 if (ret == NULL || !ldb_dn_validate(ret)) {
305 PyErr_SetString(PyExc_ValueError, "unable to parse dn string");
309 return py_talloc_import(&PyLdbDn, ret);
312 PyObject *PyLdbDn_FromDn(struct ldb_dn *dn)
314 return py_talloc_import(&PyLdbDn, dn);
317 PyTypeObject PyLdbDn = {
319 .tp_methods = py_ldb_dn_methods,
320 .tp_str = (reprfunc)py_ldb_dn_get_linearized,
321 .tp_repr = (reprfunc)py_ldb_dn_repr,
322 .tp_compare = (cmpfunc)py_ldb_dn_compare,
323 .tp_as_sequence = &py_ldb_dn_seq,
324 .tp_doc = "A LDB distinguished name.",
325 .tp_new = py_ldb_dn_new,
326 .tp_dealloc = py_talloc_dealloc,
327 .tp_basicsize = sizeof(PyLdbObject),
328 .tp_flags = Py_TPFLAGS_DEFAULT,
332 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
333 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
335 PyObject *fn = context;
336 PyObject_CallFunction(fn, (char *)"(i,O)", level, PyString_FromFormatV(fmt, ap));
339 static PyObject *py_ldb_set_debug(PyLdbObject *self, PyObject *args)
343 if (!PyArg_ParseTuple(args, "O", &cb))
347 /* FIXME: Where do we DECREF cb ? */
348 PyErr_LDB_ERROR_IS_ERR_RAISE(ldb_set_debug(self->ptr, py_ldb_debug, cb), PyLdb_AsLdbContext(self));
353 static PyObject *py_ldb_set_create_perms(PyTypeObject *self, PyObject *args)
356 if (!PyArg_ParseTuple(args, "I", &perms))
359 ldb_set_create_perms(PyLdb_AsLdbContext(self), perms);
364 static PyObject *py_ldb_set_modules_dir(PyTypeObject *self, PyObject *args)
367 if (!PyArg_ParseTuple(args, "s", &modules_dir))
370 ldb_set_modules_dir(PyLdb_AsLdbContext(self), modules_dir);
375 static PyObject *py_ldb_transaction_start(PyLdbObject *self)
377 PyErr_LDB_ERROR_IS_ERR_RAISE(ldb_transaction_start(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
381 static PyObject *py_ldb_transaction_commit(PyLdbObject *self)
383 PyErr_LDB_ERROR_IS_ERR_RAISE(ldb_transaction_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
387 static PyObject *py_ldb_transaction_cancel(PyLdbObject *self)
389 PyErr_LDB_ERROR_IS_ERR_RAISE(ldb_transaction_cancel(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
393 static PyObject *py_ldb_setup_wellknown_attributes(PyLdbObject *self)
395 PyErr_LDB_ERROR_IS_ERR_RAISE(ldb_setup_wellknown_attributes(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
399 static PyObject *py_ldb_repr(PyLdbObject *self)
401 return PyString_FromFormat("<ldb connection>");
404 static PyObject *py_ldb_get_root_basedn(PyLdbObject *self)
406 struct ldb_dn *dn = ldb_get_root_basedn(PyLdb_AsLdbContext(self));
409 return PyLdbDn_FromDn(dn);
413 static PyObject *py_ldb_get_schema_basedn(PyLdbObject *self)
415 struct ldb_dn *dn = ldb_get_schema_basedn(PyLdb_AsLdbContext(self));
418 return PyLdbDn_FromDn(dn);
422 static PyObject *py_ldb_get_config_basedn(PyLdbObject *self)
424 struct ldb_dn *dn = ldb_get_config_basedn(PyLdb_AsLdbContext(self));
427 return PyLdbDn_FromDn(dn);
431 static PyObject *py_ldb_get_default_basedn(PyLdbObject *self)
433 struct ldb_dn *dn = ldb_get_default_basedn(PyLdb_AsLdbContext(self));
436 return PyLdbDn_FromDn(dn);
439 static const char **PyList_AsStringList(TALLOC_CTX *mem_ctx, PyObject *list)
443 if (!PyList_Check(list)) {
444 PyErr_SetString(PyExc_TypeError, "options is not a list");
447 ret = talloc_array(NULL, const char *, PyList_Size(list)+1);
448 for (i = 0; i < PyList_Size(list); i++) {
449 PyObject *item = PyList_GetItem(list, i);
450 if (!PyString_Check(item)) {
451 PyErr_SetString(PyExc_TypeError, "options should be strings");
454 ret[i] = PyString_AsString(item);
460 static int py_ldb_init(PyLdbObject *self, PyObject *args, PyObject *kwargs)
462 const char *kwnames[] = { "url", "flags", "options", NULL };
464 PyObject *py_options = Py_None;
465 const char **options;
468 struct ldb_context *ldb;
470 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO:Ldb.__init__", (char **)kwnames,
471 &url, &flags, &py_options))
474 ldb = PyLdb_AsLdbContext(self);
476 if (py_options == Py_None) {
479 options = PyList_AsStringList(ldb, py_options);
485 ret = ldb_connect(ldb, url, flags, options);
486 if (ret != LDB_SUCCESS) {
487 PyErr_SetLdbError(ret, ldb);
492 talloc_free(options);
496 static PyObject *py_ldb_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
498 struct ldb_context *ldb;
499 ldb = ldb_init(NULL, event_context_init(NULL));
505 return py_talloc_import(type, ldb);
508 static PyObject *py_ldb_connect(PyLdbObject *self, PyObject *args, PyObject *kwargs)
512 PyObject *py_options = Py_None;
514 const char **options;
515 const char *kwnames[] = { "url", "flags", "options", NULL };
516 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|iO", (char **)kwnames, &url, &flags,
520 if (py_options == Py_None) {
523 options = PyList_AsStringList(NULL, py_options);
528 ret = ldb_connect(PyLdb_AsLdbContext(self), url, flags, options);
529 talloc_free(options);
531 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, PyLdb_AsLdbContext(self));
536 static PyObject *py_ldb_modify(PyLdbObject *self, PyObject *args)
540 if (!PyArg_ParseTuple(args, "O", &py_msg))
543 if (!PyLdbMessage_Check(py_msg)) {
544 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message");
548 ret = ldb_modify(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg));
549 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, PyLdb_AsLdbContext(self));
554 static PyObject *py_ldb_add(PyLdbObject *self, PyObject *args)
558 Py_ssize_t dict_pos, msg_pos;
559 struct ldb_message_element *msgel;
560 struct ldb_message *msg;
561 PyObject *key, *value;
563 if (!PyArg_ParseTuple(args, "O", &py_msg))
566 if (PyDict_Check(py_msg)) {
567 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
568 msg = ldb_msg_new(NULL);
569 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
570 msg_pos = dict_pos = 0;
572 if (!PyObject_AsDn(msg, dn_value, PyLdb_AsLdbContext(self), &msg->dn)) {
573 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
576 if (msg->dn == NULL) {
577 PyErr_SetString(PyExc_TypeError, "dn set but not found");
582 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
583 char *key_str = PyString_AsString(key);
584 if (strcmp(key_str, "dn") != 0) {
585 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
587 PyErr_SetString(PyExc_TypeError, "unable to import element");
590 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
595 if (msg->dn == NULL) {
596 PyErr_SetString(PyExc_TypeError, "no dn set");
600 msg->num_elements = msg_pos;
602 msg = PyLdbMessage_AsMessage(py_msg);
605 ret = ldb_add(PyLdb_AsLdbContext(self), msg);
606 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, PyLdb_AsLdbContext(self));
613 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
618 struct ldb_context *ldb;
619 if (!PyArg_ParseTuple(args, "O", &py_dn))
622 ldb = PyLdb_AsLdbContext(self);
624 if (!PyObject_AsDn(NULL, py_dn, ldb, &dn))
627 ret = ldb_delete(ldb, dn);
628 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, ldb);
633 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
635 PyObject *py_dn1, *py_dn2;
636 struct ldb_dn *dn1, *dn2;
638 struct ldb_context *ldb;
639 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
642 ldb = PyLdb_AsLdbContext(self);
643 if (!PyObject_AsDn(NULL, py_dn1, ldb, &dn1))
646 if (!PyObject_AsDn(NULL, py_dn2, ldb, &dn2))
649 ret = ldb_rename(ldb, dn1, dn2);
650 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, ldb);
655 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
658 if (!PyArg_ParseTuple(args, "s", &name))
661 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
666 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
668 char *attribute, *syntax;
671 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
674 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
676 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, PyLdb_AsLdbContext(self));
681 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
686 /* We don't want this attached to the 'ldb' any more */
687 talloc_steal(NULL, ldif);
688 return Py_BuildValue((char *)"(iO)", ldif->changetype,
689 PyLdbMessage_FromMessage(ldif->msg));
694 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
697 struct ldb_ldif *ldif;
700 if (!PyArg_ParseTuple(args, "s", &s))
703 list = PyList_New(0);
704 while ((ldif = ldb_ldif_read_string(self->ptr, &s)) != NULL) {
705 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
707 return PyObject_GetIter(list);
710 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
712 const struct ldb_schema_attribute *a;
713 struct ldb_val old_val;
714 struct ldb_val new_val;
720 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
723 mem_ctx = talloc_new(NULL);
725 old_val.data = (uint8_t *)PyString_AsString(val);
726 old_val.length = PyString_Size(val);
728 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
734 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
735 talloc_free(mem_ctx);
739 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
741 talloc_free(mem_ctx);
746 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
748 PyObject *py_base = Py_None;
749 enum ldb_scope scope = LDB_SCOPE_DEFAULT;
751 PyObject *py_attrs = Py_None;
752 PyObject *py_controls = Py_None;
753 const char *kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
755 struct ldb_result *res;
756 struct ldb_request *req;
758 struct ldb_context *ldb_ctx;
759 struct ldb_control **parsed_controls;
762 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO", (char **)kwnames,
763 &py_base, &scope, &expr, &py_attrs, &py_controls))
766 ldb_ctx = PyLdb_AsLdbContext(self);
768 if (py_attrs == Py_None) {
771 attrs = PyList_AsStringList(ldb_ctx, py_attrs);
776 if (py_base == Py_None) {
777 base = ldb_get_default_basedn(ldb_ctx);
779 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base))
783 if (py_controls == Py_None) {
784 parsed_controls = NULL;
786 const char **controls = PyList_AsStringList(ldb_ctx, py_controls);
787 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
788 talloc_free(controls);
791 res = talloc_zero(ldb_ctx, struct ldb_result);
797 ret = ldb_build_search_req(&req, ldb_ctx, ldb_ctx,
804 ldb_search_default_callback,
807 if (ret != LDB_SUCCESS) {
809 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, ldb_ctx);
813 ret = ldb_request(ldb_ctx, req);
815 if (ret == LDB_SUCCESS) {
816 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
821 return PyLdbResult_FromResult(res);
824 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
829 if (!PyArg_ParseTuple(args, "s", &name))
832 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
837 /* FIXME: More interpretation */
842 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
847 if (!PyArg_ParseTuple(args, "sO", &name, &data))
850 /* FIXME: More interpretation */
852 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
857 static PyObject *py_ldb_modules(PyLdbObject *self)
859 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
860 PyObject *ret = PyList_New(0);
861 struct ldb_module *mod;
863 for (mod = ldb->modules; mod; mod = mod->next) {
864 PyList_Append(ret, PyLdbModule_FromModule(mod));
870 static PyMethodDef py_ldb_methods[] = {
871 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
872 "S.set_debug(callback) -> None\n"
873 "Set callback for LDB debug messages.\n"
874 "The callback should accept a debug level and debug text." },
875 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
876 "S.set_create_perms(mode) -> None\n"
877 "Set mode to use when creating new LDB files." },
878 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
879 "S.set_modules_dir(path) -> None\n"
880 "Set path LDB should search for modules" },
881 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
882 "S.transaction_start() -> None\n"
883 "Start a new transaction." },
884 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
885 "S.transaction_commit() -> None\n"
886 "commit a new transaction." },
887 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
888 "S.transaction_cancel() -> None\n"
889 "cancel a new transaction." },
890 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
892 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
894 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
896 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
898 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
900 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
901 "S.connect(url, flags=0, options=None) -> None\n"
902 "Connect to a LDB URL." },
903 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
904 "S.modify(message) -> None\n"
905 "Modify an entry." },
906 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
907 "S.add(message) -> None\n"
909 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
910 "S.delete(dn) -> None\n"
911 "Remove an entry." },
912 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
913 "S.rename(old_dn, new_dn) -> None\n"
914 "Rename an entry." },
915 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
916 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
917 "Search in a database.\n"
919 ":param base: Optional base DN to search\n"
920 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
921 ":param expression: Optional search expression\n"
922 ":param attrs: Attributes to return (defaults to all)\n"
923 ":param controls: Optional list of controls\n"
924 ":return: Iterator over Message objects\n"
926 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
928 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
930 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
932 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
933 "S.parse_ldif(ldif) -> iter(messages)\n"
934 "Parse a string formatted using LDIF." },
935 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
936 "S.get_opaque(name) -> value\n"
937 "Get an opaque value set on this LDB connection. \n"
938 ":note: The returned value may not be useful in Python."
940 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
941 "S.set_opaque(name, value) -> None\n"
942 "Set an opaque value on this LDB connection. \n"
943 ":note: Passing incorrect values may cause crashes." },
944 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
945 "S.modules() -> list\n"
946 "Return the list of modules on this LDB connection " },
950 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
952 return py_talloc_import(&PyLdbModule, mod);
955 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
957 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
960 static PyGetSetDef py_ldb_getset[] = {
961 { (char *)"firstmodule", (getter)py_ldb_get_firstmodule, NULL, NULL },
965 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
967 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
969 struct ldb_result *result;
973 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
976 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
977 if (ret != LDB_SUCCESS) {
978 PyErr_SetLdbError(ret, ldb_ctx);
982 count = result->count;
989 static PySequenceMethods py_ldb_seq = {
990 .sq_contains = (objobjproc)py_ldb_contains,
993 PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
995 return py_talloc_import(&PyLdb, ldb_ctx);
998 PyTypeObject PyLdb = {
1000 .tp_methods = py_ldb_methods,
1001 .tp_repr = (reprfunc)py_ldb_repr,
1002 .tp_new = py_ldb_new,
1003 .tp_init = (initproc)py_ldb_init,
1004 .tp_dealloc = py_talloc_dealloc,
1005 .tp_getset = py_ldb_getset,
1006 .tp_getattro = PyObject_GenericGetAttr,
1007 .tp_basicsize = sizeof(PyLdbObject),
1008 .tp_doc = "Connection to a LDB database.",
1009 .tp_as_sequence = &py_ldb_seq,
1010 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1013 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1015 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1018 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1020 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1023 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1025 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1029 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1031 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1035 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1037 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1041 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1043 PyObject *py_base, *py_tree, *py_attrs;
1045 struct ldb_request *req;
1046 const char *kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1047 struct ldb_module *mod;
1048 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO", (char **)kwnames,
1049 &py_base, &scope, &py_tree, &py_attrs))
1054 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1055 scope, NULL /* expr */, py_attrs == Py_None?NULL:PyList_AsStringList(req, py_attrs),
1056 NULL /* controls */, NULL, NULL, NULL);
1057 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, mod->ldb);
1059 ret = mod->ops->search(mod, req);
1062 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, mod->ldb);
1064 return PyLdbResult_FromResult(req->op.search.res);
1068 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1070 struct ldb_request *req;
1071 PyObject *py_message;
1073 struct ldb_module *mod;
1075 if (!PyArg_ParseTuple(args, "O", &py_message))
1078 req = talloc_zero(NULL, struct ldb_request);
1079 req->operation = LDB_ADD;
1080 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1082 mod = PyLdbModule_AsModule(self);
1083 ret = mod->ops->add(mod, req);
1085 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, mod->ldb);
1090 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1093 struct ldb_request *req;
1094 PyObject *py_message;
1095 struct ldb_module *mod;
1097 if (!PyArg_ParseTuple(args, "O", &py_message))
1100 req = talloc_zero(NULL, struct ldb_request);
1101 req->operation = LDB_MODIFY;
1102 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1104 mod = PyLdbModule_AsModule(self);
1105 ret = mod->ops->modify(mod, req);
1107 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, mod->ldb);
1112 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1115 struct ldb_request *req;
1118 if (!PyArg_ParseTuple(args, "O", &py_dn))
1121 req = talloc_zero(NULL, struct ldb_request);
1122 req->operation = LDB_DELETE;
1123 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1125 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1127 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, NULL);
1132 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1135 struct ldb_request *req;
1136 PyObject *py_dn1, *py_dn2;
1138 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1141 req = talloc_zero(NULL, struct ldb_request);
1143 req->operation = LDB_RENAME;
1144 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1145 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1147 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1149 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, NULL);
1154 static PyMethodDef py_ldb_module_methods[] = {
1155 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1156 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1157 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1158 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1159 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1160 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1161 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1162 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1166 PyTypeObject PyLdbModule = {
1167 .tp_name = "LdbModule",
1168 .tp_methods = py_ldb_module_methods,
1169 .tp_repr = (reprfunc)py_ldb_module_repr,
1170 .tp_str = (reprfunc)py_ldb_module_str,
1171 .tp_basicsize = sizeof(py_talloc_Object),
1172 .tp_dealloc = py_talloc_dealloc,
1173 .tp_flags = Py_TPFLAGS_DEFAULT,
1176 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1177 PyObject *set_obj, int flags,
1178 const char *attr_name)
1180 struct ldb_message_element *me;
1182 if (PyLdbMessageElement_Check(set_obj))
1183 return PyLdbMessageElement_AsMessageElement(set_obj);
1185 me = talloc(mem_ctx, struct ldb_message_element);
1187 me->name = attr_name;
1189 if (PyString_Check(set_obj)) {
1191 me->values = talloc_array(me, struct ldb_val, me->num_values);
1192 me->values[0].length = PyString_Size(set_obj);
1193 me->values[0].data = (uint8_t *)talloc_strdup(me->values,
1194 PyString_AsString(set_obj));
1195 } else if (PySequence_Check(set_obj)) {
1197 me->num_values = PySequence_Size(set_obj);
1198 me->values = talloc_array(me, struct ldb_val, me->num_values);
1199 for (i = 0; i < me->num_values; i++) {
1200 PyObject *obj = PySequence_GetItem(set_obj, i);
1201 me->values[i].length = PyString_Size(obj);
1202 me->values[i].data = (uint8_t *)PyString_AsString(obj);
1213 PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1214 struct ldb_message_element *me)
1219 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1220 result = PyList_New(me->num_values);
1222 for (i = 0; i < me->num_values; i++) {
1223 PyList_SetItem(result, i,
1224 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1230 PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1233 if (!PyArg_ParseTuple(args, "i", &i))
1235 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1238 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1239 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1242 static PyMethodDef py_ldb_msg_element_methods[] = {
1243 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1247 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1249 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1252 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1254 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1255 if (idx < 0 || idx >= el->num_values) {
1256 PyErr_SetString(PyExc_IndexError, "Out of range");
1259 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1262 static PySequenceMethods py_ldb_msg_element_seq = {
1263 .sq_length = (lenfunc)py_ldb_msg_element_len,
1264 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1267 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1269 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1270 PyLdbMessageElement_AsMessageElement(other));
1273 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1275 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1278 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el)
1280 return py_talloc_import(&PyLdbMessageElement, el);
1283 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1285 PyObject *py_elements = NULL;
1286 struct ldb_message_element *el;
1289 const char *kwnames[] = { "elements", "flags", "name", NULL };
1290 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois", (char **)kwnames, &py_elements, &flags, &name))
1293 el = talloc_zero(NULL, struct ldb_message_element);
1295 if (py_elements != NULL) {
1297 if (!PySequence_Check(py_elements)) {
1299 el->values = talloc_array(el, struct ldb_val, 1);
1300 el->values[0].data = (uint8_t *)PyString_AsString(py_elements);
1301 el->values[0].length = PyString_Size(py_elements);
1303 el->num_values = PySequence_Size(py_elements);
1304 el->values = talloc_array(el, struct ldb_val, el->num_values);
1305 for (i = 0; i < el->num_values; i++) {
1306 PyObject *item = PySequence_GetItem(py_elements, i);
1307 el->values[i].data = (uint8_t *)PyString_AsString(item);
1308 el->values[i].length = PyString_Size(item);
1314 el->name = talloc_strdup(el, name);
1316 return py_talloc_import(&PyLdbMessageElement, el);
1319 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1321 char *element_str = NULL;
1323 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1326 for (i = 0; i < el->num_values; i++) {
1327 PyObject *o = py_ldb_msg_element_find(self, i);
1328 if (element_str == NULL)
1329 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1331 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1334 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1336 talloc_free(element_str);
1341 PyTypeObject PyLdbMessageElement = {
1342 .tp_name = "MessageElement",
1343 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1344 .tp_dealloc = py_talloc_dealloc,
1345 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1346 .tp_methods = py_ldb_msg_element_methods,
1347 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1348 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1349 .tp_as_sequence = &py_ldb_msg_element_seq,
1350 .tp_new = py_ldb_msg_element_new,
1351 .tp_flags = Py_TPFLAGS_DEFAULT,
1354 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1357 if (!PyArg_ParseTuple(args, "s", &name))
1360 ldb_msg_remove_attr(self->ptr, name);
1365 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1367 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1369 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1370 if (msg->dn != NULL) {
1371 PyList_SetItem(obj, j, PyString_FromString("dn"));
1374 for (i = 0; i < msg->num_elements; i++) {
1375 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1381 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1383 struct ldb_message_element *el;
1384 char *name = PyString_AsString(py_name);
1385 if (!strcmp(name, "dn"))
1386 return PyLdbDn_FromDn(PyLdbMessage_AsMessage(self)->dn);
1387 el = ldb_msg_find_element(PyLdbMessage_AsMessage(self), name);
1391 return (PyObject *)PyLdbMessageElement_FromMessageElement(el);
1394 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1396 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1398 PyErr_SetString(PyExc_KeyError, "No such element");
1404 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1406 PyObject *name, *ret;
1407 if (!PyArg_ParseTuple(args, "O", &name))
1410 ret = py_ldb_msg_getitem_helper(self, name);
1416 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1418 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1420 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1422 if (msg->dn != NULL) {
1423 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1426 for (i = 0; i < msg->num_elements; i++, j++) {
1427 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i])));
1432 static PyMethodDef py_ldb_msg_methods[] = {
1433 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1434 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1435 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
1436 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
1440 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
1442 PyObject *list, *iter;
1444 list = py_ldb_msg_keys(self);
1445 iter = PyObject_GetIter(list);
1450 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
1452 char *attr_name = PyString_AsString(name);
1453 if (value == NULL) {
1454 ldb_msg_remove_attr(self->ptr, attr_name);
1456 struct ldb_message_element *el = PyObject_AsMessageElement(NULL,
1457 value, 0, attr_name);
1460 talloc_steal(self->ptr, el);
1461 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
1462 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
1467 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
1469 return PyLdbMessage_AsMessage(self)->num_elements;
1472 static PyMappingMethods py_ldb_msg_mapping = {
1473 .mp_length = (lenfunc)py_ldb_msg_length,
1474 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
1475 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
1478 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1480 const char *kwnames[] = { "dn", NULL };
1481 struct ldb_message *ret;
1482 PyObject *pydn = NULL;
1483 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O", (char **)kwnames, &pydn))
1486 ret = ldb_msg_new(NULL);
1493 if (!PyObject_AsDn(NULL, pydn, NULL, &ret->dn))
1496 return py_talloc_import(type, ret);
1499 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
1501 return py_talloc_import(&PyLdbMessage, msg);
1504 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
1506 return PyLdbDn_FromDn(PyLdbMessage_AsMessage(self)->dn);
1509 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
1511 PyLdbMessage_AsMessage(self)->dn = PyLdbDn_AsDn(value);
1515 static PyGetSetDef py_ldb_msg_getset[] = {
1516 { (char *)"dn", (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
1520 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
1522 PyObject *dict = PyDict_New(), *ret;
1523 if (PyDict_Update(dict, (PyObject *)self) != 0)
1525 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
1530 PyTypeObject PyLdbMessage = {
1531 .tp_name = "Message",
1532 .tp_methods = py_ldb_msg_methods,
1533 .tp_getset = py_ldb_msg_getset,
1534 .tp_as_mapping = &py_ldb_msg_mapping,
1535 .tp_basicsize = sizeof(PyLdbMessageObject),
1536 .tp_dealloc = py_talloc_dealloc,
1537 .tp_new = py_ldb_msg_new,
1538 .tp_repr = (reprfunc)py_ldb_msg_repr,
1539 .tp_flags = Py_TPFLAGS_DEFAULT,
1540 .tp_iter = (getiterfunc)py_ldb_msg_iter,
1543 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
1545 return py_talloc_import(&PyLdbTree, tree);
1548 PyTypeObject PyLdbTree = {
1550 .tp_basicsize = sizeof(PyLdbTreeObject),
1551 .tp_dealloc = py_talloc_dealloc,
1552 .tp_flags = Py_TPFLAGS_DEFAULT,
1556 int py_module_search(struct ldb_module *mod, struct ldb_request *req)
1558 PyObject *py_ldb = mod->private_data;
1559 PyObject *py_result, *py_base, *py_attrs, *py_tree;
1561 py_base = PyLdbDn_FromDn(req->op.search.base);
1563 if (py_base == NULL)
1564 return LDB_ERR_OPERATIONS_ERROR;
1566 py_tree = PyLdbTree_FromTree(req->op.search.tree);
1568 if (py_tree == NULL)
1569 return LDB_ERR_OPERATIONS_ERROR;
1571 if (req->op.search.attrs == NULL) {
1575 for (len = 0; req->op.search.attrs[len]; len++);
1576 py_attrs = PyList_New(len);
1577 for (i = 0; i < len; i++)
1578 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
1581 py_result = PyObject_CallMethod(py_ldb, (char *)"search", (char *)"OiOO", py_base, req->op.search.scope, py_tree, py_attrs);
1583 Py_DECREF(py_attrs);
1587 if (py_result == NULL) {
1588 return LDB_ERR_PYTHON_EXCEPTION;
1591 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
1592 if (req->op.search.res == NULL) {
1593 return LDB_ERR_PYTHON_EXCEPTION;
1596 Py_DECREF(py_result);
1601 int py_module_add(struct ldb_module *mod, struct ldb_request *req)
1603 PyObject *py_ldb = mod->private_data;
1604 PyObject *py_result, *py_msg;
1606 py_msg = PyLdbMessage_FromMessage((struct ldb_message *)req->op.add.message);
1608 if (py_msg == NULL) {
1609 return LDB_ERR_OPERATIONS_ERROR;
1612 py_result = PyObject_CallMethod(py_ldb, (char *)"add", (char *)"O", py_msg);
1616 if (py_result == NULL) {
1617 return LDB_ERR_PYTHON_EXCEPTION;
1620 Py_DECREF(py_result);
1625 int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
1627 PyObject *py_ldb = mod->private_data;
1628 PyObject *py_result, *py_msg;
1630 py_msg = PyLdbMessage_FromMessage((struct ldb_message *)req->op.mod.message);
1632 if (py_msg == NULL) {
1633 return LDB_ERR_OPERATIONS_ERROR;
1636 py_result = PyObject_CallMethod(py_ldb, (char *)"modify", (char *)"O", py_msg);
1640 if (py_result == NULL) {
1641 return LDB_ERR_PYTHON_EXCEPTION;
1644 Py_DECREF(py_result);
1649 int py_module_del(struct ldb_module *mod, struct ldb_request *req)
1651 PyObject *py_ldb = mod->private_data;
1652 PyObject *py_result, *py_dn;
1654 py_dn = PyLdbDn_FromDn(req->op.del.dn);
1657 return LDB_ERR_OPERATIONS_ERROR;
1659 py_result = PyObject_CallMethod(py_ldb, (char *)"delete", (char *)"O", py_dn);
1661 if (py_result == NULL) {
1662 return LDB_ERR_PYTHON_EXCEPTION;
1665 Py_DECREF(py_result);
1670 int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
1672 PyObject *py_ldb = mod->private_data;
1673 PyObject *py_result, *py_olddn, *py_newdn;
1675 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
1677 if (py_olddn == NULL)
1678 return LDB_ERR_OPERATIONS_ERROR;
1680 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
1682 if (py_newdn == NULL)
1683 return LDB_ERR_OPERATIONS_ERROR;
1685 py_result = PyObject_CallMethod(py_ldb, (char *)"rename", (char *)"OO", py_olddn, py_newdn);
1687 Py_DECREF(py_olddn);
1688 Py_DECREF(py_newdn);
1690 if (py_result == NULL) {
1691 return LDB_ERR_PYTHON_EXCEPTION;
1694 Py_DECREF(py_result);
1699 int py_module_request(struct ldb_module *mod, struct ldb_request *req)
1701 PyObject *py_ldb = mod->private_data;
1702 PyObject *py_result;
1704 py_result = PyObject_CallMethod(py_ldb, (char *)"request", (char *)"");
1706 return LDB_ERR_OPERATIONS_ERROR;
1709 int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
1711 PyObject *py_ldb = mod->private_data;
1712 PyObject *py_result;
1714 py_result = PyObject_CallMethod(py_ldb, (char *)"extended", (char *)"");
1716 return LDB_ERR_OPERATIONS_ERROR;
1719 int py_module_start_transaction(struct ldb_module *mod)
1721 PyObject *py_ldb = mod->private_data;
1722 PyObject *py_result;
1724 py_result = PyObject_CallMethod(py_ldb, (char *)"start_transaction", (char *)"");
1726 if (py_result == NULL) {
1727 return LDB_ERR_PYTHON_EXCEPTION;
1730 Py_DECREF(py_result);
1735 int py_module_end_transaction(struct ldb_module *mod)
1737 PyObject *py_ldb = mod->private_data;
1738 PyObject *py_result;
1740 py_result = PyObject_CallMethod(py_ldb, (char *)"end_transaction", (char *)"");
1742 if (py_result == NULL) {
1743 return LDB_ERR_PYTHON_EXCEPTION;
1746 Py_DECREF(py_result);
1751 int py_module_del_transaction(struct ldb_module *mod)
1753 PyObject *py_ldb = mod->private_data;
1754 PyObject *py_result;
1756 py_result = PyObject_CallMethod(py_ldb, (char *)"del_transaction", (char *)"");
1758 if (py_result == NULL) {
1759 return LDB_ERR_PYTHON_EXCEPTION;
1762 Py_DECREF(py_result);
1767 static int py_module_destructor(struct ldb_module *mod)
1769 Py_DECREF((PyObject *)mod->private_data);
1773 int py_module_init (struct ldb_module *mod)
1775 PyObject *py_class = mod->ops->private_data;
1776 PyObject *py_result, *py_next, *py_ldb;
1778 py_ldb = PyLdb_FromLdbContext(mod->ldb);
1781 return LDB_ERR_OPERATIONS_ERROR;
1783 py_next = PyLdbModule_FromModule(mod->next);
1785 if (py_next == NULL)
1786 return LDB_ERR_OPERATIONS_ERROR;
1788 py_result = PyObject_CallFunction(py_class, (char *)"OO", py_ldb, py_next);
1790 if (py_result == NULL) {
1791 return LDB_ERR_PYTHON_EXCEPTION;
1794 mod->private_data = py_result;
1796 talloc_set_destructor(mod, py_module_destructor);
1798 return ldb_next_init(mod);
1801 static PyObject *py_register_module(PyObject *module, PyObject *args)
1804 struct ldb_module_ops *ops;
1807 if (!PyArg_ParseTuple(args, "O", &input))
1810 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
1816 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, (char *)"name")));
1819 ops->private_data = input;
1820 ops->init_context = py_module_init;
1821 ops->search = py_module_search;
1822 ops->add = py_module_add;
1823 ops->modify = py_module_modify;
1824 ops->del = py_module_del;
1825 ops->rename = py_module_rename;
1826 ops->request = py_module_request;
1827 ops->extended = py_module_extended;
1828 ops->start_transaction = py_module_start_transaction;
1829 ops->end_transaction = py_module_end_transaction;
1830 ops->del_transaction = py_module_del_transaction;
1832 ret = ldb_register_module(ops);
1834 PyErr_LDB_ERROR_IS_ERR_RAISE(ret, NULL);
1839 static PyObject *py_timestring(PyObject *module, PyObject *args)
1844 if (!PyArg_ParseTuple(args, "L", &t))
1846 tresult = ldb_timestring(NULL, t);
1847 ret = PyString_FromString(tresult);
1848 talloc_free(tresult);
1852 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
1855 if (!PyArg_ParseTuple(args, "s", &str))
1858 return PyInt_FromLong(ldb_string_to_time(str));
1861 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
1864 if (!PyArg_ParseTuple(args, "s", &name))
1866 return PyBool_FromLong(ldb_valid_attr_name(name));
1869 static PyMethodDef py_ldb_global_methods[] = {
1870 { "register_module", py_register_module, METH_VARARGS,
1871 "S.register_module(module) -> None\n"
1872 "Register a LDB module."},
1873 { "timestring", py_timestring, METH_VARARGS,
1874 "S.timestring(int) -> string\n"
1875 "Generate a LDAP time string from a UNIX timestamp" },
1876 { "string_to_time", py_string_to_time, METH_VARARGS,
1877 "S.string_to_time(string) -> int\n"
1878 "Parse a LDAP time string into a UNIX timestamp." },
1879 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
1880 "S.valid_attr_name(name) -> bool\n"
1881 "Check whether the supplied name is a valid attribute name." },
1882 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
1891 if (PyType_Ready(&PyLdbDn) < 0)
1894 if (PyType_Ready(&PyLdbMessage) < 0)
1897 if (PyType_Ready(&PyLdbMessageElement) < 0)
1900 if (PyType_Ready(&PyLdb) < 0)
1903 if (PyType_Ready(&PyLdbModule) < 0)
1906 if (PyType_Ready(&PyLdbTree) < 0)
1909 m = Py_InitModule3("ldb", py_ldb_global_methods,
1910 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
1914 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
1915 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
1916 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
1917 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
1919 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
1920 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
1921 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
1922 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
1924 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
1925 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
1926 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
1927 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
1928 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
1929 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
1930 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
1931 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
1932 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
1933 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
1934 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
1935 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
1936 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
1937 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
1938 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
1939 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
1940 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
1941 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
1942 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
1943 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
1944 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
1945 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
1946 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
1947 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
1948 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
1949 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
1950 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
1951 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
1952 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
1953 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
1954 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
1955 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
1956 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
1957 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
1958 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
1959 PyModule_AddObject(m, "ERR_ENTYR_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
1960 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
1961 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
1963 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
1965 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
1967 PyExc_LdbError = PyErr_NewException((char *)"_ldb.LdbError", NULL, NULL);
1968 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
1971 Py_INCREF(&PyLdbDn);
1972 Py_INCREF(&PyLdbModule);
1973 Py_INCREF(&PyLdbMessage);
1974 Py_INCREF(&PyLdbMessageElement);
1975 Py_INCREF(&PyLdbTree);
1977 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
1978 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
1979 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
1980 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
1981 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
1982 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);