s4:ldb Add python binding and test for ldb_msg_diff()
[Samba.git] / source4 / lib / ldb / pyldb.c
blob67e1d5c9e090e84da7c129e726b0f6ff50320321
1 /*
2 Unix SMB/CIFS implementation.
4 Python interface to ldb.
6 Copyright (C) 2005,2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2006 Simo Sorce <idra@samba.org>
8 Copyright (C) 2007-2009 Jelmer Vernooij <jelmer@samba.org>
9 Copyright (C) 2009 Matthias Dieter Wallnöfer
11 ** NOTE! The following LGPL license applies to the ldb
12 ** library. This does NOT imply that all of Samba is released
13 ** under the LGPL
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/>.
29 #include "replace.h"
30 #include "ldb_private.h"
31 #include <Python.h>
32 #include "pyldb.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;
39 #endif
41 #ifndef Py_RETURN_NONE
42 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
43 #endif
45 static void PyErr_SetLdbError(PyObject *error, int ret, struct ldb_context *ldb_ctx)
47 if (ret == LDB_ERR_PYTHON_EXCEPTION)
48 return; /* Python exception should already be set, just keep that */
50 PyErr_SetObject(error,
51 Py_BuildValue(discard_const_p(char, "(i,s)"), ret,
52 ldb_ctx == NULL?ldb_strerror(ret):ldb_errstring(ldb_ctx)));
55 static PyObject *PyExc_LdbError;
57 PyAPI_DATA(PyTypeObject) PyLdbMessage;
58 PyAPI_DATA(PyTypeObject) PyLdbModule;
59 PyAPI_DATA(PyTypeObject) PyLdbDn;
60 PyAPI_DATA(PyTypeObject) PyLdb;
61 PyAPI_DATA(PyTypeObject) PyLdbMessageElement;
62 PyAPI_DATA(PyTypeObject) PyLdbTree;
64 static PyObject *PyObject_FromLdbValue(struct ldb_context *ldb_ctx,
65 struct ldb_message_element *el,
66 struct ldb_val *val)
68 struct ldb_val new_val;
69 TALLOC_CTX *mem_ctx = talloc_new(NULL);
70 PyObject *ret;
72 new_val = *val;
74 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
76 talloc_free(mem_ctx);
78 return ret;
81 /**
82 * Obtain a ldb DN from a Python object.
84 * @param mem_ctx Memory context
85 * @param object Python object
86 * @param ldb_ctx LDB context
87 * @return Whether or not the conversion succeeded
89 bool PyObject_AsDn(TALLOC_CTX *mem_ctx, PyObject *object,
90 struct ldb_context *ldb_ctx, struct ldb_dn **dn)
92 struct ldb_dn *odn;
94 if (ldb_ctx != NULL && PyString_Check(object)) {
95 odn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
96 *dn = odn;
97 return true;
100 if (PyLdbDn_Check(object)) {
101 *dn = PyLdbDn_AsDn(object);
102 return true;
105 PyErr_SetString(PyExc_TypeError, "Expected DN");
106 return false;
110 * Create a Python object from a ldb_result.
112 * @param result LDB result to convert
113 * @return Python object with converted result (a list object)
115 static PyObject *PyLdbResult_FromResult(struct ldb_result *result)
117 PyObject *ret;
118 int i;
119 if (result == NULL) {
120 Py_RETURN_NONE;
122 ret = PyList_New(result->count);
123 for (i = 0; i < result->count; i++) {
124 PyList_SetItem(ret, i, PyLdbMessage_FromMessage(result->msgs[i])
127 return ret;
131 * Create a LDB Result from a Python object.
132 * If conversion fails, NULL will be returned and a Python exception set.
134 * @param mem_ctx Memory context in which to allocate the LDB Result
135 * @param obj Python object to convert
136 * @return a ldb_result, or NULL if the conversion failed
138 static struct ldb_result *PyLdbResult_AsResult(TALLOC_CTX *mem_ctx,
139 PyObject *obj)
141 struct ldb_result *res;
142 int i;
144 if (obj == Py_None)
145 return NULL;
147 res = talloc_zero(mem_ctx, struct ldb_result);
148 res->count = PyList_Size(obj);
149 res->msgs = talloc_array(res, struct ldb_message *, res->count);
150 for (i = 0; i < res->count; i++) {
151 PyObject *item = PyList_GetItem(obj, i);
152 res->msgs[i] = PyLdbMessage_AsMessage(item);
154 return res;
157 static PyObject *py_ldb_dn_validate(PyLdbDnObject *self)
159 return PyBool_FromLong(ldb_dn_validate(self->dn));
162 static PyObject *py_ldb_dn_is_valid(PyLdbDnObject *self)
164 return PyBool_FromLong(ldb_dn_is_valid(self->dn));
167 static PyObject *py_ldb_dn_is_special(PyLdbDnObject *self)
169 return PyBool_FromLong(ldb_dn_is_special(self->dn));
172 static PyObject *py_ldb_dn_is_null(PyLdbDnObject *self)
174 return PyBool_FromLong(ldb_dn_is_null(self->dn));
177 static PyObject *py_ldb_dn_get_casefold(PyLdbDnObject *self)
179 return PyString_FromString(ldb_dn_get_casefold(self->dn));
182 static PyObject *py_ldb_dn_get_linearized(PyLdbDnObject *self)
184 return PyString_FromString(ldb_dn_get_linearized(self->dn));
187 static PyObject *py_ldb_dn_canonical_str(PyLdbDnObject *self)
189 return PyString_FromString(ldb_dn_canonical_string(self->dn, self->dn));
192 static PyObject *py_ldb_dn_canonical_ex_str(PyLdbDnObject *self)
194 return PyString_FromString(ldb_dn_canonical_ex_string(self->dn, self->dn));
197 static PyObject *py_ldb_dn_repr(PyLdbDnObject *self)
199 return PyString_FromFormat("Dn(%s)", PyObject_REPR(PyString_FromString(ldb_dn_get_linearized(self->dn))));
202 static PyObject *py_ldb_dn_check_special(PyLdbDnObject *self, PyObject *args)
204 char *name;
206 if (!PyArg_ParseTuple(args, "s", &name))
207 return NULL;
209 return ldb_dn_check_special(self->dn, name)?Py_True:Py_False;
212 static int py_ldb_dn_compare(PyLdbDnObject *dn1, PyLdbDnObject *dn2)
214 int ret;
215 ret = ldb_dn_compare(dn1->dn, dn2->dn);
216 if (ret < 0) ret = -1;
217 if (ret > 0) ret = 1;
218 return ret;
221 static PyObject *py_ldb_dn_get_parent(PyLdbDnObject *self)
223 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self);
224 struct ldb_dn *parent;
225 PyLdbDnObject *py_ret;
226 TALLOC_CTX *mem_ctx = talloc_new(NULL);
228 parent = ldb_dn_get_parent(mem_ctx, dn);
229 if (parent == NULL) {
230 talloc_free(mem_ctx);
231 Py_RETURN_NONE;
234 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
235 if (py_ret == NULL) {
236 PyErr_NoMemory();
237 talloc_free(mem_ctx);
238 return NULL;
240 py_ret->mem_ctx = mem_ctx;
241 py_ret->dn = parent;
242 return (PyObject *)py_ret;
245 #define dn_ldb_ctx(dn) ((struct ldb_context *)dn)
247 static PyObject *py_ldb_dn_add_child(PyLdbDnObject *self, PyObject *args)
249 PyObject *py_other;
250 struct ldb_dn *dn, *other;
251 if (!PyArg_ParseTuple(args, "O", &py_other))
252 return NULL;
254 dn = PyLdbDn_AsDn((PyObject *)self);
256 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
257 return NULL;
259 return ldb_dn_add_child(dn, other)?Py_True:Py_False;
262 static PyObject *py_ldb_dn_add_base(PyLdbDnObject *self, PyObject *args)
264 PyObject *py_other;
265 struct ldb_dn *other, *dn;
266 if (!PyArg_ParseTuple(args, "O", &py_other))
267 return NULL;
269 dn = PyLdbDn_AsDn((PyObject *)self);
271 if (!PyObject_AsDn(NULL, py_other, dn_ldb_ctx(dn), &other))
272 return NULL;
274 return ldb_dn_add_base(dn, other)?Py_True:Py_False;
277 static PyMethodDef py_ldb_dn_methods[] = {
278 { "validate", (PyCFunction)py_ldb_dn_validate, METH_NOARGS,
279 "S.validate() -> bool\n"
280 "Validate DN is correct." },
281 { "is_valid", (PyCFunction)py_ldb_dn_is_valid, METH_NOARGS,
282 "S.is_valid() -> bool\n" },
283 { "is_special", (PyCFunction)py_ldb_dn_is_special, METH_NOARGS,
284 "S.is_special() -> bool\n"
285 "Check whether this is a special LDB DN." },
286 { "is_null", (PyCFunction)py_ldb_dn_is_null, METH_NOARGS,
287 "Check whether this is a null DN." },
288 { "get_casefold", (PyCFunction)py_ldb_dn_get_casefold, METH_NOARGS,
289 NULL },
290 { "get_linearized", (PyCFunction)py_ldb_dn_get_linearized, METH_NOARGS,
291 NULL },
292 { "canonical_str", (PyCFunction)py_ldb_dn_canonical_str, METH_NOARGS,
293 "S.canonical_str() -> string\n"
294 "Canonical version of this DN (like a posix path)." },
295 { "canonical_ex_str", (PyCFunction)py_ldb_dn_canonical_ex_str, METH_NOARGS,
296 "S.canonical_ex_str() -> string\n"
297 "Canonical version of this DN (like a posix path, with terminating newline)." },
298 { "check_special", (PyCFunction)py_ldb_dn_is_special, METH_VARARGS,
299 NULL },
300 { "parent", (PyCFunction)py_ldb_dn_get_parent, METH_NOARGS,
301 "S.parent() -> dn\n"
302 "Get the parent for this DN." },
303 { "add_child", (PyCFunction)py_ldb_dn_add_child, METH_VARARGS,
304 "S.add_child(dn) -> None\n"
305 "Add a child DN to this DN." },
306 { "add_base", (PyCFunction)py_ldb_dn_add_base, METH_VARARGS,
307 "S.add_base(dn) -> None\n"
308 "Add a base DN to this DN." },
309 { "check_special", (PyCFunction)py_ldb_dn_check_special, METH_VARARGS,
310 NULL },
311 { NULL }
314 static Py_ssize_t py_ldb_dn_len(PyLdbDnObject *self)
316 return ldb_dn_get_comp_num(PyLdbDn_AsDn((PyObject *)self));
319 static PyObject *py_ldb_dn_concat(PyLdbDnObject *self, PyObject *py_other)
321 struct ldb_dn *dn = PyLdbDn_AsDn((PyObject *)self),
322 *other;
323 PyLdbDnObject *py_ret;
325 if (!PyObject_AsDn(NULL, py_other, NULL, &other))
326 return NULL;
328 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
329 if (py_ret == NULL) {
330 PyErr_NoMemory();
331 return NULL;
333 py_ret->mem_ctx = talloc_new(NULL);
334 py_ret->dn = ldb_dn_copy(py_ret->mem_ctx, dn);
335 ldb_dn_add_child(py_ret->dn, other);
336 return (PyObject *)py_ret;
339 static PySequenceMethods py_ldb_dn_seq = {
340 .sq_length = (lenfunc)py_ldb_dn_len,
341 .sq_concat = (binaryfunc)py_ldb_dn_concat,
344 static PyObject *py_ldb_dn_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
346 struct ldb_dn *ret;
347 char *str;
348 PyObject *py_ldb;
349 struct ldb_context *ldb_ctx;
350 TALLOC_CTX *mem_ctx;
351 PyLdbDnObject *py_ret;
352 const char * const kwnames[] = { "ldb", "dn", NULL };
354 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Os",
355 discard_const_p(char *, kwnames),
356 &py_ldb, &str))
357 return NULL;
359 ldb_ctx = PyLdb_AsLdbContext(py_ldb);
361 mem_ctx = talloc_new(NULL);
362 if (mem_ctx == NULL) {
363 PyErr_NoMemory();
364 return NULL;
367 ret = ldb_dn_new(mem_ctx, ldb_ctx, str);
369 if (ret == NULL || !ldb_dn_validate(ret)) {
370 talloc_free(mem_ctx);
371 PyErr_SetString(PyExc_ValueError, "unable to parse dn string");
372 return NULL;
375 py_ret = (PyLdbDnObject *)type->tp_alloc(type, 0);
376 if (ret == NULL) {
377 talloc_free(mem_ctx);
378 PyErr_NoMemory();
379 return NULL;
381 py_ret->mem_ctx = mem_ctx;
382 py_ret->dn = ret;
383 return (PyObject *)py_ret;
386 PyObject *PyLdbDn_FromDn(struct ldb_dn *dn)
388 PyLdbDnObject *py_ret;
390 if (dn == NULL) {
391 Py_RETURN_NONE;
394 py_ret = (PyLdbDnObject *)PyLdbDn.tp_alloc(&PyLdbDn, 0);
395 if (py_ret == NULL) {
396 PyErr_NoMemory();
397 return NULL;
399 py_ret->mem_ctx = talloc_new(NULL);
400 py_ret->dn = talloc_reference(py_ret->mem_ctx, dn);
401 return (PyObject *)py_ret;
404 static void py_ldb_dn_dealloc(PyLdbDnObject *self)
406 talloc_free(self->mem_ctx);
407 self->ob_type->tp_free(self);
410 PyTypeObject PyLdbDn = {
411 .tp_name = "Dn",
412 .tp_methods = py_ldb_dn_methods,
413 .tp_str = (reprfunc)py_ldb_dn_get_linearized,
414 .tp_repr = (reprfunc)py_ldb_dn_repr,
415 .tp_compare = (cmpfunc)py_ldb_dn_compare,
416 .tp_as_sequence = &py_ldb_dn_seq,
417 .tp_doc = "A LDB distinguished name.",
418 .tp_new = py_ldb_dn_new,
419 .tp_dealloc = (destructor)py_ldb_dn_dealloc,
420 .tp_basicsize = sizeof(PyLdbObject),
421 .tp_flags = Py_TPFLAGS_DEFAULT,
424 /* Debug */
425 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
426 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
428 PyObject *fn = (PyObject *)context;
429 PyObject_CallFunction(fn, discard_const_p(char, "(i,O)"), level, PyString_FromFormatV(fmt, ap));
432 static PyObject *py_ldb_set_debug(PyLdbObject *self, PyObject *args)
434 PyObject *cb;
436 if (!PyArg_ParseTuple(args, "O", &cb))
437 return NULL;
439 Py_INCREF(cb);
440 /* FIXME: Where do we DECREF cb ? */
441 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_set_debug(self->ldb_ctx, py_ldb_debug, cb), PyLdb_AsLdbContext(self));
443 Py_RETURN_NONE;
446 static PyObject *py_ldb_set_create_perms(PyTypeObject *self, PyObject *args)
448 unsigned int perms;
449 if (!PyArg_ParseTuple(args, "I", &perms))
450 return NULL;
452 ldb_set_create_perms(PyLdb_AsLdbContext(self), perms);
454 Py_RETURN_NONE;
457 static PyObject *py_ldb_set_modules_dir(PyTypeObject *self, PyObject *args)
459 char *modules_dir;
460 if (!PyArg_ParseTuple(args, "s", &modules_dir))
461 return NULL;
463 ldb_set_modules_dir(PyLdb_AsLdbContext(self), modules_dir);
465 Py_RETURN_NONE;
468 static PyObject *py_ldb_transaction_start(PyLdbObject *self)
470 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_start(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
471 Py_RETURN_NONE;
474 static PyObject *py_ldb_transaction_commit(PyLdbObject *self)
476 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_commit(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
477 Py_RETURN_NONE;
480 static PyObject *py_ldb_transaction_cancel(PyLdbObject *self)
482 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_transaction_cancel(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
483 Py_RETURN_NONE;
486 static PyObject *py_ldb_setup_wellknown_attributes(PyLdbObject *self)
488 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ldb_setup_wellknown_attributes(PyLdb_AsLdbContext(self)), PyLdb_AsLdbContext(self));
489 Py_RETURN_NONE;
492 static PyObject *py_ldb_repr(PyLdbObject *self)
494 return PyString_FromFormat("<ldb connection>");
497 static PyObject *py_ldb_get_root_basedn(PyLdbObject *self)
499 struct ldb_dn *dn = ldb_get_root_basedn(PyLdb_AsLdbContext(self));
500 if (dn == NULL)
501 Py_RETURN_NONE;
502 return PyLdbDn_FromDn(dn);
506 static PyObject *py_ldb_get_schema_basedn(PyLdbObject *self)
508 struct ldb_dn *dn = ldb_get_schema_basedn(PyLdb_AsLdbContext(self));
509 if (dn == NULL)
510 Py_RETURN_NONE;
511 return PyLdbDn_FromDn(dn);
514 static PyObject *py_ldb_get_config_basedn(PyLdbObject *self)
516 struct ldb_dn *dn = ldb_get_config_basedn(PyLdb_AsLdbContext(self));
517 if (dn == NULL)
518 Py_RETURN_NONE;
519 return PyLdbDn_FromDn(dn);
522 static PyObject *py_ldb_get_default_basedn(PyLdbObject *self)
524 struct ldb_dn *dn = ldb_get_default_basedn(PyLdb_AsLdbContext(self));
525 if (dn == NULL)
526 Py_RETURN_NONE;
527 return PyLdbDn_FromDn(dn);
530 static const char **PyList_AsStringList(TALLOC_CTX *mem_ctx, PyObject *list,
531 const char *paramname)
533 const char **ret;
534 int i;
535 if (!PyList_Check(list)) {
536 PyErr_Format(PyExc_TypeError, "%s is not a list", paramname);
537 return NULL;
539 ret = talloc_array(NULL, const char *, PyList_Size(list)+1);
540 for (i = 0; i < PyList_Size(list); i++) {
541 PyObject *item = PyList_GetItem(list, i);
542 if (!PyString_Check(item)) {
543 PyErr_Format(PyExc_TypeError, "%s should be strings", paramname);
544 return NULL;
546 ret[i] = talloc_strndup(ret, PyString_AsString(item),
547 PyString_Size(item));
549 ret[i] = NULL;
550 return ret;
553 static int py_ldb_init(PyLdbObject *self, PyObject *args, PyObject *kwargs)
555 const char * const kwnames[] = { "url", "flags", "options", NULL };
556 char *url = NULL;
557 PyObject *py_options = Py_None;
558 const char **options;
559 int flags = 0;
560 int ret;
561 struct ldb_context *ldb;
563 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO:Ldb.__init__",
564 discard_const_p(char *, kwnames),
565 &url, &flags, &py_options))
566 return -1;
568 ldb = PyLdb_AsLdbContext(self);
570 if (py_options == Py_None) {
571 options = NULL;
572 } else {
573 options = PyList_AsStringList(ldb, py_options, "options");
574 if (options == NULL)
575 return -1;
578 if (url != NULL) {
579 ret = ldb_connect(ldb, url, flags, options);
580 if (ret != LDB_SUCCESS) {
581 PyErr_SetLdbError(PyExc_LdbError, ret, ldb);
582 return -1;
586 talloc_free(options);
587 return 0;
590 static PyObject *py_ldb_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
592 PyLdbObject *ret;
593 struct ldb_context *ldb;
594 ret = (PyLdbObject *)type->tp_alloc(type, 0);
595 if (ret == NULL) {
596 PyErr_NoMemory();
597 return NULL;
599 ret->mem_ctx = talloc_new(NULL);
600 ldb = ldb_init(ret->mem_ctx, NULL);
602 if (ldb == NULL) {
603 PyErr_NoMemory();
604 return NULL;
607 ret->ldb_ctx = ldb;
608 return (PyObject *)ret;
611 static PyObject *py_ldb_connect(PyLdbObject *self, PyObject *args, PyObject *kwargs)
613 char *url;
614 int flags = 0;
615 PyObject *py_options = Py_None;
616 int ret;
617 const char **options;
618 const char * const kwnames[] = { "url", "flags", "options", NULL };
620 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|ziO",
621 discard_const_p(char *, kwnames),
622 &url, &flags, &py_options))
623 return NULL;
625 if (py_options == Py_None) {
626 options = NULL;
627 } else {
628 options = PyList_AsStringList(NULL, py_options, "options");
629 if (options == NULL)
630 return NULL;
633 ret = ldb_connect(PyLdb_AsLdbContext(self), url, flags, options);
634 talloc_free(options);
636 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
638 Py_RETURN_NONE;
641 static PyObject *py_ldb_modify(PyLdbObject *self, PyObject *args)
643 PyObject *py_msg;
644 int ret;
645 if (!PyArg_ParseTuple(args, "O", &py_msg))
646 return NULL;
648 if (!PyLdbMessage_Check(py_msg)) {
649 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message");
650 return NULL;
653 ret = ldb_modify(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg));
654 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
656 Py_RETURN_NONE;
659 static PyObject *py_ldb_add(PyLdbObject *self, PyObject *args)
661 PyObject *py_msg;
662 int ret;
663 Py_ssize_t dict_pos, msg_pos;
664 struct ldb_message_element *msgel;
665 struct ldb_message *msg;
666 PyObject *key, *value;
667 TALLOC_CTX *mem_ctx;
669 if (!PyArg_ParseTuple(args, "O", &py_msg))
670 return NULL;
672 mem_ctx = talloc_new(NULL);
674 if (PyDict_Check(py_msg)) {
675 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
676 msg = ldb_msg_new(mem_ctx);
677 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
678 msg_pos = dict_pos = 0;
679 if (dn_value) {
680 if (!PyObject_AsDn(msg, dn_value, PyLdb_AsLdbContext(self), &msg->dn)) {
681 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
682 talloc_free(mem_ctx);
683 return NULL;
685 if (msg->dn == NULL) {
686 PyErr_SetString(PyExc_TypeError, "dn set but not found");
687 talloc_free(mem_ctx);
688 return NULL;
692 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
693 char *key_str = PyString_AsString(key);
694 if (strcmp(key_str, "dn") != 0) {
695 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
696 if (msgel == NULL) {
697 PyErr_SetString(PyExc_TypeError, "unable to import element");
698 talloc_free(mem_ctx);
699 return NULL;
701 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
702 msg_pos++;
706 if (msg->dn == NULL) {
707 PyErr_SetString(PyExc_TypeError, "no dn set");
708 talloc_free(mem_ctx);
709 return NULL;
712 msg->num_elements = msg_pos;
713 } else {
714 msg = PyLdbMessage_AsMessage(py_msg);
717 ret = ldb_add(PyLdb_AsLdbContext(self), msg);
718 talloc_free(mem_ctx);
719 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
721 Py_RETURN_NONE;
724 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
726 PyObject *py_dn;
727 struct ldb_dn *dn;
728 int ret;
729 struct ldb_context *ldb;
730 if (!PyArg_ParseTuple(args, "O", &py_dn))
731 return NULL;
733 ldb = PyLdb_AsLdbContext(self);
735 if (!PyObject_AsDn(NULL, py_dn, ldb, &dn))
736 return NULL;
738 ret = ldb_delete(ldb, dn);
739 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
741 Py_RETURN_NONE;
744 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
746 PyObject *py_dn1, *py_dn2;
747 struct ldb_dn *dn1, *dn2;
748 int ret;
749 struct ldb_context *ldb;
750 TALLOC_CTX *mem_ctx;
751 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
752 return NULL;
754 mem_ctx = talloc_new(NULL);
755 if (mem_ctx == NULL) {
756 PyErr_NoMemory();
757 return NULL;
759 ldb = PyLdb_AsLdbContext(self);
760 if (!PyObject_AsDn(mem_ctx, py_dn1, ldb, &dn1)) {
761 talloc_free(mem_ctx);
762 return NULL;
765 if (!PyObject_AsDn(mem_ctx, py_dn2, ldb, &dn2)) {
766 talloc_free(mem_ctx);
767 return NULL;
770 ret = ldb_rename(ldb, dn1, dn2);
771 talloc_free(mem_ctx);
772 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
774 Py_RETURN_NONE;
777 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
779 char *name;
780 if (!PyArg_ParseTuple(args, "s", &name))
781 return NULL;
783 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
785 Py_RETURN_NONE;
788 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
790 char *attribute, *syntax;
791 unsigned int flags;
792 int ret;
793 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
794 return NULL;
796 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
798 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
800 Py_RETURN_NONE;
803 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
805 if (ldif == NULL) {
806 Py_RETURN_NONE;
807 } else {
808 /* We don't want this attached to the 'ldb' any more */
809 return Py_BuildValue(discard_const_p(char, "(iO)"),
810 ldif->changetype,
811 PyLdbMessage_FromMessage(ldif->msg));
816 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
818 PyObject *list;
819 struct ldb_ldif *ldif;
820 const char *s;
822 TALLOC_CTX *mem_ctx;
824 if (!PyArg_ParseTuple(args, "s", &s))
825 return NULL;
827 mem_ctx = talloc_new(NULL);
828 if (!mem_ctx) {
829 Py_RETURN_NONE;
832 list = PyList_New(0);
833 while (s && *s != '\0') {
834 ldif = ldb_ldif_read_string(self->ldb_ctx, &s);
835 talloc_steal(mem_ctx, ldif);
836 if (ldif) {
837 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
838 } else {
839 PyErr_SetString(PyExc_ValueError, "unable to parse ldif string");
840 talloc_free(mem_ctx);
841 return NULL;
844 talloc_free(mem_ctx); /* The pyobject already has a reference to the things it needs */
845 return PyObject_GetIter(list);
848 static PyObject *py_ldb_msg_diff(PyLdbObject *self, PyObject *args)
850 PyObject *py_msg_old;
851 PyObject *py_msg_new;
852 struct ldb_message *diff;
853 PyObject *py_ret;
855 if (!PyArg_ParseTuple(args, "OO", &py_msg_old, &py_msg_new))
856 return NULL;
858 if (!PyLdbMessage_Check(py_msg_old)) {
859 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for old message");
860 return NULL;
863 if (!PyLdbMessage_Check(py_msg_new)) {
864 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for new message");
865 return NULL;
868 diff = ldb_msg_diff(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg_old), PyLdbMessage_AsMessage(py_msg_new));
869 if (diff == NULL)
870 return NULL;
872 py_ret = PyLdbMessage_FromMessage(diff);
874 return py_ret;
877 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
879 const struct ldb_schema_attribute *a;
880 struct ldb_val old_val;
881 struct ldb_val new_val;
882 TALLOC_CTX *mem_ctx;
883 PyObject *ret;
884 char *element_name;
885 PyObject *val;
887 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
888 return NULL;
890 mem_ctx = talloc_new(NULL);
892 old_val.data = (uint8_t *)PyString_AsString(val);
893 old_val.length = PyString_Size(val);
895 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
897 if (a == NULL) {
898 Py_RETURN_NONE;
901 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
902 talloc_free(mem_ctx);
903 Py_RETURN_NONE;
906 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
908 talloc_free(mem_ctx);
910 return ret;
913 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
915 PyObject *py_base = Py_None;
916 enum ldb_scope scope = LDB_SCOPE_DEFAULT;
917 char *expr = NULL;
918 PyObject *py_attrs = Py_None;
919 PyObject *py_controls = Py_None;
920 const char * const kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
921 int ret;
922 struct ldb_result *res;
923 struct ldb_request *req;
924 const char **attrs;
925 struct ldb_context *ldb_ctx;
926 struct ldb_control **parsed_controls;
927 struct ldb_dn *base;
928 PyObject *py_ret;
930 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO",
931 discard_const_p(char *, kwnames),
932 &py_base, &scope, &expr, &py_attrs, &py_controls))
933 return NULL;
935 ldb_ctx = PyLdb_AsLdbContext(self);
937 if (py_attrs == Py_None) {
938 attrs = NULL;
939 } else {
940 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
941 if (attrs == NULL)
942 return NULL;
945 if (py_base == Py_None) {
946 base = ldb_get_default_basedn(ldb_ctx);
947 } else {
948 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base)) {
949 talloc_free(attrs);
950 return NULL;
954 if (py_controls == Py_None) {
955 parsed_controls = NULL;
956 } else {
957 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
958 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
959 talloc_free(controls);
962 res = talloc_zero(ldb_ctx, struct ldb_result);
963 if (res == NULL) {
964 PyErr_NoMemory();
965 talloc_free(attrs);
966 return NULL;
969 ret = ldb_build_search_req(&req, ldb_ctx, ldb_ctx,
970 base,
971 scope,
972 expr,
973 attrs,
974 parsed_controls,
975 res,
976 ldb_search_default_callback,
977 NULL);
979 talloc_steal(req, attrs);
981 if (ret != LDB_SUCCESS) {
982 talloc_free(res);
983 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
984 return NULL;
987 ret = ldb_request(ldb_ctx, req);
989 if (ret == LDB_SUCCESS) {
990 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
993 talloc_free(req);
995 if (ret != LDB_SUCCESS) {
996 talloc_free(res);
997 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
998 return NULL;
1001 py_ret = PyLdbResult_FromResult(res);
1003 talloc_free(res);
1005 return py_ret;
1008 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
1010 char *name;
1011 void *data;
1013 if (!PyArg_ParseTuple(args, "s", &name))
1014 return NULL;
1016 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
1018 if (data == NULL)
1019 Py_RETURN_NONE;
1021 /* FIXME: More interpretation */
1023 return Py_True;
1026 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
1028 char *name;
1029 PyObject *data;
1031 if (!PyArg_ParseTuple(args, "sO", &name, &data))
1032 return NULL;
1034 /* FIXME: More interpretation */
1036 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
1038 Py_RETURN_NONE;
1041 static PyObject *py_ldb_modules(PyLdbObject *self)
1043 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
1044 PyObject *ret = PyList_New(0);
1045 struct ldb_module *mod;
1047 for (mod = ldb->modules; mod; mod = mod->next) {
1048 PyList_Append(ret, PyLdbModule_FromModule(mod));
1051 return ret;
1054 static PyMethodDef py_ldb_methods[] = {
1055 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
1056 "S.set_debug(callback) -> None\n"
1057 "Set callback for LDB debug messages.\n"
1058 "The callback should accept a debug level and debug text." },
1059 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
1060 "S.set_create_perms(mode) -> None\n"
1061 "Set mode to use when creating new LDB files." },
1062 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
1063 "S.set_modules_dir(path) -> None\n"
1064 "Set path LDB should search for modules" },
1065 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
1066 "S.transaction_start() -> None\n"
1067 "Start a new transaction." },
1068 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
1069 "S.transaction_commit() -> None\n"
1070 "commit a new transaction." },
1071 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
1072 "S.transaction_cancel() -> None\n"
1073 "cancel a new transaction." },
1074 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
1075 NULL },
1076 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
1077 NULL },
1078 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
1079 NULL },
1080 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
1081 NULL },
1082 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
1083 NULL },
1084 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
1085 "S.connect(url, flags=0, options=None) -> None\n"
1086 "Connect to a LDB URL." },
1087 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
1088 "S.modify(message) -> None\n"
1089 "Modify an entry." },
1090 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
1091 "S.add(message) -> None\n"
1092 "Add an entry." },
1093 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
1094 "S.delete(dn) -> None\n"
1095 "Remove an entry." },
1096 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
1097 "S.rename(old_dn, new_dn) -> None\n"
1098 "Rename an entry." },
1099 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
1100 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
1101 "Search in a database.\n"
1102 "\n"
1103 ":param base: Optional base DN to search\n"
1104 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
1105 ":param expression: Optional search expression\n"
1106 ":param attrs: Attributes to return (defaults to all)\n"
1107 ":param controls: Optional list of controls\n"
1108 ":return: Iterator over Message objects\n"
1110 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
1111 NULL },
1112 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
1113 NULL },
1114 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
1115 NULL },
1116 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
1117 "S.parse_ldif(ldif) -> iter(messages)\n"
1118 "Parse a string formatted using LDIF." },
1119 { "msg_diff", (PyCFunction)py_ldb_msg_diff, METH_VARARGS,
1120 "S.msg_diff(Message) -> Message\n"
1121 "Return an LDB Message of the difference between two Message objects." },
1122 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
1123 "S.get_opaque(name) -> value\n"
1124 "Get an opaque value set on this LDB connection. \n"
1125 ":note: The returned value may not be useful in Python."
1127 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
1128 "S.set_opaque(name, value) -> None\n"
1129 "Set an opaque value on this LDB connection. \n"
1130 ":note: Passing incorrect values may cause crashes." },
1131 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
1132 "S.modules() -> list\n"
1133 "Return the list of modules on this LDB connection " },
1134 { NULL },
1137 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
1139 PyLdbModuleObject *ret;
1141 ret = (PyLdbModuleObject *)PyLdbModule.tp_alloc(&PyLdbModule, 0);
1142 if (ret == NULL) {
1143 PyErr_NoMemory();
1144 return NULL;
1146 ret->mem_ctx = talloc_new(NULL);
1147 ret->mod = talloc_reference(ret->mem_ctx, mod);
1148 return (PyObject *)ret;
1151 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
1153 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
1156 static PyGetSetDef py_ldb_getset[] = {
1157 { discard_const_p(char, "firstmodule"), (getter)py_ldb_get_firstmodule, NULL, NULL },
1158 { NULL }
1161 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
1163 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
1164 struct ldb_dn *dn;
1165 struct ldb_result *result;
1166 int ret;
1167 int count;
1169 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
1170 return -1;
1172 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
1173 if (ret != LDB_SUCCESS) {
1174 PyErr_SetLdbError(PyExc_LdbError, ret, ldb_ctx);
1175 return -1;
1178 count = result->count;
1180 talloc_free(result);
1182 return count;
1185 static PySequenceMethods py_ldb_seq = {
1186 .sq_contains = (objobjproc)py_ldb_contains,
1189 PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
1191 PyLdbObject *ret;
1193 ret = (PyLdbObject *)PyLdb.tp_alloc(&PyLdb, 0);
1194 if (ret == NULL) {
1195 PyErr_NoMemory();
1196 return NULL;
1198 ret->mem_ctx = talloc_new(NULL);
1199 ret->ldb_ctx = talloc_reference(ret->mem_ctx, ldb_ctx);
1200 return (PyObject *)ret;
1203 static void py_ldb_dealloc(PyLdbObject *self)
1205 talloc_free(self->mem_ctx);
1206 self->ob_type->tp_free(self);
1209 PyTypeObject PyLdb = {
1210 .tp_name = "Ldb",
1211 .tp_methods = py_ldb_methods,
1212 .tp_repr = (reprfunc)py_ldb_repr,
1213 .tp_new = py_ldb_new,
1214 .tp_init = (initproc)py_ldb_init,
1215 .tp_dealloc = (destructor)py_ldb_dealloc,
1216 .tp_getset = py_ldb_getset,
1217 .tp_getattro = PyObject_GenericGetAttr,
1218 .tp_basicsize = sizeof(PyLdbObject),
1219 .tp_doc = "Connection to a LDB database.",
1220 .tp_as_sequence = &py_ldb_seq,
1221 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1224 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1226 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1229 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1231 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1234 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1236 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1237 Py_RETURN_NONE;
1240 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1242 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1243 Py_RETURN_NONE;
1246 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1248 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1249 Py_RETURN_NONE;
1252 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1254 PyObject *py_base, *py_tree, *py_attrs, *py_ret;
1255 int ret, scope;
1256 struct ldb_request *req;
1257 const char * const kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1258 struct ldb_module *mod;
1259 const char * const*attrs;
1261 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO",
1262 discard_const_p(char *, kwnames),
1263 &py_base, &scope, &py_tree, &py_attrs))
1264 return NULL;
1266 mod = self->mod;
1268 if (py_attrs == Py_None) {
1269 attrs = NULL;
1270 } else {
1271 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1272 if (attrs == NULL)
1273 return NULL;
1276 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1277 scope, NULL /* expr */, attrs,
1278 NULL /* controls */, NULL, NULL, NULL);
1280 talloc_steal(req, attrs);
1282 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1284 req->op.search.res = NULL;
1286 ret = mod->ops->search(mod, req);
1288 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1290 py_ret = PyLdbResult_FromResult(req->op.search.res);
1292 talloc_free(req);
1294 return py_ret;
1298 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1300 struct ldb_request *req;
1301 PyObject *py_message;
1302 int ret;
1303 struct ldb_module *mod;
1305 if (!PyArg_ParseTuple(args, "O", &py_message))
1306 return NULL;
1308 req = talloc_zero(NULL, struct ldb_request);
1309 req->operation = LDB_ADD;
1310 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1312 mod = PyLdbModule_AsModule(self);
1313 ret = mod->ops->add(mod, req);
1315 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1317 Py_RETURN_NONE;
1320 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1322 int ret;
1323 struct ldb_request *req;
1324 PyObject *py_message;
1325 struct ldb_module *mod;
1327 if (!PyArg_ParseTuple(args, "O", &py_message))
1328 return NULL;
1330 req = talloc_zero(NULL, struct ldb_request);
1331 req->operation = LDB_MODIFY;
1332 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1334 mod = PyLdbModule_AsModule(self);
1335 ret = mod->ops->modify(mod, req);
1337 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1339 Py_RETURN_NONE;
1342 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1344 int ret;
1345 struct ldb_request *req;
1346 PyObject *py_dn;
1348 if (!PyArg_ParseTuple(args, "O", &py_dn))
1349 return NULL;
1351 req = talloc_zero(NULL, struct ldb_request);
1352 req->operation = LDB_DELETE;
1353 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1355 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1357 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1359 Py_RETURN_NONE;
1362 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1364 int ret;
1365 struct ldb_request *req;
1366 PyObject *py_dn1, *py_dn2;
1368 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1369 return NULL;
1371 req = talloc_zero(NULL, struct ldb_request);
1373 req->operation = LDB_RENAME;
1374 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1375 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1377 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1379 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1381 Py_RETURN_NONE;
1384 static PyMethodDef py_ldb_module_methods[] = {
1385 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1386 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1387 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1388 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1389 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1390 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1391 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1392 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1393 { NULL },
1396 static void py_ldb_module_dealloc(PyLdbModuleObject *self)
1398 talloc_free(self->mem_ctx);
1399 self->ob_type->tp_free(self);
1402 PyTypeObject PyLdbModule = {
1403 .tp_name = "LdbModule",
1404 .tp_methods = py_ldb_module_methods,
1405 .tp_repr = (reprfunc)py_ldb_module_repr,
1406 .tp_str = (reprfunc)py_ldb_module_str,
1407 .tp_basicsize = sizeof(PyLdbModuleObject),
1408 .tp_dealloc = (destructor)py_ldb_module_dealloc,
1409 .tp_flags = Py_TPFLAGS_DEFAULT,
1414 * Create a ldb_message_element from a Python object.
1416 * This will accept any sequence objects that contains strings, or
1417 * a string object.
1419 * A reference to set_obj will be borrowed.
1421 * @param mem_ctx Memory context
1422 * @param set_obj Python object to convert
1423 * @param flags ldb_message_element flags to set
1424 * @param attr_name Name of the attribute
1425 * @return New ldb_message_element, allocated as child of mem_ctx
1427 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1428 PyObject *set_obj, int flags,
1429 const char *attr_name)
1431 struct ldb_message_element *me;
1433 if (PyLdbMessageElement_Check(set_obj))
1434 return talloc_reference(mem_ctx,
1435 PyLdbMessageElement_AsMessageElement(set_obj));
1437 me = talloc(mem_ctx, struct ldb_message_element);
1439 me->name = talloc_strdup(me, attr_name);
1440 me->flags = flags;
1441 if (PyString_Check(set_obj)) {
1442 me->num_values = 1;
1443 me->values = talloc_array(me, struct ldb_val, me->num_values);
1444 me->values[0].length = PyString_Size(set_obj);
1445 me->values[0].data = talloc_memdup(me,
1446 (uint8_t *)PyString_AsString(set_obj), me->values[0].length);
1447 } else if (PySequence_Check(set_obj)) {
1448 int i;
1449 me->num_values = PySequence_Size(set_obj);
1450 me->values = talloc_array(me, struct ldb_val, me->num_values);
1451 for (i = 0; i < me->num_values; i++) {
1452 PyObject *obj = PySequence_GetItem(set_obj, i);
1454 me->values[i].length = PyString_Size(obj);
1455 me->values[i].data = talloc_memdup(me,
1456 (uint8_t *)PyString_AsString(obj), me->values[i].length);
1458 } else {
1459 talloc_free(me);
1460 me = NULL;
1463 return me;
1467 static PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1468 struct ldb_message_element *me)
1470 int i;
1471 PyObject *result;
1473 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1474 result = PyList_New(me->num_values);
1476 for (i = 0; i < me->num_values; i++) {
1477 PyList_SetItem(result, i,
1478 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1481 return result;
1484 static PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1486 int i;
1487 if (!PyArg_ParseTuple(args, "i", &i))
1488 return NULL;
1489 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1490 Py_RETURN_NONE;
1492 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1493 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1496 static PyMethodDef py_ldb_msg_element_methods[] = {
1497 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1498 { NULL },
1501 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1503 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1506 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1508 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1509 if (idx < 0 || idx >= el->num_values) {
1510 PyErr_SetString(PyExc_IndexError, "Out of range");
1511 return NULL;
1513 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1516 static PySequenceMethods py_ldb_msg_element_seq = {
1517 .sq_length = (lenfunc)py_ldb_msg_element_len,
1518 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1521 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1523 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1524 PyLdbMessageElement_AsMessageElement(other));
1527 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1529 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1532 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el, TALLOC_CTX *mem_ctx)
1534 PyLdbMessageElementObject *ret;
1535 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1536 if (ret == NULL) {
1537 PyErr_NoMemory();
1538 return NULL;
1540 ret->mem_ctx = talloc_new(NULL);
1541 if (talloc_reference(ret->mem_ctx, mem_ctx) == NULL) {
1542 PyErr_NoMemory();
1543 return NULL;
1545 ret->el = el;
1546 return (PyObject *)ret;
1549 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1551 PyObject *py_elements = NULL;
1552 struct ldb_message_element *el;
1553 int flags = 0;
1554 char *name = NULL;
1555 const char * const kwnames[] = { "elements", "flags", "name", NULL };
1556 PyLdbMessageElementObject *ret;
1557 TALLOC_CTX *mem_ctx;
1559 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois",
1560 discard_const_p(char *, kwnames),
1561 &py_elements, &flags, &name))
1562 return NULL;
1564 mem_ctx = talloc_new(NULL);
1565 if (mem_ctx == NULL) {
1566 PyErr_NoMemory();
1567 return NULL;
1570 el = talloc_zero(mem_ctx, struct ldb_message_element);
1572 if (py_elements != NULL) {
1573 int i;
1574 if (PyString_Check(py_elements)) {
1575 el->num_values = 1;
1576 el->values = talloc_array(el, struct ldb_val, 1);
1577 el->values[0].length = PyString_Size(py_elements);
1578 el->values[0].data = talloc_memdup(el,
1579 (uint8_t *)PyString_AsString(py_elements), el->values[0].length);
1580 } else if (PySequence_Check(py_elements)) {
1581 el->num_values = PySequence_Size(py_elements);
1582 el->values = talloc_array(el, struct ldb_val, el->num_values);
1583 for (i = 0; i < el->num_values; i++) {
1584 PyObject *item = PySequence_GetItem(py_elements, i);
1585 if (!PyString_Check(item)) {
1586 PyErr_Format(PyExc_TypeError,
1587 "Expected string as element %d in list",
1589 talloc_free(mem_ctx);
1590 return NULL;
1592 el->values[i].length = PyString_Size(item);
1593 el->values[i].data = talloc_memdup(el,
1594 (uint8_t *)PyString_AsString(item), el->values[i].length);
1596 } else {
1597 PyErr_SetString(PyExc_TypeError,
1598 "Expected string or list");
1599 talloc_free(mem_ctx);
1600 return NULL;
1604 el->flags = flags;
1605 el->name = talloc_strdup(el, name);
1607 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1608 if (ret == NULL) {
1609 PyErr_NoMemory();
1610 talloc_free(mem_ctx);
1611 return NULL;
1614 ret->mem_ctx = mem_ctx;
1615 ret->el = el;
1616 return (PyObject *)ret;
1619 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1621 char *element_str = NULL;
1622 int i;
1623 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1624 PyObject *ret;
1626 for (i = 0; i < el->num_values; i++) {
1627 PyObject *o = py_ldb_msg_element_find(self, i);
1628 if (element_str == NULL)
1629 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1630 else
1631 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1634 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1636 talloc_free(element_str);
1638 return ret;
1641 static PyObject *py_ldb_msg_element_str(PyLdbMessageElementObject *self)
1643 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1645 if (el->num_values == 1)
1646 return PyString_FromStringAndSize((char *)el->values[0].data, el->values[0].length);
1647 else
1648 Py_RETURN_NONE;
1651 static void py_ldb_msg_element_dealloc(PyLdbMessageElementObject *self)
1653 talloc_free(self->mem_ctx);
1654 self->ob_type->tp_free(self);
1657 PyTypeObject PyLdbMessageElement = {
1658 .tp_name = "MessageElement",
1659 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1660 .tp_dealloc = (destructor)py_ldb_msg_element_dealloc,
1661 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1662 .tp_str = (reprfunc)py_ldb_msg_element_str,
1663 .tp_methods = py_ldb_msg_element_methods,
1664 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1665 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1666 .tp_as_sequence = &py_ldb_msg_element_seq,
1667 .tp_new = py_ldb_msg_element_new,
1668 .tp_flags = Py_TPFLAGS_DEFAULT,
1671 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1673 char *name;
1674 if (!PyArg_ParseTuple(args, "s", &name))
1675 return NULL;
1677 ldb_msg_remove_attr(self->msg, name);
1679 Py_RETURN_NONE;
1682 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1684 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1685 int i, j = 0;
1686 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1687 if (msg->dn != NULL) {
1688 PyList_SetItem(obj, j, PyString_FromString("dn"));
1689 j++;
1691 for (i = 0; i < msg->num_elements; i++) {
1692 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1693 j++;
1695 return obj;
1698 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1700 struct ldb_message_element *el;
1701 char *name = PyString_AsString(py_name);
1702 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1703 if (!strcmp(name, "dn"))
1704 return PyLdbDn_FromDn(msg->dn);
1705 el = ldb_msg_find_element(msg, name);
1706 if (el == NULL) {
1707 return NULL;
1709 return (PyObject *)PyLdbMessageElement_FromMessageElement(el, msg);
1712 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1714 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1715 if (ret == NULL) {
1716 PyErr_SetString(PyExc_KeyError, "No such element");
1717 return NULL;
1719 return ret;
1722 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1724 PyObject *name, *ret;
1725 if (!PyArg_ParseTuple(args, "O", &name))
1726 return NULL;
1728 ret = py_ldb_msg_getitem_helper(self, name);
1729 if (ret == NULL)
1730 Py_RETURN_NONE;
1731 return ret;
1734 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1736 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1737 int i, j;
1738 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1739 j = 0;
1740 if (msg->dn != NULL) {
1741 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1742 j++;
1744 for (i = 0; i < msg->num_elements; i++, j++) {
1745 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i], self->msg)));
1747 return l;
1750 static PyMethodDef py_ldb_msg_methods[] = {
1751 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1752 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1753 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
1754 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
1755 { NULL },
1758 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
1760 PyObject *list, *iter;
1762 list = py_ldb_msg_keys(self);
1763 iter = PyObject_GetIter(list);
1764 Py_DECREF(list);
1765 return iter;
1768 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
1770 char *attr_name;
1772 if (!PyString_Check(name)) {
1773 PyErr_SetNone(PyExc_TypeError);
1774 return -1;
1777 attr_name = PyString_AsString(name);
1778 if (value == NULL) {
1779 /* delitem */
1780 ldb_msg_remove_attr(self->msg, attr_name);
1781 } else {
1782 struct ldb_message_element *el = PyObject_AsMessageElement(self->msg,
1783 value, 0, attr_name);
1784 if (el == NULL)
1785 return -1;
1786 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
1787 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
1789 return 0;
1792 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
1794 return PyLdbMessage_AsMessage(self)->num_elements;
1797 static PyMappingMethods py_ldb_msg_mapping = {
1798 .mp_length = (lenfunc)py_ldb_msg_length,
1799 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
1800 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
1803 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1805 const char * const kwnames[] = { "dn", NULL };
1806 struct ldb_message *ret;
1807 TALLOC_CTX *mem_ctx;
1808 PyObject *pydn = NULL;
1809 PyLdbMessageObject *py_ret;
1811 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O",
1812 discard_const_p(char *, kwnames),
1813 &pydn))
1814 return NULL;
1816 mem_ctx = talloc_new(NULL);
1817 if (mem_ctx == NULL) {
1818 PyErr_NoMemory();
1819 return NULL;
1822 ret = ldb_msg_new(mem_ctx);
1823 if (ret == NULL) {
1824 talloc_free(mem_ctx);
1825 PyErr_NoMemory();
1826 return NULL;
1829 if (pydn != NULL) {
1830 struct ldb_dn *dn;
1831 if (!PyObject_AsDn(NULL, pydn, NULL, &dn)) {
1832 talloc_free(mem_ctx);
1833 return NULL;
1835 ret->dn = talloc_reference(ret, dn);
1838 py_ret = (PyLdbMessageObject *)type->tp_alloc(type, 0);
1839 if (py_ret == NULL) {
1840 PyErr_NoMemory();
1841 talloc_free(mem_ctx);
1842 return NULL;
1845 py_ret->mem_ctx = mem_ctx;
1846 py_ret->msg = ret;
1847 return (PyObject *)py_ret;
1850 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
1852 PyLdbMessageObject *ret;
1854 ret = (PyLdbMessageObject *)PyLdbMessage.tp_alloc(&PyLdbMessage, 0);
1855 if (ret == NULL) {
1856 PyErr_NoMemory();
1857 return NULL;
1859 ret->mem_ctx = talloc_new(NULL);
1860 ret->msg = talloc_reference(ret->mem_ctx, msg);
1861 return (PyObject *)ret;
1864 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
1866 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1867 return PyLdbDn_FromDn(msg->dn);
1870 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
1872 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1873 if (!PyLdbDn_Check(value)) {
1874 PyErr_SetNone(PyExc_TypeError);
1875 return -1;
1878 msg->dn = talloc_reference(msg, PyLdbDn_AsDn(value));
1879 return 0;
1882 static PyGetSetDef py_ldb_msg_getset[] = {
1883 { discard_const_p(char, "dn"), (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
1884 { NULL }
1887 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
1889 PyObject *dict = PyDict_New(), *ret;
1890 if (PyDict_Update(dict, (PyObject *)self) != 0)
1891 return NULL;
1892 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
1893 Py_DECREF(dict);
1894 return ret;
1897 static void py_ldb_msg_dealloc(PyLdbMessageObject *self)
1899 talloc_free(self->mem_ctx);
1900 self->ob_type->tp_free(self);
1903 PyTypeObject PyLdbMessage = {
1904 .tp_name = "Message",
1905 .tp_methods = py_ldb_msg_methods,
1906 .tp_getset = py_ldb_msg_getset,
1907 .tp_as_mapping = &py_ldb_msg_mapping,
1908 .tp_basicsize = sizeof(PyLdbMessageObject),
1909 .tp_dealloc = (destructor)py_ldb_msg_dealloc,
1910 .tp_new = py_ldb_msg_new,
1911 .tp_repr = (reprfunc)py_ldb_msg_repr,
1912 .tp_flags = Py_TPFLAGS_DEFAULT,
1913 .tp_iter = (getiterfunc)py_ldb_msg_iter,
1916 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
1918 PyLdbTreeObject *ret;
1920 ret = (PyLdbTreeObject *)PyLdbTree.tp_alloc(&PyLdbTree, 0);
1921 if (ret == NULL) {
1922 PyErr_NoMemory();
1923 return NULL;
1926 ret->mem_ctx = talloc_new(NULL);
1927 ret->tree = talloc_reference(ret->mem_ctx, tree);
1928 return (PyObject *)ret;
1931 static void py_ldb_tree_dealloc(PyLdbTreeObject *self)
1933 talloc_free(self->mem_ctx);
1934 self->ob_type->tp_free(self);
1937 PyTypeObject PyLdbTree = {
1938 .tp_name = "Tree",
1939 .tp_basicsize = sizeof(PyLdbTreeObject),
1940 .tp_dealloc = (destructor)py_ldb_tree_dealloc,
1941 .tp_flags = Py_TPFLAGS_DEFAULT,
1944 /* Ldb_module */
1945 static int py_module_search(struct ldb_module *mod, struct ldb_request *req)
1947 PyObject *py_ldb = (PyObject *)mod->private_data;
1948 PyObject *py_result, *py_base, *py_attrs, *py_tree;
1950 py_base = PyLdbDn_FromDn(req->op.search.base);
1952 if (py_base == NULL)
1953 return LDB_ERR_OPERATIONS_ERROR;
1955 py_tree = PyLdbTree_FromTree(req->op.search.tree);
1957 if (py_tree == NULL)
1958 return LDB_ERR_OPERATIONS_ERROR;
1960 if (req->op.search.attrs == NULL) {
1961 py_attrs = Py_None;
1962 } else {
1963 int i, len;
1964 for (len = 0; req->op.search.attrs[len]; len++);
1965 py_attrs = PyList_New(len);
1966 for (i = 0; i < len; i++)
1967 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
1970 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "search"),
1971 discard_const_p(char, "OiOO"),
1972 py_base, req->op.search.scope, py_tree, py_attrs);
1974 Py_DECREF(py_attrs);
1975 Py_DECREF(py_tree);
1976 Py_DECREF(py_base);
1978 if (py_result == NULL) {
1979 return LDB_ERR_PYTHON_EXCEPTION;
1982 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
1983 if (req->op.search.res == NULL) {
1984 return LDB_ERR_PYTHON_EXCEPTION;
1987 Py_DECREF(py_result);
1989 return LDB_SUCCESS;
1992 static int py_module_add(struct ldb_module *mod, struct ldb_request *req)
1994 PyObject *py_ldb = (PyObject *)mod->private_data;
1995 PyObject *py_result, *py_msg;
1997 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.add.message));
1999 if (py_msg == NULL) {
2000 return LDB_ERR_OPERATIONS_ERROR;
2003 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "add"),
2004 discard_const_p(char, "O"),
2005 py_msg);
2007 Py_DECREF(py_msg);
2009 if (py_result == NULL) {
2010 return LDB_ERR_PYTHON_EXCEPTION;
2013 Py_DECREF(py_result);
2015 return LDB_SUCCESS;
2018 static int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
2020 PyObject *py_ldb = (PyObject *)mod->private_data;
2021 PyObject *py_result, *py_msg;
2023 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.mod.message));
2025 if (py_msg == NULL) {
2026 return LDB_ERR_OPERATIONS_ERROR;
2029 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "modify"),
2030 discard_const_p(char, "O"),
2031 py_msg);
2033 Py_DECREF(py_msg);
2035 if (py_result == NULL) {
2036 return LDB_ERR_PYTHON_EXCEPTION;
2039 Py_DECREF(py_result);
2041 return LDB_SUCCESS;
2044 static int py_module_del(struct ldb_module *mod, struct ldb_request *req)
2046 PyObject *py_ldb = (PyObject *)mod->private_data;
2047 PyObject *py_result, *py_dn;
2049 py_dn = PyLdbDn_FromDn(req->op.del.dn);
2051 if (py_dn == NULL)
2052 return LDB_ERR_OPERATIONS_ERROR;
2054 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "delete"),
2055 discard_const_p(char, "O"),
2056 py_dn);
2058 if (py_result == NULL) {
2059 return LDB_ERR_PYTHON_EXCEPTION;
2062 Py_DECREF(py_result);
2064 return LDB_SUCCESS;
2067 static int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
2069 PyObject *py_ldb = (PyObject *)mod->private_data;
2070 PyObject *py_result, *py_olddn, *py_newdn;
2072 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
2074 if (py_olddn == NULL)
2075 return LDB_ERR_OPERATIONS_ERROR;
2077 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
2079 if (py_newdn == NULL)
2080 return LDB_ERR_OPERATIONS_ERROR;
2082 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "rename"),
2083 discard_const_p(char, "OO"),
2084 py_olddn, py_newdn);
2086 Py_DECREF(py_olddn);
2087 Py_DECREF(py_newdn);
2089 if (py_result == NULL) {
2090 return LDB_ERR_PYTHON_EXCEPTION;
2093 Py_DECREF(py_result);
2095 return LDB_SUCCESS;
2098 static int py_module_request(struct ldb_module *mod, struct ldb_request *req)
2100 PyObject *py_ldb = (PyObject *)mod->private_data;
2101 PyObject *py_result;
2103 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "request"),
2104 discard_const_p(char, ""));
2106 return LDB_ERR_OPERATIONS_ERROR;
2109 static int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
2111 PyObject *py_ldb = (PyObject *)mod->private_data;
2112 PyObject *py_result;
2114 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "extended"),
2115 discard_const_p(char, ""));
2117 return LDB_ERR_OPERATIONS_ERROR;
2120 static int py_module_start_transaction(struct ldb_module *mod)
2122 PyObject *py_ldb = (PyObject *)mod->private_data;
2123 PyObject *py_result;
2125 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "start_transaction"),
2126 discard_const_p(char, ""));
2128 if (py_result == NULL) {
2129 return LDB_ERR_PYTHON_EXCEPTION;
2132 Py_DECREF(py_result);
2134 return LDB_SUCCESS;
2137 static int py_module_end_transaction(struct ldb_module *mod)
2139 PyObject *py_ldb = (PyObject *)mod->private_data;
2140 PyObject *py_result;
2142 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "end_transaction"),
2143 discard_const_p(char, ""));
2145 if (py_result == NULL) {
2146 return LDB_ERR_PYTHON_EXCEPTION;
2149 Py_DECREF(py_result);
2151 return LDB_SUCCESS;
2154 static int py_module_del_transaction(struct ldb_module *mod)
2156 PyObject *py_ldb = (PyObject *)mod->private_data;
2157 PyObject *py_result;
2159 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "del_transaction"),
2160 discard_const_p(char, ""));
2162 if (py_result == NULL) {
2163 return LDB_ERR_PYTHON_EXCEPTION;
2166 Py_DECREF(py_result);
2168 return LDB_SUCCESS;
2171 static int py_module_destructor(struct ldb_module *mod)
2173 Py_DECREF((PyObject *)mod->private_data);
2174 return 0;
2177 static int py_module_init(struct ldb_module *mod)
2179 PyObject *py_class = (PyObject *)mod->ops->private_data;
2180 PyObject *py_result, *py_next, *py_ldb;
2182 py_ldb = PyLdb_FromLdbContext(mod->ldb);
2184 if (py_ldb == NULL)
2185 return LDB_ERR_OPERATIONS_ERROR;
2187 py_next = PyLdbModule_FromModule(mod->next);
2189 if (py_next == NULL)
2190 return LDB_ERR_OPERATIONS_ERROR;
2192 py_result = PyObject_CallFunction(py_class, discard_const_p(char, "OO"),
2193 py_ldb, py_next);
2195 if (py_result == NULL) {
2196 return LDB_ERR_PYTHON_EXCEPTION;
2199 mod->private_data = py_result;
2201 talloc_set_destructor(mod, py_module_destructor);
2203 return ldb_next_init(mod);
2206 static PyObject *py_register_module(PyObject *module, PyObject *args)
2208 int ret;
2209 struct ldb_module_ops *ops;
2210 PyObject *input;
2212 if (!PyArg_ParseTuple(args, "O", &input))
2213 return NULL;
2215 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
2216 if (ops == NULL) {
2217 PyErr_NoMemory();
2218 return NULL;
2221 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, discard_const_p(char, "name"))));
2223 Py_INCREF(input);
2224 ops->private_data = input;
2225 ops->init_context = py_module_init;
2226 ops->search = py_module_search;
2227 ops->add = py_module_add;
2228 ops->modify = py_module_modify;
2229 ops->del = py_module_del;
2230 ops->rename = py_module_rename;
2231 ops->request = py_module_request;
2232 ops->extended = py_module_extended;
2233 ops->start_transaction = py_module_start_transaction;
2234 ops->end_transaction = py_module_end_transaction;
2235 ops->del_transaction = py_module_del_transaction;
2237 ret = ldb_register_module(ops);
2239 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
2241 Py_RETURN_NONE;
2244 static PyObject *py_timestring(PyObject *module, PyObject *args)
2246 time_t t;
2247 char *tresult;
2248 PyObject *ret;
2249 if (!PyArg_ParseTuple(args, "L", &t))
2250 return NULL;
2251 tresult = ldb_timestring(NULL, t);
2252 ret = PyString_FromString(tresult);
2253 talloc_free(tresult);
2254 return ret;
2257 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
2259 char *str;
2260 if (!PyArg_ParseTuple(args, "s", &str))
2261 return NULL;
2263 return PyInt_FromLong(ldb_string_to_time(str));
2266 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
2268 char *name;
2269 if (!PyArg_ParseTuple(args, "s", &name))
2270 return NULL;
2271 return PyBool_FromLong(ldb_valid_attr_name(name));
2274 static PyMethodDef py_ldb_global_methods[] = {
2275 { "register_module", py_register_module, METH_VARARGS,
2276 "S.register_module(module) -> None\n"
2277 "Register a LDB module."},
2278 { "timestring", py_timestring, METH_VARARGS,
2279 "S.timestring(int) -> string\n"
2280 "Generate a LDAP time string from a UNIX timestamp" },
2281 { "string_to_time", py_string_to_time, METH_VARARGS,
2282 "S.string_to_time(string) -> int\n"
2283 "Parse a LDAP time string into a UNIX timestamp." },
2284 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
2285 "S.valid_attr_name(name) -> bool\n"
2286 "Check whether the supplied name is a valid attribute name." },
2287 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
2288 NULL },
2289 { NULL }
2292 void initldb(void)
2294 PyObject *m;
2296 if (PyType_Ready(&PyLdbDn) < 0)
2297 return;
2299 if (PyType_Ready(&PyLdbMessage) < 0)
2300 return;
2302 if (PyType_Ready(&PyLdbMessageElement) < 0)
2303 return;
2305 if (PyType_Ready(&PyLdb) < 0)
2306 return;
2308 if (PyType_Ready(&PyLdbModule) < 0)
2309 return;
2311 if (PyType_Ready(&PyLdbTree) < 0)
2312 return;
2314 m = Py_InitModule3("ldb", py_ldb_global_methods,
2315 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
2316 if (m == NULL)
2317 return;
2319 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
2320 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
2321 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
2322 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
2324 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
2325 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
2326 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
2327 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
2329 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
2330 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
2331 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
2332 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
2333 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
2334 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
2335 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
2336 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
2337 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
2338 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
2339 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
2340 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
2341 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
2342 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
2343 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
2344 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
2345 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
2346 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
2347 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
2348 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
2349 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
2350 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
2351 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
2352 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
2353 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
2354 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
2355 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
2356 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
2357 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
2358 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
2359 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
2360 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
2361 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
2362 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
2363 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
2364 PyModule_AddObject(m, "ERR_ENTRY_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
2365 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
2366 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
2367 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
2369 PyModule_AddObject(m, "FLG_RDONLY", PyInt_FromLong(LDB_FLG_RDONLY));
2370 PyModule_AddObject(m, "FLG_NOSYNC", PyInt_FromLong(LDB_FLG_NOSYNC));
2371 PyModule_AddObject(m, "FLG_RECONNECT", PyInt_FromLong(LDB_FLG_RECONNECT));
2372 PyModule_AddObject(m, "FLG_NOMMAP", PyInt_FromLong(LDB_FLG_NOMMAP));
2375 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
2377 PyExc_LdbError = PyErr_NewException(discard_const_p(char, "_ldb.LdbError"), NULL, NULL);
2378 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
2380 Py_INCREF(&PyLdb);
2381 Py_INCREF(&PyLdbDn);
2382 Py_INCREF(&PyLdbModule);
2383 Py_INCREF(&PyLdbMessage);
2384 Py_INCREF(&PyLdbMessageElement);
2385 Py_INCREF(&PyLdbTree);
2387 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
2388 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
2389 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
2390 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
2391 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
2392 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);