s4:pyldb - Fixed the return value in "py_ldb_msg_diff"
[Samba/ekacnet.git] / source4 / lib / ldb / pyldb.c
blob0fe4da988729e6986d58e4c7653c4b40bd8b04d1
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 struct ldb_context *ldb_ctx;
667 struct ldb_request *req;
668 PyObject *key, *value;
669 PyObject *py_controls = Py_None;
670 TALLOC_CTX *mem_ctx;
671 struct ldb_control **parsed_controls;
673 if (!PyArg_ParseTuple(args, "O|O", &py_msg, &py_controls ))
674 return NULL;
675 ldb_ctx = PyLdb_AsLdbContext(self);
677 mem_ctx = talloc_new(NULL);
678 if (py_controls == Py_None) {
679 parsed_controls = NULL;
680 } else {
681 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
682 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
683 talloc_free(controls);
685 if (PyDict_Check(py_msg)) {
686 PyObject *dn_value = PyDict_GetItemString(py_msg, "dn");
687 msg = ldb_msg_new(mem_ctx);
688 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
689 msg_pos = dict_pos = 0;
690 if (dn_value) {
691 if (!PyObject_AsDn(msg, dn_value, ldb_ctx, &msg->dn)) {
692 PyErr_SetString(PyExc_TypeError, "unable to import dn object");
693 talloc_free(mem_ctx);
694 return NULL;
696 if (msg->dn == NULL) {
697 PyErr_SetString(PyExc_TypeError, "dn set but not found");
698 talloc_free(mem_ctx);
699 return NULL;
703 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
704 char *key_str = PyString_AsString(key);
705 if (strcmp(key_str, "dn") != 0) {
706 msgel = PyObject_AsMessageElement(msg->elements, value, 0, key_str);
707 if (msgel == NULL) {
708 PyErr_SetString(PyExc_TypeError, "unable to import element");
709 talloc_free(mem_ctx);
710 return NULL;
712 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
713 msg_pos++;
717 if (msg->dn == NULL) {
718 PyErr_SetString(PyExc_TypeError, "no dn set");
719 talloc_free(mem_ctx);
720 return NULL;
723 msg->num_elements = msg_pos;
724 } else {
725 msg = PyLdbMessage_AsMessage(py_msg);
728 ret = ldb_msg_sanity_check(ldb_ctx, msg);
729 if (ret != LDB_SUCCESS) {
730 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
731 talloc_free(mem_ctx);
732 return NULL;
735 ret = ldb_build_add_req(&req, ldb_ctx, ldb_ctx,
736 msg,
737 parsed_controls,
738 NULL,
739 ldb_op_default_callback,
740 NULL);
742 if (ret != LDB_SUCCESS) {
743 PyErr_SetString(PyExc_TypeError, "failed to build request");
744 talloc_free(mem_ctx);
745 return NULL;
748 /* do request and autostart a transaction */
749 /* Then let's LDB handle the message error in case of pb as they are meaningful */
751 ret = ldb_transaction_start(ldb_ctx);
752 if (ret != LDB_SUCCESS) {
753 talloc_free(req);
754 talloc_free(mem_ctx);
755 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
758 ret = ldb_request(ldb_ctx, req);
759 if (ret == LDB_SUCCESS) {
760 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
763 if (ret == LDB_SUCCESS) {
764 ret = ldb_transaction_commit(ldb_ctx);
765 } else {
766 ldb_transaction_cancel(ldb_ctx);
767 if (ldb_ctx->err_string == NULL) {
768 /* no error string was setup by the backend */
769 ldb_asprintf_errstring(ldb_ctx, "%s (%d)", ldb_strerror(ret), ret);
772 talloc_free(req);
773 talloc_free(mem_ctx);
774 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
776 Py_RETURN_NONE;
779 static PyObject *py_ldb_delete(PyLdbObject *self, PyObject *args)
781 PyObject *py_dn;
782 struct ldb_dn *dn;
783 int ret;
784 struct ldb_context *ldb;
785 if (!PyArg_ParseTuple(args, "O", &py_dn))
786 return NULL;
788 ldb = PyLdb_AsLdbContext(self);
790 if (!PyObject_AsDn(NULL, py_dn, ldb, &dn))
791 return NULL;
793 ret = ldb_delete(ldb, dn);
794 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
796 Py_RETURN_NONE;
799 static PyObject *py_ldb_rename(PyLdbObject *self, PyObject *args)
801 PyObject *py_dn1, *py_dn2;
802 struct ldb_dn *dn1, *dn2;
803 int ret;
804 struct ldb_context *ldb;
805 TALLOC_CTX *mem_ctx;
806 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
807 return NULL;
809 mem_ctx = talloc_new(NULL);
810 if (mem_ctx == NULL) {
811 PyErr_NoMemory();
812 return NULL;
814 ldb = PyLdb_AsLdbContext(self);
815 if (!PyObject_AsDn(mem_ctx, py_dn1, ldb, &dn1)) {
816 talloc_free(mem_ctx);
817 return NULL;
820 if (!PyObject_AsDn(mem_ctx, py_dn2, ldb, &dn2)) {
821 talloc_free(mem_ctx);
822 return NULL;
825 ret = ldb_rename(ldb, dn1, dn2);
826 talloc_free(mem_ctx);
827 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb);
829 Py_RETURN_NONE;
832 static PyObject *py_ldb_schema_attribute_remove(PyLdbObject *self, PyObject *args)
834 char *name;
835 if (!PyArg_ParseTuple(args, "s", &name))
836 return NULL;
838 ldb_schema_attribute_remove(PyLdb_AsLdbContext(self), name);
840 Py_RETURN_NONE;
843 static PyObject *py_ldb_schema_attribute_add(PyLdbObject *self, PyObject *args)
845 char *attribute, *syntax;
846 unsigned int flags;
847 int ret;
848 if (!PyArg_ParseTuple(args, "sIs", &attribute, &flags, &syntax))
849 return NULL;
851 ret = ldb_schema_attribute_add(PyLdb_AsLdbContext(self), attribute, flags, syntax);
853 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, PyLdb_AsLdbContext(self));
855 Py_RETURN_NONE;
858 static PyObject *ldb_ldif_to_pyobject(struct ldb_ldif *ldif)
860 if (ldif == NULL) {
861 Py_RETURN_NONE;
862 } else {
863 /* We don't want this attached to the 'ldb' any more */
864 return Py_BuildValue(discard_const_p(char, "(iO)"),
865 ldif->changetype,
866 PyLdbMessage_FromMessage(ldif->msg));
871 static PyObject *py_ldb_write_ldif(PyLdbMessageObject *self, PyObject *args)
873 int changetype;
874 PyObject *py_msg;
875 struct ldb_ldif ldif;
876 PyObject *ret;
877 char *string;
878 TALLOC_CTX *mem_ctx;
880 if (!PyArg_ParseTuple(args, "Oi", &py_msg, &changetype))
881 return NULL;
883 if (!PyLdbMessage_Check(py_msg)) {
884 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for msg");
885 return NULL;
888 ldif.msg = PyLdbMessage_AsMessage(py_msg);
889 ldif.changetype = changetype;
891 mem_ctx = talloc_new(NULL);
893 string = ldb_ldif_write_string(PyLdb_AsLdbContext(self), mem_ctx, &ldif);
894 if (!string) {
895 PyErr_SetString(PyExc_KeyError, "Failed to generate LDIF");
896 return NULL;
899 ret = PyString_FromString(string);
901 talloc_free(mem_ctx);
903 return ret;
906 static PyObject *py_ldb_parse_ldif(PyLdbObject *self, PyObject *args)
908 PyObject *list;
909 struct ldb_ldif *ldif;
910 const char *s;
912 TALLOC_CTX *mem_ctx;
914 if (!PyArg_ParseTuple(args, "s", &s))
915 return NULL;
917 mem_ctx = talloc_new(NULL);
918 if (!mem_ctx) {
919 Py_RETURN_NONE;
922 list = PyList_New(0);
923 while (s && *s != '\0') {
924 ldif = ldb_ldif_read_string(self->ldb_ctx, &s);
925 talloc_steal(mem_ctx, ldif);
926 if (ldif) {
927 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
928 } else {
929 PyErr_SetString(PyExc_ValueError, "unable to parse ldif string");
930 talloc_free(mem_ctx);
931 return NULL;
934 talloc_free(mem_ctx); /* The pyobject already has a reference to the things it needs */
935 return PyObject_GetIter(list);
938 static PyObject *py_ldb_msg_diff(PyLdbObject *self, PyObject *args)
940 PyObject *py_msg_old;
941 PyObject *py_msg_new;
942 struct ldb_message *diff;
943 PyObject *py_ret;
945 if (!PyArg_ParseTuple(args, "OO", &py_msg_old, &py_msg_new))
946 return NULL;
948 if (!PyLdbMessage_Check(py_msg_old)) {
949 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for old message");
950 return NULL;
953 if (!PyLdbMessage_Check(py_msg_new)) {
954 PyErr_SetString(PyExc_TypeError, "Expected Ldb Message for new message");
955 return NULL;
958 diff = ldb_msg_diff(PyLdb_AsLdbContext(self), PyLdbMessage_AsMessage(py_msg_old), PyLdbMessage_AsMessage(py_msg_new));
960 py_ret = PyLdbMessage_FromMessage(diff);
962 return py_ret;
965 static PyObject *py_ldb_schema_format_value(PyLdbObject *self, PyObject *args)
967 const struct ldb_schema_attribute *a;
968 struct ldb_val old_val;
969 struct ldb_val new_val;
970 TALLOC_CTX *mem_ctx;
971 PyObject *ret;
972 char *element_name;
973 PyObject *val;
975 if (!PyArg_ParseTuple(args, "sO", &element_name, &val))
976 return NULL;
978 mem_ctx = talloc_new(NULL);
980 old_val.data = (uint8_t *)PyString_AsString(val);
981 old_val.length = PyString_Size(val);
983 a = ldb_schema_attribute_by_name(PyLdb_AsLdbContext(self), element_name);
985 if (a == NULL) {
986 Py_RETURN_NONE;
989 if (a->syntax->ldif_write_fn(PyLdb_AsLdbContext(self), mem_ctx, &old_val, &new_val) != 0) {
990 talloc_free(mem_ctx);
991 Py_RETURN_NONE;
994 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
996 talloc_free(mem_ctx);
998 return ret;
1001 static PyObject *py_ldb_search(PyLdbObject *self, PyObject *args, PyObject *kwargs)
1003 PyObject *py_base = Py_None;
1004 enum ldb_scope scope = LDB_SCOPE_DEFAULT;
1005 char *expr = NULL;
1006 PyObject *py_attrs = Py_None;
1007 PyObject *py_controls = Py_None;
1008 const char * const kwnames[] = { "base", "scope", "expression", "attrs", "controls", NULL };
1009 int ret;
1010 struct ldb_result *res;
1011 struct ldb_request *req;
1012 const char **attrs;
1013 struct ldb_context *ldb_ctx;
1014 struct ldb_control **parsed_controls;
1015 struct ldb_dn *base;
1016 PyObject *py_ret;
1018 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OizOO",
1019 discard_const_p(char *, kwnames),
1020 &py_base, &scope, &expr, &py_attrs, &py_controls))
1021 return NULL;
1023 ldb_ctx = PyLdb_AsLdbContext(self);
1025 if (py_attrs == Py_None) {
1026 attrs = NULL;
1027 } else {
1028 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1029 if (attrs == NULL)
1030 return NULL;
1033 if (py_base == Py_None) {
1034 base = ldb_get_default_basedn(ldb_ctx);
1035 } else {
1036 if (!PyObject_AsDn(ldb_ctx, py_base, ldb_ctx, &base)) {
1037 talloc_free(attrs);
1038 return NULL;
1042 if (py_controls == Py_None) {
1043 parsed_controls = NULL;
1044 } else {
1045 const char **controls = PyList_AsStringList(ldb_ctx, py_controls, "controls");
1046 parsed_controls = ldb_parse_control_strings(ldb_ctx, ldb_ctx, controls);
1047 talloc_free(controls);
1050 res = talloc_zero(ldb_ctx, struct ldb_result);
1051 if (res == NULL) {
1052 PyErr_NoMemory();
1053 talloc_free(attrs);
1054 return NULL;
1057 ret = ldb_build_search_req(&req, ldb_ctx, ldb_ctx,
1058 base,
1059 scope,
1060 expr,
1061 attrs,
1062 parsed_controls,
1063 res,
1064 ldb_search_default_callback,
1065 NULL);
1067 talloc_steal(req, attrs);
1069 if (ret != LDB_SUCCESS) {
1070 talloc_free(res);
1071 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1072 return NULL;
1075 ret = ldb_request(ldb_ctx, req);
1077 if (ret == LDB_SUCCESS) {
1078 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
1081 talloc_free(req);
1083 if (ret != LDB_SUCCESS) {
1084 talloc_free(res);
1085 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, ldb_ctx);
1086 return NULL;
1089 py_ret = PyLdbResult_FromResult(res);
1091 talloc_free(res);
1093 return py_ret;
1096 static PyObject *py_ldb_get_opaque(PyLdbObject *self, PyObject *args)
1098 char *name;
1099 void *data;
1101 if (!PyArg_ParseTuple(args, "s", &name))
1102 return NULL;
1104 data = ldb_get_opaque(PyLdb_AsLdbContext(self), name);
1106 if (data == NULL)
1107 Py_RETURN_NONE;
1109 /* FIXME: More interpretation */
1111 return Py_True;
1114 static PyObject *py_ldb_set_opaque(PyLdbObject *self, PyObject *args)
1116 char *name;
1117 PyObject *data;
1119 if (!PyArg_ParseTuple(args, "sO", &name, &data))
1120 return NULL;
1122 /* FIXME: More interpretation */
1124 ldb_set_opaque(PyLdb_AsLdbContext(self), name, data);
1126 Py_RETURN_NONE;
1129 static PyObject *py_ldb_modules(PyLdbObject *self)
1131 struct ldb_context *ldb = PyLdb_AsLdbContext(self);
1132 PyObject *ret = PyList_New(0);
1133 struct ldb_module *mod;
1135 for (mod = ldb->modules; mod; mod = mod->next) {
1136 PyList_Append(ret, PyLdbModule_FromModule(mod));
1139 return ret;
1142 static PyMethodDef py_ldb_methods[] = {
1143 { "set_debug", (PyCFunction)py_ldb_set_debug, METH_VARARGS,
1144 "S.set_debug(callback) -> None\n"
1145 "Set callback for LDB debug messages.\n"
1146 "The callback should accept a debug level and debug text." },
1147 { "set_create_perms", (PyCFunction)py_ldb_set_create_perms, METH_VARARGS,
1148 "S.set_create_perms(mode) -> None\n"
1149 "Set mode to use when creating new LDB files." },
1150 { "set_modules_dir", (PyCFunction)py_ldb_set_modules_dir, METH_VARARGS,
1151 "S.set_modules_dir(path) -> None\n"
1152 "Set path LDB should search for modules" },
1153 { "transaction_start", (PyCFunction)py_ldb_transaction_start, METH_NOARGS,
1154 "S.transaction_start() -> None\n"
1155 "Start a new transaction." },
1156 { "transaction_commit", (PyCFunction)py_ldb_transaction_commit, METH_NOARGS,
1157 "S.transaction_commit() -> None\n"
1158 "commit a new transaction." },
1159 { "transaction_cancel", (PyCFunction)py_ldb_transaction_cancel, METH_NOARGS,
1160 "S.transaction_cancel() -> None\n"
1161 "cancel a new transaction." },
1162 { "setup_wellknown_attributes", (PyCFunction)py_ldb_setup_wellknown_attributes, METH_NOARGS,
1163 NULL },
1164 { "get_root_basedn", (PyCFunction)py_ldb_get_root_basedn, METH_NOARGS,
1165 NULL },
1166 { "get_schema_basedn", (PyCFunction)py_ldb_get_schema_basedn, METH_NOARGS,
1167 NULL },
1168 { "get_default_basedn", (PyCFunction)py_ldb_get_default_basedn, METH_NOARGS,
1169 NULL },
1170 { "get_config_basedn", (PyCFunction)py_ldb_get_config_basedn, METH_NOARGS,
1171 NULL },
1172 { "connect", (PyCFunction)py_ldb_connect, METH_VARARGS|METH_KEYWORDS,
1173 "S.connect(url, flags=0, options=None) -> None\n"
1174 "Connect to a LDB URL." },
1175 { "modify", (PyCFunction)py_ldb_modify, METH_VARARGS,
1176 "S.modify(message) -> None\n"
1177 "Modify an entry." },
1178 { "add", (PyCFunction)py_ldb_add, METH_VARARGS,
1179 "S.add(message) -> None\n"
1180 "Add an entry." },
1181 { "delete", (PyCFunction)py_ldb_delete, METH_VARARGS,
1182 "S.delete(dn) -> None\n"
1183 "Remove an entry." },
1184 { "rename", (PyCFunction)py_ldb_rename, METH_VARARGS,
1185 "S.rename(old_dn, new_dn) -> None\n"
1186 "Rename an entry." },
1187 { "search", (PyCFunction)py_ldb_search, METH_VARARGS|METH_KEYWORDS,
1188 "S.search(base=None, scope=None, expression=None, attrs=None, controls=None) -> msgs\n"
1189 "Search in a database.\n"
1190 "\n"
1191 ":param base: Optional base DN to search\n"
1192 ":param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)\n"
1193 ":param expression: Optional search expression\n"
1194 ":param attrs: Attributes to return (defaults to all)\n"
1195 ":param controls: Optional list of controls\n"
1196 ":return: Iterator over Message objects\n"
1198 { "schema_attribute_remove", (PyCFunction)py_ldb_schema_attribute_remove, METH_VARARGS,
1199 NULL },
1200 { "schema_attribute_add", (PyCFunction)py_ldb_schema_attribute_add, METH_VARARGS,
1201 NULL },
1202 { "schema_format_value", (PyCFunction)py_ldb_schema_format_value, METH_VARARGS,
1203 NULL },
1204 { "parse_ldif", (PyCFunction)py_ldb_parse_ldif, METH_VARARGS,
1205 "S.parse_ldif(ldif) -> iter(messages)\n"
1206 "Parse a string formatted using LDIF." },
1207 { "write_ldif", (PyCFunction)py_ldb_write_ldif, METH_VARARGS,
1208 "S.write_ldif(message, changetype) -> ldif\n"
1209 "Print the message as a string formatted using LDIF." },
1210 { "msg_diff", (PyCFunction)py_ldb_msg_diff, METH_VARARGS,
1211 "S.msg_diff(Message) -> Message\n"
1212 "Return an LDB Message of the difference between two Message objects." },
1213 { "get_opaque", (PyCFunction)py_ldb_get_opaque, METH_VARARGS,
1214 "S.get_opaque(name) -> value\n"
1215 "Get an opaque value set on this LDB connection. \n"
1216 ":note: The returned value may not be useful in Python."
1218 { "set_opaque", (PyCFunction)py_ldb_set_opaque, METH_VARARGS,
1219 "S.set_opaque(name, value) -> None\n"
1220 "Set an opaque value on this LDB connection. \n"
1221 ":note: Passing incorrect values may cause crashes." },
1222 { "modules", (PyCFunction)py_ldb_modules, METH_NOARGS,
1223 "S.modules() -> list\n"
1224 "Return the list of modules on this LDB connection " },
1225 { NULL },
1228 PyObject *PyLdbModule_FromModule(struct ldb_module *mod)
1230 PyLdbModuleObject *ret;
1232 ret = (PyLdbModuleObject *)PyLdbModule.tp_alloc(&PyLdbModule, 0);
1233 if (ret == NULL) {
1234 PyErr_NoMemory();
1235 return NULL;
1237 ret->mem_ctx = talloc_new(NULL);
1238 ret->mod = talloc_reference(ret->mem_ctx, mod);
1239 return (PyObject *)ret;
1242 static PyObject *py_ldb_get_firstmodule(PyLdbObject *self, void *closure)
1244 return PyLdbModule_FromModule(PyLdb_AsLdbContext(self)->modules);
1247 static PyGetSetDef py_ldb_getset[] = {
1248 { discard_const_p(char, "firstmodule"), (getter)py_ldb_get_firstmodule, NULL, NULL },
1249 { NULL }
1252 static int py_ldb_contains(PyLdbObject *self, PyObject *obj)
1254 struct ldb_context *ldb_ctx = PyLdb_AsLdbContext(self);
1255 struct ldb_dn *dn;
1256 struct ldb_result *result;
1257 int ret;
1258 int count;
1260 if (!PyObject_AsDn(ldb_ctx, obj, ldb_ctx, &dn))
1261 return -1;
1263 ret = ldb_search(ldb_ctx, ldb_ctx, &result, dn, LDB_SCOPE_BASE, NULL, NULL);
1264 if (ret != LDB_SUCCESS) {
1265 PyErr_SetLdbError(PyExc_LdbError, ret, ldb_ctx);
1266 return -1;
1269 count = result->count;
1271 talloc_free(result);
1273 return count;
1276 static PySequenceMethods py_ldb_seq = {
1277 .sq_contains = (objobjproc)py_ldb_contains,
1280 PyObject *PyLdb_FromLdbContext(struct ldb_context *ldb_ctx)
1282 PyLdbObject *ret;
1284 ret = (PyLdbObject *)PyLdb.tp_alloc(&PyLdb, 0);
1285 if (ret == NULL) {
1286 PyErr_NoMemory();
1287 return NULL;
1289 ret->mem_ctx = talloc_new(NULL);
1290 ret->ldb_ctx = talloc_reference(ret->mem_ctx, ldb_ctx);
1291 return (PyObject *)ret;
1294 static void py_ldb_dealloc(PyLdbObject *self)
1296 talloc_free(self->mem_ctx);
1297 self->ob_type->tp_free(self);
1300 PyTypeObject PyLdb = {
1301 .tp_name = "Ldb",
1302 .tp_methods = py_ldb_methods,
1303 .tp_repr = (reprfunc)py_ldb_repr,
1304 .tp_new = py_ldb_new,
1305 .tp_init = (initproc)py_ldb_init,
1306 .tp_dealloc = (destructor)py_ldb_dealloc,
1307 .tp_getset = py_ldb_getset,
1308 .tp_getattro = PyObject_GenericGetAttr,
1309 .tp_basicsize = sizeof(PyLdbObject),
1310 .tp_doc = "Connection to a LDB database.",
1311 .tp_as_sequence = &py_ldb_seq,
1312 .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
1315 static PyObject *py_ldb_module_repr(PyLdbModuleObject *self)
1317 return PyString_FromFormat("<ldb module '%s'>", PyLdbModule_AsModule(self)->ops->name);
1320 static PyObject *py_ldb_module_str(PyLdbModuleObject *self)
1322 return PyString_FromString(PyLdbModule_AsModule(self)->ops->name);
1325 static PyObject *py_ldb_module_start_transaction(PyLdbModuleObject *self)
1327 PyLdbModule_AsModule(self)->ops->start_transaction(PyLdbModule_AsModule(self));
1328 Py_RETURN_NONE;
1331 static PyObject *py_ldb_module_end_transaction(PyLdbModuleObject *self)
1333 PyLdbModule_AsModule(self)->ops->end_transaction(PyLdbModule_AsModule(self));
1334 Py_RETURN_NONE;
1337 static PyObject *py_ldb_module_del_transaction(PyLdbModuleObject *self)
1339 PyLdbModule_AsModule(self)->ops->del_transaction(PyLdbModule_AsModule(self));
1340 Py_RETURN_NONE;
1343 static PyObject *py_ldb_module_search(PyLdbModuleObject *self, PyObject *args, PyObject *kwargs)
1345 PyObject *py_base, *py_tree, *py_attrs, *py_ret;
1346 int ret, scope;
1347 struct ldb_request *req;
1348 const char * const kwnames[] = { "base", "scope", "tree", "attrs", NULL };
1349 struct ldb_module *mod;
1350 const char * const*attrs;
1352 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OiOO",
1353 discard_const_p(char *, kwnames),
1354 &py_base, &scope, &py_tree, &py_attrs))
1355 return NULL;
1357 mod = self->mod;
1359 if (py_attrs == Py_None) {
1360 attrs = NULL;
1361 } else {
1362 attrs = PyList_AsStringList(NULL, py_attrs, "attrs");
1363 if (attrs == NULL)
1364 return NULL;
1367 ret = ldb_build_search_req(&req, mod->ldb, NULL, PyLdbDn_AsDn(py_base),
1368 scope, NULL /* expr */, attrs,
1369 NULL /* controls */, NULL, NULL, NULL);
1371 talloc_steal(req, attrs);
1373 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1375 req->op.search.res = NULL;
1377 ret = mod->ops->search(mod, req);
1379 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1381 py_ret = PyLdbResult_FromResult(req->op.search.res);
1383 talloc_free(req);
1385 return py_ret;
1389 static PyObject *py_ldb_module_add(PyLdbModuleObject *self, PyObject *args)
1391 struct ldb_request *req;
1392 PyObject *py_message;
1393 int ret;
1394 struct ldb_module *mod;
1396 if (!PyArg_ParseTuple(args, "O", &py_message))
1397 return NULL;
1399 req = talloc_zero(NULL, struct ldb_request);
1400 req->operation = LDB_ADD;
1401 req->op.add.message = PyLdbMessage_AsMessage(py_message);
1403 mod = PyLdbModule_AsModule(self);
1404 ret = mod->ops->add(mod, req);
1406 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1408 Py_RETURN_NONE;
1411 static PyObject *py_ldb_module_modify(PyLdbModuleObject *self, PyObject *args)
1413 int ret;
1414 struct ldb_request *req;
1415 PyObject *py_message;
1416 struct ldb_module *mod;
1418 if (!PyArg_ParseTuple(args, "O", &py_message))
1419 return NULL;
1421 req = talloc_zero(NULL, struct ldb_request);
1422 req->operation = LDB_MODIFY;
1423 req->op.mod.message = PyLdbMessage_AsMessage(py_message);
1425 mod = PyLdbModule_AsModule(self);
1426 ret = mod->ops->modify(mod, req);
1428 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, mod->ldb);
1430 Py_RETURN_NONE;
1433 static PyObject *py_ldb_module_delete(PyLdbModuleObject *self, PyObject *args)
1435 int ret;
1436 struct ldb_request *req;
1437 PyObject *py_dn;
1439 if (!PyArg_ParseTuple(args, "O", &py_dn))
1440 return NULL;
1442 req = talloc_zero(NULL, struct ldb_request);
1443 req->operation = LDB_DELETE;
1444 req->op.del.dn = PyLdbDn_AsDn(py_dn);
1446 ret = PyLdbModule_AsModule(self)->ops->del(PyLdbModule_AsModule(self), req);
1448 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1450 Py_RETURN_NONE;
1453 static PyObject *py_ldb_module_rename(PyLdbModuleObject *self, PyObject *args)
1455 int ret;
1456 struct ldb_request *req;
1457 PyObject *py_dn1, *py_dn2;
1459 if (!PyArg_ParseTuple(args, "OO", &py_dn1, &py_dn2))
1460 return NULL;
1462 req = talloc_zero(NULL, struct ldb_request);
1464 req->operation = LDB_RENAME;
1465 req->op.rename.olddn = PyLdbDn_AsDn(py_dn1);
1466 req->op.rename.newdn = PyLdbDn_AsDn(py_dn2);
1468 ret = PyLdbModule_AsModule(self)->ops->rename(PyLdbModule_AsModule(self), req);
1470 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
1472 Py_RETURN_NONE;
1475 static PyMethodDef py_ldb_module_methods[] = {
1476 { "search", (PyCFunction)py_ldb_module_search, METH_VARARGS|METH_KEYWORDS, NULL },
1477 { "add", (PyCFunction)py_ldb_module_add, METH_VARARGS, NULL },
1478 { "modify", (PyCFunction)py_ldb_module_modify, METH_VARARGS, NULL },
1479 { "rename", (PyCFunction)py_ldb_module_rename, METH_VARARGS, NULL },
1480 { "delete", (PyCFunction)py_ldb_module_delete, METH_VARARGS, NULL },
1481 { "start_transaction", (PyCFunction)py_ldb_module_start_transaction, METH_NOARGS, NULL },
1482 { "end_transaction", (PyCFunction)py_ldb_module_end_transaction, METH_NOARGS, NULL },
1483 { "del_transaction", (PyCFunction)py_ldb_module_del_transaction, METH_NOARGS, NULL },
1484 { NULL },
1487 static void py_ldb_module_dealloc(PyLdbModuleObject *self)
1489 talloc_free(self->mem_ctx);
1490 self->ob_type->tp_free(self);
1493 PyTypeObject PyLdbModule = {
1494 .tp_name = "LdbModule",
1495 .tp_methods = py_ldb_module_methods,
1496 .tp_repr = (reprfunc)py_ldb_module_repr,
1497 .tp_str = (reprfunc)py_ldb_module_str,
1498 .tp_basicsize = sizeof(PyLdbModuleObject),
1499 .tp_dealloc = (destructor)py_ldb_module_dealloc,
1500 .tp_flags = Py_TPFLAGS_DEFAULT,
1505 * Create a ldb_message_element from a Python object.
1507 * This will accept any sequence objects that contains strings, or
1508 * a string object.
1510 * A reference to set_obj will be borrowed.
1512 * @param mem_ctx Memory context
1513 * @param set_obj Python object to convert
1514 * @param flags ldb_message_element flags to set
1515 * @param attr_name Name of the attribute
1516 * @return New ldb_message_element, allocated as child of mem_ctx
1518 struct ldb_message_element *PyObject_AsMessageElement(TALLOC_CTX *mem_ctx,
1519 PyObject *set_obj, int flags,
1520 const char *attr_name)
1522 struct ldb_message_element *me;
1524 if (PyLdbMessageElement_Check(set_obj))
1525 return talloc_reference(mem_ctx,
1526 PyLdbMessageElement_AsMessageElement(set_obj));
1528 me = talloc(mem_ctx, struct ldb_message_element);
1530 me->name = talloc_strdup(me, attr_name);
1531 me->flags = flags;
1532 if (PyString_Check(set_obj)) {
1533 me->num_values = 1;
1534 me->values = talloc_array(me, struct ldb_val, me->num_values);
1535 me->values[0].length = PyString_Size(set_obj);
1536 me->values[0].data = talloc_memdup(me,
1537 (uint8_t *)PyString_AsString(set_obj), me->values[0].length);
1538 } else if (PySequence_Check(set_obj)) {
1539 int i;
1540 me->num_values = PySequence_Size(set_obj);
1541 me->values = talloc_array(me, struct ldb_val, me->num_values);
1542 for (i = 0; i < me->num_values; i++) {
1543 PyObject *obj = PySequence_GetItem(set_obj, i);
1545 me->values[i].length = PyString_Size(obj);
1546 me->values[i].data = talloc_memdup(me,
1547 (uint8_t *)PyString_AsString(obj), me->values[i].length);
1549 } else {
1550 talloc_free(me);
1551 me = NULL;
1554 return me;
1558 static PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
1559 struct ldb_message_element *me)
1561 int i;
1562 PyObject *result;
1564 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
1565 result = PyList_New(me->num_values);
1567 for (i = 0; i < me->num_values; i++) {
1568 PyList_SetItem(result, i,
1569 PyObject_FromLdbValue(ldb_ctx, me, &me->values[i]));
1572 return result;
1575 static PyObject *py_ldb_msg_element_get(PyLdbMessageElementObject *self, PyObject *args)
1577 int i;
1578 if (!PyArg_ParseTuple(args, "i", &i))
1579 return NULL;
1580 if (i < 0 || i >= PyLdbMessageElement_AsMessageElement(self)->num_values)
1581 Py_RETURN_NONE;
1583 return PyObject_FromLdbValue(NULL, PyLdbMessageElement_AsMessageElement(self),
1584 &(PyLdbMessageElement_AsMessageElement(self)->values[i]));
1587 static PyObject *py_ldb_msg_element_flags(PyLdbMessageElementObject *self, PyObject *args)
1589 struct ldb_message_element *el;
1591 el = PyLdbMessageElement_AsMessageElement(self);
1592 return PyInt_FromLong(el->flags);
1595 static PyObject *py_ldb_msg_element_set_flags(PyLdbMessageElementObject *self, PyObject *args)
1597 int flags;
1598 struct ldb_message_element *el;
1599 if (!PyArg_ParseTuple(args, "i", &flags))
1600 return NULL;
1602 el = PyLdbMessageElement_AsMessageElement(self);
1603 el->flags = flags;
1604 Py_RETURN_NONE;
1607 static PyMethodDef py_ldb_msg_element_methods[] = {
1608 { "get", (PyCFunction)py_ldb_msg_element_get, METH_VARARGS, NULL },
1609 { "set_flags", (PyCFunction)py_ldb_msg_element_set_flags, METH_VARARGS, NULL },
1610 { "flags", (PyCFunction)py_ldb_msg_element_flags, METH_NOARGS, NULL },
1611 { NULL },
1614 static Py_ssize_t py_ldb_msg_element_len(PyLdbMessageElementObject *self)
1616 return PyLdbMessageElement_AsMessageElement(self)->num_values;
1619 static PyObject *py_ldb_msg_element_find(PyLdbMessageElementObject *self, Py_ssize_t idx)
1621 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1622 if (idx < 0 || idx >= el->num_values) {
1623 PyErr_SetString(PyExc_IndexError, "Out of range");
1624 return NULL;
1626 return PyString_FromStringAndSize((char *)el->values[idx].data, el->values[idx].length);
1629 static PySequenceMethods py_ldb_msg_element_seq = {
1630 .sq_length = (lenfunc)py_ldb_msg_element_len,
1631 .sq_item = (ssizeargfunc)py_ldb_msg_element_find,
1634 static int py_ldb_msg_element_cmp(PyLdbMessageElementObject *self, PyLdbMessageElementObject *other)
1636 return ldb_msg_element_compare(PyLdbMessageElement_AsMessageElement(self),
1637 PyLdbMessageElement_AsMessageElement(other));
1640 static PyObject *py_ldb_msg_element_iter(PyLdbMessageElementObject *self)
1642 return PyObject_GetIter(ldb_msg_element_to_set(NULL, PyLdbMessageElement_AsMessageElement(self)));
1645 PyObject *PyLdbMessageElement_FromMessageElement(struct ldb_message_element *el, TALLOC_CTX *mem_ctx)
1647 PyLdbMessageElementObject *ret;
1648 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1649 if (ret == NULL) {
1650 PyErr_NoMemory();
1651 return NULL;
1653 ret->mem_ctx = talloc_new(NULL);
1654 if (talloc_reference(ret->mem_ctx, mem_ctx) == NULL) {
1655 PyErr_NoMemory();
1656 return NULL;
1658 ret->el = el;
1659 return (PyObject *)ret;
1662 static PyObject *py_ldb_msg_element_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1664 PyObject *py_elements = NULL;
1665 struct ldb_message_element *el;
1666 int flags = 0;
1667 char *name = NULL;
1668 const char * const kwnames[] = { "elements", "flags", "name", NULL };
1669 PyLdbMessageElementObject *ret;
1670 TALLOC_CTX *mem_ctx;
1672 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Ois",
1673 discard_const_p(char *, kwnames),
1674 &py_elements, &flags, &name))
1675 return NULL;
1677 mem_ctx = talloc_new(NULL);
1678 if (mem_ctx == NULL) {
1679 PyErr_NoMemory();
1680 return NULL;
1683 el = talloc_zero(mem_ctx, struct ldb_message_element);
1685 if (py_elements != NULL) {
1686 int i;
1687 if (PyString_Check(py_elements)) {
1688 el->num_values = 1;
1689 el->values = talloc_array(el, struct ldb_val, 1);
1690 el->values[0].length = PyString_Size(py_elements);
1691 el->values[0].data = talloc_memdup(el,
1692 (uint8_t *)PyString_AsString(py_elements), el->values[0].length);
1693 } else if (PySequence_Check(py_elements)) {
1694 el->num_values = PySequence_Size(py_elements);
1695 el->values = talloc_array(el, struct ldb_val, el->num_values);
1696 for (i = 0; i < el->num_values; i++) {
1697 PyObject *item = PySequence_GetItem(py_elements, i);
1698 if (!PyString_Check(item)) {
1699 PyErr_Format(PyExc_TypeError,
1700 "Expected string as element %d in list",
1702 talloc_free(mem_ctx);
1703 return NULL;
1705 el->values[i].length = PyString_Size(item);
1706 el->values[i].data = talloc_memdup(el,
1707 (uint8_t *)PyString_AsString(item), el->values[i].length);
1709 } else {
1710 PyErr_SetString(PyExc_TypeError,
1711 "Expected string or list");
1712 talloc_free(mem_ctx);
1713 return NULL;
1717 el->flags = flags;
1718 el->name = talloc_strdup(el, name);
1720 ret = (PyLdbMessageElementObject *)PyLdbMessageElement.tp_alloc(&PyLdbMessageElement, 0);
1721 if (ret == NULL) {
1722 PyErr_NoMemory();
1723 talloc_free(mem_ctx);
1724 return NULL;
1727 ret->mem_ctx = mem_ctx;
1728 ret->el = el;
1729 return (PyObject *)ret;
1732 static PyObject *py_ldb_msg_element_repr(PyLdbMessageElementObject *self)
1734 char *element_str = NULL;
1735 int i;
1736 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1737 PyObject *ret;
1739 for (i = 0; i < el->num_values; i++) {
1740 PyObject *o = py_ldb_msg_element_find(self, i);
1741 if (element_str == NULL)
1742 element_str = talloc_strdup(NULL, PyObject_REPR(o));
1743 else
1744 element_str = talloc_asprintf_append(element_str, ",%s", PyObject_REPR(o));
1747 ret = PyString_FromFormat("MessageElement([%s])", element_str);
1749 talloc_free(element_str);
1751 return ret;
1754 static PyObject *py_ldb_msg_element_str(PyLdbMessageElementObject *self)
1756 struct ldb_message_element *el = PyLdbMessageElement_AsMessageElement(self);
1758 if (el->num_values == 1)
1759 return PyString_FromStringAndSize((char *)el->values[0].data, el->values[0].length);
1760 else
1761 Py_RETURN_NONE;
1764 static void py_ldb_msg_element_dealloc(PyLdbMessageElementObject *self)
1766 talloc_free(self->mem_ctx);
1767 self->ob_type->tp_free(self);
1770 PyTypeObject PyLdbMessageElement = {
1771 .tp_name = "MessageElement",
1772 .tp_basicsize = sizeof(PyLdbMessageElementObject),
1773 .tp_dealloc = (destructor)py_ldb_msg_element_dealloc,
1774 .tp_repr = (reprfunc)py_ldb_msg_element_repr,
1775 .tp_str = (reprfunc)py_ldb_msg_element_str,
1776 .tp_methods = py_ldb_msg_element_methods,
1777 .tp_compare = (cmpfunc)py_ldb_msg_element_cmp,
1778 .tp_iter = (getiterfunc)py_ldb_msg_element_iter,
1779 .tp_as_sequence = &py_ldb_msg_element_seq,
1780 .tp_new = py_ldb_msg_element_new,
1781 .tp_flags = Py_TPFLAGS_DEFAULT,
1784 static PyObject *py_ldb_msg_remove_attr(PyLdbMessageObject *self, PyObject *args)
1786 char *name;
1787 if (!PyArg_ParseTuple(args, "s", &name))
1788 return NULL;
1790 ldb_msg_remove_attr(self->msg, name);
1792 Py_RETURN_NONE;
1795 static PyObject *py_ldb_msg_keys(PyLdbMessageObject *self)
1797 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1798 int i, j = 0;
1799 PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
1800 if (msg->dn != NULL) {
1801 PyList_SetItem(obj, j, PyString_FromString("dn"));
1802 j++;
1804 for (i = 0; i < msg->num_elements; i++) {
1805 PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
1806 j++;
1808 return obj;
1811 static PyObject *py_ldb_msg_getitem_helper(PyLdbMessageObject *self, PyObject *py_name)
1813 struct ldb_message_element *el;
1814 char *name;
1815 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1816 if (!PyString_Check(py_name)) {
1817 PyErr_SetNone(PyExc_TypeError);
1818 return NULL;
1820 name = PyString_AsString(py_name);
1821 if (!strcmp(name, "dn"))
1822 return PyLdbDn_FromDn(msg->dn);
1823 el = ldb_msg_find_element(msg, name);
1824 if (el == NULL) {
1825 return NULL;
1827 return (PyObject *)PyLdbMessageElement_FromMessageElement(el, msg);
1830 static PyObject *py_ldb_msg_getitem(PyLdbMessageObject *self, PyObject *py_name)
1832 PyObject *ret = py_ldb_msg_getitem_helper(self, py_name);
1833 if (ret == NULL) {
1834 PyErr_SetString(PyExc_KeyError, "No such element");
1835 return NULL;
1837 return ret;
1840 static PyObject *py_ldb_msg_get(PyLdbMessageObject *self, PyObject *args)
1842 PyObject *name, *ret;
1843 if (!PyArg_ParseTuple(args, "O", &name))
1844 return NULL;
1846 ret = py_ldb_msg_getitem_helper(self, name);
1847 if (ret == NULL) {
1848 if (PyErr_Occurred())
1849 return NULL;
1850 Py_RETURN_NONE;
1852 return ret;
1855 static PyObject *py_ldb_msg_items(PyLdbMessageObject *self)
1857 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1858 int i, j;
1859 PyObject *l = PyList_New(msg->num_elements + (msg->dn == NULL?0:1));
1860 j = 0;
1861 if (msg->dn != NULL) {
1862 PyList_SetItem(l, 0, Py_BuildValue("(sO)", "dn", PyLdbDn_FromDn(msg->dn)));
1863 j++;
1865 for (i = 0; i < msg->num_elements; i++, j++) {
1866 PyList_SetItem(l, j, Py_BuildValue("(sO)", msg->elements[i].name, PyLdbMessageElement_FromMessageElement(&msg->elements[i], self->msg)));
1868 return l;
1871 static PyMethodDef py_ldb_msg_methods[] = {
1872 { "keys", (PyCFunction)py_ldb_msg_keys, METH_NOARGS, NULL },
1873 { "remove", (PyCFunction)py_ldb_msg_remove_attr, METH_VARARGS, NULL },
1874 { "get", (PyCFunction)py_ldb_msg_get, METH_VARARGS, NULL },
1875 { "items", (PyCFunction)py_ldb_msg_items, METH_NOARGS, NULL },
1876 { NULL },
1879 static PyObject *py_ldb_msg_iter(PyLdbMessageObject *self)
1881 PyObject *list, *iter;
1883 list = py_ldb_msg_keys(self);
1884 iter = PyObject_GetIter(list);
1885 Py_DECREF(list);
1886 return iter;
1889 static int py_ldb_msg_setitem(PyLdbMessageObject *self, PyObject *name, PyObject *value)
1891 char *attr_name;
1893 if (!PyString_Check(name)) {
1894 PyErr_SetNone(PyExc_TypeError);
1895 return -1;
1898 attr_name = PyString_AsString(name);
1899 if (value == NULL) {
1900 /* delitem */
1901 ldb_msg_remove_attr(self->msg, attr_name);
1902 } else {
1903 struct ldb_message_element *el = PyObject_AsMessageElement(self->msg,
1904 value, 0, attr_name);
1905 if (el == NULL)
1906 return -1;
1907 ldb_msg_remove_attr(PyLdbMessage_AsMessage(self), attr_name);
1908 ldb_msg_add(PyLdbMessage_AsMessage(self), el, el->flags);
1910 return 0;
1913 static Py_ssize_t py_ldb_msg_length(PyLdbMessageObject *self)
1915 return PyLdbMessage_AsMessage(self)->num_elements;
1918 static PyMappingMethods py_ldb_msg_mapping = {
1919 .mp_length = (lenfunc)py_ldb_msg_length,
1920 .mp_subscript = (binaryfunc)py_ldb_msg_getitem,
1921 .mp_ass_subscript = (objobjargproc)py_ldb_msg_setitem,
1924 static PyObject *py_ldb_msg_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
1926 const char * const kwnames[] = { "dn", NULL };
1927 struct ldb_message *ret;
1928 TALLOC_CTX *mem_ctx;
1929 PyObject *pydn = NULL;
1930 PyLdbMessageObject *py_ret;
1932 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|O",
1933 discard_const_p(char *, kwnames),
1934 &pydn))
1935 return NULL;
1937 mem_ctx = talloc_new(NULL);
1938 if (mem_ctx == NULL) {
1939 PyErr_NoMemory();
1940 return NULL;
1943 ret = ldb_msg_new(mem_ctx);
1944 if (ret == NULL) {
1945 talloc_free(mem_ctx);
1946 PyErr_NoMemory();
1947 return NULL;
1950 if (pydn != NULL) {
1951 struct ldb_dn *dn;
1952 if (!PyObject_AsDn(NULL, pydn, NULL, &dn)) {
1953 talloc_free(mem_ctx);
1954 return NULL;
1956 ret->dn = talloc_reference(ret, dn);
1959 py_ret = (PyLdbMessageObject *)type->tp_alloc(type, 0);
1960 if (py_ret == NULL) {
1961 PyErr_NoMemory();
1962 talloc_free(mem_ctx);
1963 return NULL;
1966 py_ret->mem_ctx = mem_ctx;
1967 py_ret->msg = ret;
1968 return (PyObject *)py_ret;
1971 PyObject *PyLdbMessage_FromMessage(struct ldb_message *msg)
1973 PyLdbMessageObject *ret;
1975 ret = (PyLdbMessageObject *)PyLdbMessage.tp_alloc(&PyLdbMessage, 0);
1976 if (ret == NULL) {
1977 PyErr_NoMemory();
1978 return NULL;
1980 ret->mem_ctx = talloc_new(NULL);
1981 ret->msg = talloc_reference(ret->mem_ctx, msg);
1982 return (PyObject *)ret;
1985 static PyObject *py_ldb_msg_get_dn(PyLdbMessageObject *self, void *closure)
1987 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1988 return PyLdbDn_FromDn(msg->dn);
1991 static int py_ldb_msg_set_dn(PyLdbMessageObject *self, PyObject *value, void *closure)
1993 struct ldb_message *msg = PyLdbMessage_AsMessage(self);
1994 if (!PyLdbDn_Check(value)) {
1995 PyErr_SetNone(PyExc_TypeError);
1996 return -1;
1999 msg->dn = talloc_reference(msg, PyLdbDn_AsDn(value));
2000 return 0;
2003 static PyGetSetDef py_ldb_msg_getset[] = {
2004 { discard_const_p(char, "dn"), (getter)py_ldb_msg_get_dn, (setter)py_ldb_msg_set_dn, NULL },
2005 { NULL }
2008 static PyObject *py_ldb_msg_repr(PyLdbMessageObject *self)
2010 PyObject *dict = PyDict_New(), *ret;
2011 if (PyDict_Update(dict, (PyObject *)self) != 0)
2012 return NULL;
2013 ret = PyString_FromFormat("Message(%s)", PyObject_REPR(dict));
2014 Py_DECREF(dict);
2015 return ret;
2018 static void py_ldb_msg_dealloc(PyLdbMessageObject *self)
2020 talloc_free(self->mem_ctx);
2021 self->ob_type->tp_free(self);
2024 PyTypeObject PyLdbMessage = {
2025 .tp_name = "Message",
2026 .tp_methods = py_ldb_msg_methods,
2027 .tp_getset = py_ldb_msg_getset,
2028 .tp_as_mapping = &py_ldb_msg_mapping,
2029 .tp_basicsize = sizeof(PyLdbMessageObject),
2030 .tp_dealloc = (destructor)py_ldb_msg_dealloc,
2031 .tp_new = py_ldb_msg_new,
2032 .tp_repr = (reprfunc)py_ldb_msg_repr,
2033 .tp_flags = Py_TPFLAGS_DEFAULT,
2034 .tp_iter = (getiterfunc)py_ldb_msg_iter,
2037 PyObject *PyLdbTree_FromTree(struct ldb_parse_tree *tree)
2039 PyLdbTreeObject *ret;
2041 ret = (PyLdbTreeObject *)PyLdbTree.tp_alloc(&PyLdbTree, 0);
2042 if (ret == NULL) {
2043 PyErr_NoMemory();
2044 return NULL;
2047 ret->mem_ctx = talloc_new(NULL);
2048 ret->tree = talloc_reference(ret->mem_ctx, tree);
2049 return (PyObject *)ret;
2052 static void py_ldb_tree_dealloc(PyLdbTreeObject *self)
2054 talloc_free(self->mem_ctx);
2055 self->ob_type->tp_free(self);
2058 PyTypeObject PyLdbTree = {
2059 .tp_name = "Tree",
2060 .tp_basicsize = sizeof(PyLdbTreeObject),
2061 .tp_dealloc = (destructor)py_ldb_tree_dealloc,
2062 .tp_flags = Py_TPFLAGS_DEFAULT,
2065 /* Ldb_module */
2066 static int py_module_search(struct ldb_module *mod, struct ldb_request *req)
2068 PyObject *py_ldb = (PyObject *)mod->private_data;
2069 PyObject *py_result, *py_base, *py_attrs, *py_tree;
2071 py_base = PyLdbDn_FromDn(req->op.search.base);
2073 if (py_base == NULL)
2074 return LDB_ERR_OPERATIONS_ERROR;
2076 py_tree = PyLdbTree_FromTree(req->op.search.tree);
2078 if (py_tree == NULL)
2079 return LDB_ERR_OPERATIONS_ERROR;
2081 if (req->op.search.attrs == NULL) {
2082 py_attrs = Py_None;
2083 } else {
2084 int i, len;
2085 for (len = 0; req->op.search.attrs[len]; len++);
2086 py_attrs = PyList_New(len);
2087 for (i = 0; i < len; i++)
2088 PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
2091 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "search"),
2092 discard_const_p(char, "OiOO"),
2093 py_base, req->op.search.scope, py_tree, py_attrs);
2095 Py_DECREF(py_attrs);
2096 Py_DECREF(py_tree);
2097 Py_DECREF(py_base);
2099 if (py_result == NULL) {
2100 return LDB_ERR_PYTHON_EXCEPTION;
2103 req->op.search.res = PyLdbResult_AsResult(NULL, py_result);
2104 if (req->op.search.res == NULL) {
2105 return LDB_ERR_PYTHON_EXCEPTION;
2108 Py_DECREF(py_result);
2110 return LDB_SUCCESS;
2113 static int py_module_add(struct ldb_module *mod, struct ldb_request *req)
2115 PyObject *py_ldb = (PyObject *)mod->private_data;
2116 PyObject *py_result, *py_msg;
2118 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.add.message));
2120 if (py_msg == NULL) {
2121 return LDB_ERR_OPERATIONS_ERROR;
2124 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "add"),
2125 discard_const_p(char, "O"),
2126 py_msg);
2128 Py_DECREF(py_msg);
2130 if (py_result == NULL) {
2131 return LDB_ERR_PYTHON_EXCEPTION;
2134 Py_DECREF(py_result);
2136 return LDB_SUCCESS;
2139 static int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
2141 PyObject *py_ldb = (PyObject *)mod->private_data;
2142 PyObject *py_result, *py_msg;
2144 py_msg = PyLdbMessage_FromMessage(discard_const_p(struct ldb_message, req->op.mod.message));
2146 if (py_msg == NULL) {
2147 return LDB_ERR_OPERATIONS_ERROR;
2150 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "modify"),
2151 discard_const_p(char, "O"),
2152 py_msg);
2154 Py_DECREF(py_msg);
2156 if (py_result == NULL) {
2157 return LDB_ERR_PYTHON_EXCEPTION;
2160 Py_DECREF(py_result);
2162 return LDB_SUCCESS;
2165 static int py_module_del(struct ldb_module *mod, struct ldb_request *req)
2167 PyObject *py_ldb = (PyObject *)mod->private_data;
2168 PyObject *py_result, *py_dn;
2170 py_dn = PyLdbDn_FromDn(req->op.del.dn);
2172 if (py_dn == NULL)
2173 return LDB_ERR_OPERATIONS_ERROR;
2175 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "delete"),
2176 discard_const_p(char, "O"),
2177 py_dn);
2179 if (py_result == NULL) {
2180 return LDB_ERR_PYTHON_EXCEPTION;
2183 Py_DECREF(py_result);
2185 return LDB_SUCCESS;
2188 static int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
2190 PyObject *py_ldb = (PyObject *)mod->private_data;
2191 PyObject *py_result, *py_olddn, *py_newdn;
2193 py_olddn = PyLdbDn_FromDn(req->op.rename.olddn);
2195 if (py_olddn == NULL)
2196 return LDB_ERR_OPERATIONS_ERROR;
2198 py_newdn = PyLdbDn_FromDn(req->op.rename.newdn);
2200 if (py_newdn == NULL)
2201 return LDB_ERR_OPERATIONS_ERROR;
2203 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "rename"),
2204 discard_const_p(char, "OO"),
2205 py_olddn, py_newdn);
2207 Py_DECREF(py_olddn);
2208 Py_DECREF(py_newdn);
2210 if (py_result == NULL) {
2211 return LDB_ERR_PYTHON_EXCEPTION;
2214 Py_DECREF(py_result);
2216 return LDB_SUCCESS;
2219 static int py_module_request(struct ldb_module *mod, struct ldb_request *req)
2221 PyObject *py_ldb = (PyObject *)mod->private_data;
2222 PyObject *py_result;
2224 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "request"),
2225 discard_const_p(char, ""));
2227 return LDB_ERR_OPERATIONS_ERROR;
2230 static int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
2232 PyObject *py_ldb = (PyObject *)mod->private_data;
2233 PyObject *py_result;
2235 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "extended"),
2236 discard_const_p(char, ""));
2238 return LDB_ERR_OPERATIONS_ERROR;
2241 static int py_module_start_transaction(struct ldb_module *mod)
2243 PyObject *py_ldb = (PyObject *)mod->private_data;
2244 PyObject *py_result;
2246 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "start_transaction"),
2247 discard_const_p(char, ""));
2249 if (py_result == NULL) {
2250 return LDB_ERR_PYTHON_EXCEPTION;
2253 Py_DECREF(py_result);
2255 return LDB_SUCCESS;
2258 static int py_module_end_transaction(struct ldb_module *mod)
2260 PyObject *py_ldb = (PyObject *)mod->private_data;
2261 PyObject *py_result;
2263 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "end_transaction"),
2264 discard_const_p(char, ""));
2266 if (py_result == NULL) {
2267 return LDB_ERR_PYTHON_EXCEPTION;
2270 Py_DECREF(py_result);
2272 return LDB_SUCCESS;
2275 static int py_module_del_transaction(struct ldb_module *mod)
2277 PyObject *py_ldb = (PyObject *)mod->private_data;
2278 PyObject *py_result;
2280 py_result = PyObject_CallMethod(py_ldb, discard_const_p(char, "del_transaction"),
2281 discard_const_p(char, ""));
2283 if (py_result == NULL) {
2284 return LDB_ERR_PYTHON_EXCEPTION;
2287 Py_DECREF(py_result);
2289 return LDB_SUCCESS;
2292 static int py_module_destructor(struct ldb_module *mod)
2294 Py_DECREF((PyObject *)mod->private_data);
2295 return 0;
2298 static int py_module_init(struct ldb_module *mod)
2300 PyObject *py_class = (PyObject *)mod->ops->private_data;
2301 PyObject *py_result, *py_next, *py_ldb;
2303 py_ldb = PyLdb_FromLdbContext(mod->ldb);
2305 if (py_ldb == NULL)
2306 return LDB_ERR_OPERATIONS_ERROR;
2308 py_next = PyLdbModule_FromModule(mod->next);
2310 if (py_next == NULL)
2311 return LDB_ERR_OPERATIONS_ERROR;
2313 py_result = PyObject_CallFunction(py_class, discard_const_p(char, "OO"),
2314 py_ldb, py_next);
2316 if (py_result == NULL) {
2317 return LDB_ERR_PYTHON_EXCEPTION;
2320 mod->private_data = py_result;
2322 talloc_set_destructor(mod, py_module_destructor);
2324 return ldb_next_init(mod);
2327 static PyObject *py_register_module(PyObject *module, PyObject *args)
2329 int ret;
2330 struct ldb_module_ops *ops;
2331 PyObject *input;
2333 if (!PyArg_ParseTuple(args, "O", &input))
2334 return NULL;
2336 ops = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
2337 if (ops == NULL) {
2338 PyErr_NoMemory();
2339 return NULL;
2342 ops->name = talloc_strdup(ops, PyString_AsString(PyObject_GetAttrString(input, discard_const_p(char, "name"))));
2344 Py_INCREF(input);
2345 ops->private_data = input;
2346 ops->init_context = py_module_init;
2347 ops->search = py_module_search;
2348 ops->add = py_module_add;
2349 ops->modify = py_module_modify;
2350 ops->del = py_module_del;
2351 ops->rename = py_module_rename;
2352 ops->request = py_module_request;
2353 ops->extended = py_module_extended;
2354 ops->start_transaction = py_module_start_transaction;
2355 ops->end_transaction = py_module_end_transaction;
2356 ops->del_transaction = py_module_del_transaction;
2358 ret = ldb_register_module(ops);
2360 PyErr_LDB_ERROR_IS_ERR_RAISE(PyExc_LdbError, ret, NULL);
2362 Py_RETURN_NONE;
2365 static PyObject *py_timestring(PyObject *module, PyObject *args)
2367 time_t t;
2368 char *tresult;
2369 PyObject *ret;
2370 if (!PyArg_ParseTuple(args, "L", &t))
2371 return NULL;
2372 tresult = ldb_timestring(NULL, t);
2373 ret = PyString_FromString(tresult);
2374 talloc_free(tresult);
2375 return ret;
2378 static PyObject *py_string_to_time(PyObject *module, PyObject *args)
2380 char *str;
2381 if (!PyArg_ParseTuple(args, "s", &str))
2382 return NULL;
2384 return PyInt_FromLong(ldb_string_to_time(str));
2387 static PyObject *py_valid_attr_name(PyObject *self, PyObject *args)
2389 char *name;
2390 if (!PyArg_ParseTuple(args, "s", &name))
2391 return NULL;
2392 return PyBool_FromLong(ldb_valid_attr_name(name));
2395 static PyMethodDef py_ldb_global_methods[] = {
2396 { "register_module", py_register_module, METH_VARARGS,
2397 "S.register_module(module) -> None\n"
2398 "Register a LDB module."},
2399 { "timestring", py_timestring, METH_VARARGS,
2400 "S.timestring(int) -> string\n"
2401 "Generate a LDAP time string from a UNIX timestamp" },
2402 { "string_to_time", py_string_to_time, METH_VARARGS,
2403 "S.string_to_time(string) -> int\n"
2404 "Parse a LDAP time string into a UNIX timestamp." },
2405 { "valid_attr_name", py_valid_attr_name, METH_VARARGS,
2406 "S.valid_attr_name(name) -> bool\n"
2407 "Check whether the supplied name is a valid attribute name." },
2408 { "open", (PyCFunction)py_ldb_new, METH_VARARGS|METH_KEYWORDS,
2409 NULL },
2410 { NULL }
2413 void initldb(void)
2415 PyObject *m;
2417 if (PyType_Ready(&PyLdbDn) < 0)
2418 return;
2420 if (PyType_Ready(&PyLdbMessage) < 0)
2421 return;
2423 if (PyType_Ready(&PyLdbMessageElement) < 0)
2424 return;
2426 if (PyType_Ready(&PyLdb) < 0)
2427 return;
2429 if (PyType_Ready(&PyLdbModule) < 0)
2430 return;
2432 if (PyType_Ready(&PyLdbTree) < 0)
2433 return;
2435 m = Py_InitModule3("ldb", py_ldb_global_methods,
2436 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server.");
2437 if (m == NULL)
2438 return;
2440 PyModule_AddObject(m, "SCOPE_DEFAULT", PyInt_FromLong(LDB_SCOPE_DEFAULT));
2441 PyModule_AddObject(m, "SCOPE_BASE", PyInt_FromLong(LDB_SCOPE_BASE));
2442 PyModule_AddObject(m, "SCOPE_ONELEVEL", PyInt_FromLong(LDB_SCOPE_ONELEVEL));
2443 PyModule_AddObject(m, "SCOPE_SUBTREE", PyInt_FromLong(LDB_SCOPE_SUBTREE));
2445 PyModule_AddObject(m, "CHANGETYPE_NONE", PyInt_FromLong(LDB_CHANGETYPE_NONE));
2446 PyModule_AddObject(m, "CHANGETYPE_ADD", PyInt_FromLong(LDB_CHANGETYPE_ADD));
2447 PyModule_AddObject(m, "CHANGETYPE_DELETE", PyInt_FromLong(LDB_CHANGETYPE_DELETE));
2448 PyModule_AddObject(m, "CHANGETYPE_MODIFY", PyInt_FromLong(LDB_CHANGETYPE_MODIFY));
2450 PyModule_AddObject(m, "FLAG_MOD_ADD", PyInt_FromLong(LDB_FLAG_MOD_ADD));
2451 PyModule_AddObject(m, "FLAG_MOD_REPLACE", PyInt_FromLong(LDB_FLAG_MOD_REPLACE));
2452 PyModule_AddObject(m, "FLAG_MOD_DELETE", PyInt_FromLong(LDB_FLAG_MOD_DELETE));
2454 PyModule_AddObject(m, "SUCCESS", PyInt_FromLong(LDB_SUCCESS));
2455 PyModule_AddObject(m, "ERR_OPERATIONS_ERROR", PyInt_FromLong(LDB_ERR_OPERATIONS_ERROR));
2456 PyModule_AddObject(m, "ERR_PROTOCOL_ERROR", PyInt_FromLong(LDB_ERR_PROTOCOL_ERROR));
2457 PyModule_AddObject(m, "ERR_TIME_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_TIME_LIMIT_EXCEEDED));
2458 PyModule_AddObject(m, "ERR_SIZE_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_SIZE_LIMIT_EXCEEDED));
2459 PyModule_AddObject(m, "ERR_COMPARE_FALSE", PyInt_FromLong(LDB_ERR_COMPARE_FALSE));
2460 PyModule_AddObject(m, "ERR_COMPARE_TRUE", PyInt_FromLong(LDB_ERR_COMPARE_TRUE));
2461 PyModule_AddObject(m, "ERR_AUTH_METHOD_NOT_SUPPORTED", PyInt_FromLong(LDB_ERR_AUTH_METHOD_NOT_SUPPORTED));
2462 PyModule_AddObject(m, "ERR_STRONG_AUTH_REQUIRED", PyInt_FromLong(LDB_ERR_STRONG_AUTH_REQUIRED));
2463 PyModule_AddObject(m, "ERR_REFERRAL", PyInt_FromLong(LDB_ERR_REFERRAL));
2464 PyModule_AddObject(m, "ERR_ADMIN_LIMIT_EXCEEDED", PyInt_FromLong(LDB_ERR_ADMIN_LIMIT_EXCEEDED));
2465 PyModule_AddObject(m, "ERR_UNSUPPORTED_CRITICAL_EXTENSION", PyInt_FromLong(LDB_ERR_UNSUPPORTED_CRITICAL_EXTENSION));
2466 PyModule_AddObject(m, "ERR_CONFIDENTIALITY_REQUIRED", PyInt_FromLong(LDB_ERR_CONFIDENTIALITY_REQUIRED));
2467 PyModule_AddObject(m, "ERR_SASL_BIND_IN_PROGRESS", PyInt_FromLong(LDB_ERR_SASL_BIND_IN_PROGRESS));
2468 PyModule_AddObject(m, "ERR_NO_SUCH_ATTRIBUTE", PyInt_FromLong(LDB_ERR_NO_SUCH_ATTRIBUTE));
2469 PyModule_AddObject(m, "ERR_UNDEFINED_ATTRIBUTE_TYPE", PyInt_FromLong(LDB_ERR_UNDEFINED_ATTRIBUTE_TYPE));
2470 PyModule_AddObject(m, "ERR_INAPPROPRIATE_MATCHING", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_MATCHING));
2471 PyModule_AddObject(m, "ERR_CONSTRAINT_VIOLATION", PyInt_FromLong(LDB_ERR_CONSTRAINT_VIOLATION));
2472 PyModule_AddObject(m, "ERR_ATTRIBUTE_OR_VALUE_EXISTS", PyInt_FromLong(LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS));
2473 PyModule_AddObject(m, "ERR_INVALID_ATTRIBUTE_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_ATTRIBUTE_SYNTAX));
2474 PyModule_AddObject(m, "ERR_NO_SUCH_OBJECT", PyInt_FromLong(LDB_ERR_NO_SUCH_OBJECT));
2475 PyModule_AddObject(m, "ERR_ALIAS_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_PROBLEM));
2476 PyModule_AddObject(m, "ERR_INVALID_DN_SYNTAX", PyInt_FromLong(LDB_ERR_INVALID_DN_SYNTAX));
2477 PyModule_AddObject(m, "ERR_ALIAS_DEREFERINCING_PROBLEM", PyInt_FromLong(LDB_ERR_ALIAS_DEREFERENCING_PROBLEM));
2478 PyModule_AddObject(m, "ERR_INAPPROPRIATE_AUTHENTICATION", PyInt_FromLong(LDB_ERR_INAPPROPRIATE_AUTHENTICATION));
2479 PyModule_AddObject(m, "ERR_INVALID_CREDENTIALS", PyInt_FromLong(LDB_ERR_INVALID_CREDENTIALS));
2480 PyModule_AddObject(m, "ERR_INSUFFICIENT_ACCESS_RIGHTS", PyInt_FromLong(LDB_ERR_INSUFFICIENT_ACCESS_RIGHTS));
2481 PyModule_AddObject(m, "ERR_BUSY", PyInt_FromLong(LDB_ERR_BUSY));
2482 PyModule_AddObject(m, "ERR_UNAVAILABLE", PyInt_FromLong(LDB_ERR_UNAVAILABLE));
2483 PyModule_AddObject(m, "ERR_UNWILLING_TO_PERFORM", PyInt_FromLong(LDB_ERR_UNWILLING_TO_PERFORM));
2484 PyModule_AddObject(m, "ERR_LOOP_DETECT", PyInt_FromLong(LDB_ERR_LOOP_DETECT));
2485 PyModule_AddObject(m, "ERR_NAMING_VIOLATION", PyInt_FromLong(LDB_ERR_NAMING_VIOLATION));
2486 PyModule_AddObject(m, "ERR_OBJECT_CLASS_VIOLATION", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_VIOLATION));
2487 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_NON_LEAF", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_NON_LEAF));
2488 PyModule_AddObject(m, "ERR_NOT_ALLOWED_ON_RDN", PyInt_FromLong(LDB_ERR_NOT_ALLOWED_ON_RDN));
2489 PyModule_AddObject(m, "ERR_ENTRY_ALREADY_EXISTS", PyInt_FromLong(LDB_ERR_ENTRY_ALREADY_EXISTS));
2490 PyModule_AddObject(m, "ERR_OBJECT_CLASS_MODS_PROHIBITED", PyInt_FromLong(LDB_ERR_OBJECT_CLASS_MODS_PROHIBITED));
2491 PyModule_AddObject(m, "ERR_AFFECTS_MULTIPLE_DSAS", PyInt_FromLong(LDB_ERR_AFFECTS_MULTIPLE_DSAS));
2492 PyModule_AddObject(m, "ERR_OTHER", PyInt_FromLong(LDB_ERR_OTHER));
2494 PyModule_AddObject(m, "FLG_RDONLY", PyInt_FromLong(LDB_FLG_RDONLY));
2495 PyModule_AddObject(m, "FLG_NOSYNC", PyInt_FromLong(LDB_FLG_NOSYNC));
2496 PyModule_AddObject(m, "FLG_RECONNECT", PyInt_FromLong(LDB_FLG_RECONNECT));
2497 PyModule_AddObject(m, "FLG_NOMMAP", PyInt_FromLong(LDB_FLG_NOMMAP));
2500 PyModule_AddObject(m, "__docformat__", PyString_FromString("restructuredText"));
2502 PyExc_LdbError = PyErr_NewException(discard_const_p(char, "_ldb.LdbError"), NULL, NULL);
2503 PyModule_AddObject(m, "LdbError", PyExc_LdbError);
2505 Py_INCREF(&PyLdb);
2506 Py_INCREF(&PyLdbDn);
2507 Py_INCREF(&PyLdbModule);
2508 Py_INCREF(&PyLdbMessage);
2509 Py_INCREF(&PyLdbMessageElement);
2510 Py_INCREF(&PyLdbTree);
2512 PyModule_AddObject(m, "Ldb", (PyObject *)&PyLdb);
2513 PyModule_AddObject(m, "Dn", (PyObject *)&PyLdbDn);
2514 PyModule_AddObject(m, "Message", (PyObject *)&PyLdbMessage);
2515 PyModule_AddObject(m, "MessageElement", (PyObject *)&PyLdbMessageElement);
2516 PyModule_AddObject(m, "Module", (PyObject *)&PyLdbModule);
2517 PyModule_AddObject(m, "Tree", (PyObject *)&PyLdbTree);