2 Unix SMB/CIFS implementation.
6 Copyright (C) 2005,2006 Tim Potter <tpot@samba.org>
7 Copyright (C) 2006 Simo Sorce <idra@samba.org>
8 Copyright (C) 2007-2008 Jelmer Vernooij <jelmer@samba.org>
10 ** NOTE! The following LGPL license applies to the ldb
11 ** library. This does NOT imply that all of Samba is released
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
36 #include "ldb_errors.h"
37 #include "ldb_private.h"
39 typedef struct ldb_message ldb_msg;
40 typedef struct ldb_context ldb;
41 typedef struct ldb_dn ldb_dn;
42 typedef struct ldb_ldif ldb_ldif;
43 typedef struct ldb_message_element ldb_msg_element;
44 typedef int ldb_error;
50 %include "exception.i"
53 /* Don't expose talloc contexts in Python code. Python does reference
54 counting for us, so just create a new top-level talloc context.
56 %typemap(in, numinputs=0, noblock=1) TALLOC_CTX * {
62 %constant int SCOPE_DEFAULT = LDB_SCOPE_DEFAULT;
63 %constant int SCOPE_BASE = LDB_SCOPE_BASE;
64 %constant int SCOPE_ONELEVEL = LDB_SCOPE_ONELEVEL;
65 %constant int SCOPE_SUBTREE = LDB_SCOPE_SUBTREE;
67 %constant int CHANGETYPE_NONE = LDB_CHANGETYPE_NONE;
68 %constant int CHANGETYPE_ADD = LDB_CHANGETYPE_ADD;
69 %constant int CHANGETYPE_DELETE = LDB_CHANGETYPE_DELETE;
70 %constant int CHANGETYPE_MODIFY = LDB_CHANGETYPE_MODIFY;
73 * Wrap struct ldb_context
76 /* The ldb functions will crash if a NULL ldb context is passed so
77 catch this before it happens. */
79 %typemap(check,noblock=1) struct ldb_context* {
81 SWIG_exception(SWIG_ValueError,
82 "ldb context must be non-NULL");
85 %typemap(check,noblock=1) ldb_msg * {
87 SWIG_exception(SWIG_ValueError,
88 "Message can not be None");
95 %typemap(in,noblock=1) struct ldb_val *INPUT (struct ldb_val temp) {
97 if (!PyString_Check($input)) {
98 PyErr_SetString(PyExc_TypeError, "string arg expected");
101 $1->length = PyString_Size($input);
102 $1->data = PyString_AsString($input);
106 PyObject *ldb_val_to_py_object(struct ldb_context *ldb_ctx,
107 struct ldb_message_element *el,
110 const struct ldb_schema_attribute *a;
111 struct ldb_val new_val;
112 TALLOC_CTX *mem_ctx = talloc_new(NULL);
117 if (ldb_ctx != NULL) {
118 a = ldb_schema_attribute_by_name(ldb_ctx, el->name);
121 if (a->syntax->ldif_write_fn(ldb_ctx, mem_ctx, val, &new_val) != 0) {
122 talloc_free(mem_ctx);
128 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
130 talloc_free(mem_ctx);
137 %typemap(out,noblock=1) struct ldb_val * {
138 $result = PyString_FromStringAndSize((const char *)$1->data, $1->length)
141 %typemap(out,noblock=1) struct ldb_val {
142 $result = PyString_FromStringAndSize((const char *)$1.data, $1.length)
146 * Wrap struct ldb_result
149 %typemap(in,noblock=1,numinputs=0) struct ldb_result **OUT (struct ldb_result *temp_ldb_result) {
150 $1 = &temp_ldb_result;
154 %typemap(argout,noblock=1) struct ldb_result ** (int i) {
155 $result = PyList_New((*$1)->count);
156 for (i = 0; i < (*$1)->count; i++) {
157 PyList_SetItem($result, i,
158 SWIG_NewPointerObj((*$1)->msgs[i], SWIGTYPE_p_ldb_message, 0)
163 %typemap(in,noblock=1,numinputs=1) const char * const *NULL_STR_LIST {
164 if ($input == Py_None) {
166 } else if (PySequence_Check($input)) {
168 $1 = talloc_array(NULL, char *, PySequence_Size($input)+1);
169 for(i = 0; i < PySequence_Size($input); i++)
170 $1[i] = PyString_AsString(PySequence_GetItem($input, i));
173 SWIG_exception(SWIG_TypeError, "expected sequence");
177 %typemap(freearg,noblock=1) const char * const *NULL_STR_LIST {
181 %apply const char * const *NULL_STR_LIST { const char * const *attrs }
182 %apply const char * const *NULL_STR_LIST { const char * const *control_strings }
186 %types(struct ldb_result *);
192 %rename(__str__) ldb_dn::get_linearized;
193 %rename(__cmp__) ldb_dn::compare;
194 %rename(__len__) ldb_dn::get_comp_num;
196 typedef struct ldb_dn {
198 ldb_dn(ldb *ldb_ctx, const char *str)
200 ldb_dn *ret = ldb_dn_new(ldb_ctx, ldb_ctx, str);
201 /* ldb_dn_new() doesn't accept NULL as memory context, so
202 we do it this way... */
203 talloc_steal(NULL, ret);
206 SWIG_exception(SWIG_ValueError,
207 "unable to parse dn string");
211 ~ldb_dn() { talloc_free($self); }
213 const char *get_casefold();
214 const char *get_linearized();
215 ldb_dn *parent() { return ldb_dn_get_parent(NULL, $self); }
216 int compare(ldb_dn *other);
220 bool check_special(const char *name);
222 bool add_child(ldb_dn *child);
223 bool add_base(ldb_dn *base);
224 const char *canonical_str() {
225 return ldb_dn_canonical_string($self, $self);
227 const char *canonical_ex_str() {
228 return ldb_dn_canonical_ex_string($self, $self);
231 ldb_dn *__add__(ldb_dn *other)
233 ldb_dn *ret = ldb_dn_copy(NULL, $self);
234 ldb_dn_add_child(ret, other);
238 /* FIXME: implement __getslice__ */
241 def __eq__(self, other):
242 if isinstance(other, self.__class__):
243 return self.__cmp__(other) == 0
244 if isinstance(other, str):
245 return str(self) == other
253 int ldb_dn_from_pyobject(TALLOC_CTX *mem_ctx, PyObject *object,
254 struct ldb_context *ldb_ctx, ldb_dn **dn)
258 if (ldb_ctx != NULL && PyString_Check(object)) {
259 *dn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
262 ret = SWIG_ConvertPtr(object, (void **)&odn, SWIGTYPE_p_ldb_dn,
263 SWIG_POINTER_EXCEPTION);
264 *dn = ldb_dn_copy(mem_ctx, odn);
268 ldb_msg_element *ldb_msg_element_from_pyobject(TALLOC_CTX *mem_ctx,
269 PyObject *set_obj, int flags,
270 const char *attr_name)
272 struct ldb_message_element *me = talloc(mem_ctx, struct ldb_message_element);
273 me->name = attr_name;
275 if (PyString_Check(set_obj)) {
277 me->values = talloc_array(me, struct ldb_val, me->num_values);
278 me->values[0].length = PyString_Size(set_obj);
279 me->values[0].data = (uint8_t *)talloc_strdup(me->values,
280 PyString_AsString(set_obj));
281 } else if (PySequence_Check(set_obj)) {
283 me->num_values = PySequence_Size(set_obj);
284 me->values = talloc_array(me, struct ldb_val, me->num_values);
285 for (i = 0; i < me->num_values; i++) {
286 PyObject *obj = PySequence_GetItem(set_obj, i);
287 me->values[i].length = PyString_Size(obj);
288 me->values[i].data = (uint8_t *)PyString_AsString(obj);
298 PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
304 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
305 result = PyList_New(me->num_values);
307 for (i = 0; i < me->num_values; i++) {
308 PyList_SetItem(result, i,
309 ldb_val_to_py_object(ldb_ctx, me, &me->values[i]));
318 /* ldb_message_element */
319 %rename(__cmp__) ldb_message_element::compare;
320 %rename(MessageElement) ldb_msg_element;
321 typedef struct ldb_message_element {
324 PyObject *__iter__(void)
326 return PyObject_GetIter(ldb_msg_element_to_set(NULL, $self));
329 PyObject *__set__(void)
331 return ldb_msg_element_to_set(NULL, $self);
334 ldb_msg_element(PyObject *set_obj, int flags=0, const char *name = NULL)
336 return ldb_msg_element_from_pyobject(NULL, set_obj, flags, name);
341 return $self->num_values;
347 if (i < 0 || i >= $self->num_values)
350 return ldb_val_to_py_object(NULL, $self, &$self->values[i]);
353 ~ldb_msg_element() { talloc_free($self); }
354 int compare(ldb_msg_element *);
357 def __getitem__(self, i):
360 raise KeyError("no such value")
363 def __eq__(self, other):
364 if (len(self) == 1 and self.get(0) == other):
366 if isinstance(other, self.__class__):
367 return self.__cmp__(other) == 0
369 for i in range(len(self)):
370 if self.get(i) != o.next():
378 %rename(Message) ldb_message;
380 %rename(__delitem__) ldb_message::remove_attr;
381 %typemap(out) ldb_msg_element * {
383 PyErr_SetString(PyExc_KeyError, "no such element");
385 $result = SWIG_NewPointerObj($1, SWIGTYPE_p_ldb_message_element, 0);
387 %rename(__getitem__) ldb_message::find_element;
388 //%typemap(out) ldb_msg_element *;
392 PyObject *ldb_msg_list_elements(ldb_msg *msg)
395 PyObject *obj = PyList_New(msg->num_elements);
396 for (i = 0; i < msg->num_elements; i++)
397 PyList_SetItem(obj, i, PyString_FromString(msg->elements[i].name));
404 typedef struct ldb_message {
408 ldb_msg(ldb_dn *dn = NULL) {
409 ldb_msg *ret = ldb_msg_new(NULL);
410 ret->dn = talloc_reference(ret, dn);
413 ~ldb_msg() { talloc_free($self); }
414 ldb_msg_element *find_element(const char *name);
417 void __setitem__(const char *attr_name, ldb_msg_element *val)
419 struct ldb_message_element *el;
421 ldb_msg_remove_attr($self, attr_name);
423 el = talloc($self, struct ldb_message_element);
424 el->name = talloc_strdup(el, attr_name);
425 el->num_values = val->num_values;
426 el->values = talloc_reference(el, val->values);
428 ldb_msg_add($self, el, val->flags);
431 void __setitem__(const char *attr_name, PyObject *val)
433 struct ldb_message_element *el = ldb_msg_element_from_pyobject(NULL,
435 talloc_steal($self, el);
436 ldb_msg_remove_attr($self, attr_name);
437 ldb_msg_add($self, el, el->flags);
440 unsigned int __len__() { return $self->num_elements; }
444 return ldb_msg_list_elements($self);
447 PyObject *__iter__(void)
449 return PyObject_GetIter(ldb_msg_list_elements($self));
452 void remove_attr(const char *name);
456 /* FIXME: Convert ldb_result to 3-tuple:
457 (msgs, refs, controls)
460 typedef struct ldb_ldif ldb_ldif;
464 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
467 PyObject *fn = context;
469 vasprintf(&text, fmt, ap);
470 PyObject_CallFunction(fn, (char *)"(i,s)", level, text);
475 %typemap(in,numinputs=1,noblock=1) (void (*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap), void *context) {
477 /* FIXME: Should be decreased somewhere as well. Perhaps register a
478 destructor and tie it to the ldb context ? */
485 static PyObject *ldb_ldif_to_pyobject(ldb_ldif *ldif)
490 return Py_BuildValue((char *)"(iO)", ldif->changetype,
491 SWIG_NewPointerObj(ldif->msg, SWIGTYPE_p_ldb_message, 0));
501 PyObject *PyExc_LdbError;
505 LdbError = _ldb.LdbError
509 PyExc_LdbError = PyErr_NewException((char *)"_ldb.LdbError", NULL, NULL);
510 PyDict_SetItemString(d, "LdbError", PyExc_LdbError);
513 %ignore _LDB_ERRORS_H_;
515 %include "include/ldb_errors.h"
522 %typemap(out,noblock=1) ldb_error {
523 if ($1 != LDB_SUCCESS) {
524 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_strerror($1)));
530 %typemap(out,noblock=1) struct ldb_control ** {
532 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(s)", ldb_errstring(arg1)));
535 $result = SWIG_NewPointerObj($1, $1_descriptor, 0);
538 %rename(Ldb) ldb_context;
540 %typemap(in,noblock=1) struct ldb_dn * {
541 if (ldb_dn_from_pyobject(NULL, $input, arg1, &$1) != 0) {
546 %typemap(freearg,noblock=1) struct ldb_dn * {
550 %typemap(in,numinputs=1) ldb_msg *add_msg {
551 int dict_pos, msg_pos;
552 PyObject *key, *value;
553 ldb_msg_element *msgel;
555 if (PyDict_Check($input)) {
556 $1 = ldb_msg_new(NULL);
557 $1->elements = talloc_zero_array($1, struct ldb_message_element, PyDict_Size($input));
558 msg_pos = dict_pos = 0;
559 while (PyDict_Next($input, &dict_pos, &key, &value)) {
560 if (!strcmp(PyString_AsString(key), "dn")) {
561 /* using argp0 (magic SWIG value) here is a hack */
562 if (ldb_dn_from_pyobject($1, value, argp1, &$1->dn) != 0) {
563 SWIG_exception(SWIG_TypeError, "unable to import dn object");
566 msgel = ldb_msg_element_from_pyobject($1->elements, value, 0, PyString_AsString(key));
568 SWIG_exception(SWIG_TypeError, "unable to import element");
570 memcpy(&$1->elements[msg_pos], msgel, sizeof(*msgel));
575 if ($1->dn == NULL) {
576 SWIG_exception(SWIG_TypeError, "no dn set");
579 $1->num_elements = msg_pos;
581 if (SWIG_ConvertPtr($input, (void **)&$1, SWIGTYPE_p_ldb_message, 0) != 0) {
582 SWIG_exception(SWIG_TypeError, "unable to convert ldb message");
587 /* Top-level ldb operations */
588 typedef struct ldb_context {
590 ldb(void) { return ldb_init(NULL); }
592 ldb_error connect(const char *url, unsigned int flags = 0,
593 const char *options[] = NULL);
595 ~ldb() { talloc_free($self); }
596 ldb_error search_ex(TALLOC_CTX *mem_ctx,
598 enum ldb_scope scope = LDB_SCOPE_DEFAULT,
599 const char *expression = NULL,
600 const char *const *attrs = NULL,
601 struct ldb_control **controls = NULL,
602 struct ldb_result **OUT) {
604 struct ldb_result *res;
605 struct ldb_request *req;
606 res = talloc_zero(mem_ctx, struct ldb_result);
608 return LDB_ERR_OPERATIONS_ERROR;
611 ret = ldb_build_search_req(&req, $self, mem_ctx,
612 base?base:ldb_get_default_basedn($self),
618 ldb_search_default_callback);
620 if (ret != LDB_SUCCESS) {
625 ldb_set_timeout($self, req, 0); /* use default timeout */
627 ret = ldb_request($self, req);
629 if (ret == LDB_SUCCESS) {
630 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
639 ldb_error delete(ldb_dn *dn);
640 ldb_error rename(ldb_dn *olddn, ldb_dn *newdn);
641 struct ldb_control **parse_control_strings(TALLOC_CTX *mem_ctx,
642 const char * const*control_strings);
643 ldb_error add(ldb_msg *add_msg);
644 ldb_error modify(ldb_msg *message);
645 ldb_dn *get_config_basedn();
646 ldb_dn *get_root_basedn();
647 ldb_dn *get_schema_basedn();
648 ldb_dn *get_default_basedn();
649 PyObject *schema_format_value(const char *element_name, PyObject *val)
651 const struct ldb_schema_attribute *a;
652 struct ldb_val old_val;
653 struct ldb_val new_val;
654 TALLOC_CTX *mem_ctx = talloc_new(NULL);
657 old_val.data = PyString_AsString(val);
658 old_val.length = PyString_Size(val);
660 a = ldb_schema_attribute_by_name($self, element_name);
666 if (a->syntax->ldif_write_fn($self, mem_ctx, &old_val, &new_val) != 0) {
667 talloc_free(mem_ctx);
671 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
673 talloc_free(mem_ctx);
678 const char *errstring();
679 void set_create_perms(unsigned int perms);
680 void set_modules_dir(const char *path);
681 ldb_error set_debug(void (*debug)(void *context, enum ldb_debug_level level,
682 const char *fmt, va_list ap),
684 ldb_error set_opaque(const char *name, void *value);
685 void *get_opaque(const char *name);
686 ldb_error transaction_start();
687 ldb_error transaction_commit();
688 ldb_error transaction_cancel();
689 void schema_attribute_remove(const char *name);
690 ldb_error schema_attribute_add(const char *attribute, unsigned flags, const char *syntax);
691 ldb_error setup_wellknown_attributes(void);
694 %typemap(in,numinputs=0,noblock=1) struct ldb_result **result_as_bool (struct ldb_result *tmp) { $1 = &tmp; }
695 %typemap(argout,noblock=1) struct ldb_result **result_as_bool { $result = ((*$1)->count > 0)?Py_True:Py_False; }
696 %typemap(freearg,noblock=1) struct ldb_result **result_as_bool { talloc_free(*$1); }
697 ldb_error __contains__(ldb_dn *dn, struct ldb_result **result_as_bool)
699 return ldb_search($self, dn, LDB_SCOPE_BASE, NULL, NULL,
703 PyObject *parse_ldif(const char *s)
705 PyObject *list = PyList_New(0);
706 struct ldb_ldif *ldif;
707 while ((ldif = ldb_ldif_read_string($self, &s)) != NULL) {
708 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
710 return PyObject_GetIter(list);
716 def __init__(self, url=None, flags=0, options=None):
717 _ldb.Ldb_swiginit(self,_ldb.new_Ldb())
719 self.connect(url, flags, options)
721 def search(self, base=None, scope=SCOPE_DEFAULT, expression=None,
722 attrs=None, controls=None):
723 parsed_controls = None
724 if controls is not None:
725 parsed_controls = self.parse_control_strings(controls)
726 return self.search_ex(base, scope, expression, attrs,
732 %typemap(in,noblock=1) struct ldb_dn *;
733 %typemap(freearg,noblock=1) struct ldb_dn *;
735 %nodefault ldb_message;
736 %nodefault ldb_context;
739 %rename(valid_attr_name) ldb_valid_attr_name;
740 int ldb_valid_attr_name(const char *s);
742 typedef unsigned long time_t;
745 static char *timestring(time_t t)
747 char *tresult = ldb_timestring(NULL, t);
748 char *result = strdup(tresult);
749 talloc_free(tresult);
754 %rename(string_to_time) ldb_string_to_time;
755 time_t ldb_string_to_time(const char *s);
757 %typemap(in,noblock=1) const struct ldb_module_ops * {
758 $1 = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
760 $1->name = (char *)PyObject_GetAttrString($input, (char *)"name");
763 %rename(register_module) ldb_register_module;
764 ldb_error ldb_register_module(const struct ldb_module_ops *);