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;
45 typedef int ldb_int_error;
51 %include "exception.i"
54 /* Don't expose talloc contexts in Python code. Python does reference
55 counting for us, so just create a new top-level talloc context.
57 %typemap(in, numinputs=0, noblock=1) TALLOC_CTX * {
63 %constant int SCOPE_DEFAULT = LDB_SCOPE_DEFAULT;
64 %constant int SCOPE_BASE = LDB_SCOPE_BASE;
65 %constant int SCOPE_ONELEVEL = LDB_SCOPE_ONELEVEL;
66 %constant int SCOPE_SUBTREE = LDB_SCOPE_SUBTREE;
68 %constant int CHANGETYPE_NONE = LDB_CHANGETYPE_NONE;
69 %constant int CHANGETYPE_ADD = LDB_CHANGETYPE_ADD;
70 %constant int CHANGETYPE_DELETE = LDB_CHANGETYPE_DELETE;
71 %constant int CHANGETYPE_MODIFY = LDB_CHANGETYPE_MODIFY;
74 * Wrap struct ldb_context
77 /* The ldb functions will crash if a NULL ldb context is passed so
78 catch this before it happens. */
80 %typemap(check,noblock=1) struct ldb_context* {
82 SWIG_exception(SWIG_ValueError,
83 "ldb context must be non-NULL");
86 %typemap(check,noblock=1) ldb_msg * {
88 SWIG_exception(SWIG_ValueError,
89 "Message can not be None");
96 %typemap(in,noblock=1) struct ldb_val *INPUT (struct ldb_val temp) {
98 if (!PyString_Check($input)) {
99 PyErr_SetString(PyExc_TypeError, "string arg expected");
102 $1->length = PyString_Size($input);
103 $1->data = PyString_AsString($input);
107 PyObject *ldb_val_to_py_object(struct ldb_context *ldb_ctx,
108 struct ldb_message_element *el,
111 const struct ldb_schema_attribute *a;
112 struct ldb_val new_val;
113 TALLOC_CTX *mem_ctx = talloc_new(NULL);
118 if (ldb_ctx != NULL) {
119 a = ldb_schema_attribute_by_name(ldb_ctx, el->name);
122 if (a->syntax->ldif_write_fn(ldb_ctx, mem_ctx, val, &new_val) != 0) {
123 talloc_free(mem_ctx);
129 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
131 talloc_free(mem_ctx);
138 %typemap(out,noblock=1) struct ldb_val * {
139 $result = PyString_FromStringAndSize((const char *)$1->data, $1->length)
142 %typemap(out,noblock=1) struct ldb_val {
143 $result = PyString_FromStringAndSize((const char *)$1.data, $1.length)
147 * Wrap struct ldb_result
150 %typemap(in,noblock=1,numinputs=0) struct ldb_result **OUT (struct ldb_result *temp_ldb_result) {
151 $1 = &temp_ldb_result;
155 %typemap(argout,noblock=1) struct ldb_result ** (int i) {
156 $result = PyList_New((*$1)->count);
157 for (i = 0; i < (*$1)->count; i++) {
158 PyList_SetItem($result, i,
159 SWIG_NewPointerObj((*$1)->msgs[i], SWIGTYPE_p_ldb_message, 0)
164 %typemap(in,noblock=1,numinputs=1) const char * const *NULL_STR_LIST {
165 if ($input == Py_None) {
167 } else if (PySequence_Check($input)) {
169 $1 = talloc_array(NULL, char *, PySequence_Size($input)+1);
170 for(i = 0; i < PySequence_Size($input); i++)
171 $1[i] = PyString_AsString(PySequence_GetItem($input, i));
174 SWIG_exception(SWIG_TypeError, "expected sequence");
178 %typemap(freearg,noblock=1) const char * const *NULL_STR_LIST {
182 %apply const char * const *NULL_STR_LIST { const char * const *attrs }
183 %apply const char * const *NULL_STR_LIST { const char * const *control_strings }
187 %types(struct ldb_result *);
193 %rename(__str__) ldb_dn::get_linearized;
194 %rename(__cmp__) ldb_dn::compare;
195 %rename(__len__) ldb_dn::get_comp_num;
197 typedef struct ldb_dn {
199 ldb_dn(ldb *ldb_ctx, const char *str)
201 ldb_dn *ret = ldb_dn_new(ldb_ctx, ldb_ctx, str);
202 /* ldb_dn_new() doesn't accept NULL as memory context, so
203 we do it this way... */
204 talloc_steal(NULL, ret);
207 SWIG_exception(SWIG_ValueError,
208 "unable to parse dn string");
212 ~ldb_dn() { talloc_free($self); }
214 const char *get_casefold();
215 const char *get_linearized();
216 ldb_dn *parent() { return ldb_dn_get_parent(NULL, $self); }
217 int compare(ldb_dn *other);
221 bool check_special(const char *name);
223 bool add_child(ldb_dn *child);
224 bool add_base(ldb_dn *base);
225 const char *canonical_str() {
226 return ldb_dn_canonical_string($self, $self);
228 const char *canonical_ex_str() {
229 return ldb_dn_canonical_ex_string($self, $self);
232 ldb_dn *__add__(ldb_dn *other)
234 ldb_dn *ret = ldb_dn_copy(NULL, $self);
235 ldb_dn_add_child(ret, other);
239 /* FIXME: implement __getslice__ */
242 def __eq__(self, other):
243 if isinstance(other, self.__class__):
244 return self.__cmp__(other) == 0
245 if isinstance(other, str):
246 return str(self) == other
254 int ldb_dn_from_pyobject(TALLOC_CTX *mem_ctx, PyObject *object,
255 struct ldb_context *ldb_ctx, ldb_dn **dn)
259 if (ldb_ctx != NULL && PyString_Check(object)) {
260 odn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
267 ret = SWIG_ConvertPtr(object, (void **)&odn, SWIGTYPE_p_ldb_dn,
268 SWIG_POINTER_EXCEPTION);
269 *dn = ldb_dn_copy(mem_ctx, odn);
276 ldb_msg_element *ldb_msg_element_from_pyobject(TALLOC_CTX *mem_ctx,
277 PyObject *set_obj, int flags,
278 const char *attr_name)
280 struct ldb_message_element *me = talloc(mem_ctx, struct ldb_message_element);
281 me->name = attr_name;
283 if (PyString_Check(set_obj)) {
285 me->values = talloc_array(me, struct ldb_val, me->num_values);
286 me->values[0].length = PyString_Size(set_obj);
287 me->values[0].data = (uint8_t *)talloc_strdup(me->values,
288 PyString_AsString(set_obj));
289 } else if (PySequence_Check(set_obj)) {
291 me->num_values = PySequence_Size(set_obj);
292 me->values = talloc_array(me, struct ldb_val, me->num_values);
293 for (i = 0; i < me->num_values; i++) {
294 PyObject *obj = PySequence_GetItem(set_obj, i);
295 me->values[i].length = PyString_Size(obj);
296 me->values[i].data = (uint8_t *)PyString_AsString(obj);
306 PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx,
312 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
313 result = PyList_New(me->num_values);
315 for (i = 0; i < me->num_values; i++) {
316 PyList_SetItem(result, i,
317 ldb_val_to_py_object(ldb_ctx, me, &me->values[i]));
326 /* ldb_message_element */
327 %rename(__cmp__) ldb_message_element::compare;
328 %rename(MessageElement) ldb_msg_element;
329 typedef struct ldb_message_element {
332 PyObject *__iter__(void)
334 return PyObject_GetIter(ldb_msg_element_to_set(NULL, $self));
337 PyObject *__set__(void)
339 return ldb_msg_element_to_set(NULL, $self);
342 ldb_msg_element(PyObject *set_obj, int flags=0, const char *name = NULL)
344 return ldb_msg_element_from_pyobject(NULL, set_obj, flags, name);
349 return $self->num_values;
355 if (i < 0 || i >= $self->num_values)
358 return ldb_val_to_py_object(NULL, $self, &$self->values[i]);
361 ~ldb_msg_element() { talloc_free($self); }
362 int compare(ldb_msg_element *);
365 def __getitem__(self, i):
368 raise KeyError("no such value")
371 def __eq__(self, other):
372 if (len(self) == 1 and self.get(0) == other):
374 if isinstance(other, self.__class__):
375 return self.__cmp__(other) == 0
377 for i in range(len(self)):
378 if self.get(i) != o.next():
386 %rename(Message) ldb_message;
388 %rename(__delitem__) ldb_message::remove_attr;
389 %typemap(out) ldb_msg_element * {
391 PyErr_SetString(PyExc_KeyError, "no such element");
393 $result = SWIG_NewPointerObj($1, SWIGTYPE_p_ldb_message_element, 0);
395 %rename(__getitem__) ldb_message::find_element;
396 //%typemap(out) ldb_msg_element *;
400 PyObject *ldb_msg_list_elements(ldb_msg *msg)
403 PyObject *obj = PyList_New(msg->num_elements);
404 for (i = 0; i < msg->num_elements; i++)
405 PyList_SetItem(obj, i, PyString_FromString(msg->elements[i].name));
412 typedef struct ldb_message {
416 ldb_msg(ldb_dn *dn = NULL) {
417 ldb_msg *ret = ldb_msg_new(NULL);
418 ret->dn = talloc_reference(ret, dn);
421 ~ldb_msg() { talloc_free($self); }
422 ldb_msg_element *find_element(const char *name);
425 void __setitem__(const char *attr_name, ldb_msg_element *val)
427 struct ldb_message_element *el;
429 ldb_msg_remove_attr($self, attr_name);
431 el = talloc($self, struct ldb_message_element);
432 el->name = talloc_strdup(el, attr_name);
433 el->num_values = val->num_values;
434 el->values = talloc_reference(el, val->values);
436 ldb_msg_add($self, el, val->flags);
439 void __setitem__(const char *attr_name, PyObject *val)
441 struct ldb_message_element *el = ldb_msg_element_from_pyobject(NULL,
443 talloc_steal($self, el);
444 ldb_msg_remove_attr($self, attr_name);
445 ldb_msg_add($self, el, el->flags);
448 unsigned int __len__() { return $self->num_elements; }
452 return ldb_msg_list_elements($self);
455 PyObject *__iter__(void)
457 return PyObject_GetIter(ldb_msg_list_elements($self));
460 void remove_attr(const char *name);
464 /* FIXME: Convert ldb_result to 3-tuple:
465 (msgs, refs, controls)
468 typedef struct ldb_ldif ldb_ldif;
472 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
474 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
477 PyObject *fn = context;
479 vasprintf(&text, fmt, ap);
480 PyObject_CallFunction(fn, (char *)"(i,s)", level, text);
485 %typemap(in,numinputs=1,noblock=1) (void (*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap), void *context) {
487 /* FIXME: Should be decreased somewhere as well. Perhaps register a
488 destructor and tie it to the ldb context ? */
495 static PyObject *ldb_ldif_to_pyobject(ldb_ldif *ldif)
500 return Py_BuildValue((char *)"(iO)", ldif->changetype,
501 SWIG_NewPointerObj(ldif->msg, SWIGTYPE_p_ldb_message, 0));
511 PyObject *PyExc_LdbError;
515 LdbError = _ldb.LdbError
519 PyExc_LdbError = PyErr_NewException((char *)"_ldb.LdbError", NULL, NULL);
520 PyDict_SetItemString(d, "LdbError", PyExc_LdbError);
523 %ignore _LDB_ERRORS_H_;
525 %include "include/ldb_errors.h"
532 %typemap(out,noblock=1) ldb_error {
533 if ($1 != LDB_SUCCESS) {
534 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_errstring(arg1)));
540 %typemap(out,noblock=1) ldb_int_error {
541 if ($1 != LDB_SUCCESS) {
542 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_strerror($1)));
548 %typemap(out,noblock=1) struct ldb_control ** {
550 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(s)", ldb_errstring(arg1)));
553 $result = SWIG_NewPointerObj($1, $1_descriptor, 0);
556 %rename(Ldb) ldb_context;
558 %typemap(in,noblock=1) struct ldb_dn * {
559 if (ldb_dn_from_pyobject(NULL, $input, arg1, &$1) != 0) {
564 %typemap(freearg,noblock=1) struct ldb_dn * {
568 %typemap(in,numinputs=1) ldb_msg *add_msg {
569 Py_ssize_t dict_pos, msg_pos;
570 ldb_msg_element *msgel;
571 PyObject *key, *value;
573 if (PyDict_Check($input)) {
574 PyObject *dn_value = PyDict_GetItemString($input, "dn");
575 $1 = ldb_msg_new(NULL);
576 $1->elements = talloc_zero_array($1, struct ldb_message_element, PyDict_Size($input));
577 msg_pos = dict_pos = 0;
579 /* using argp1 (magic SWIG value) here is a hack */
580 if (ldb_dn_from_pyobject($1, dn_value, argp1, &$1->dn) != 0) {
581 SWIG_exception(SWIG_TypeError, "unable to import dn object");
583 if ($1->dn == NULL) {
584 SWIG_exception(SWIG_TypeError, "dn set but not found");
588 while (PyDict_Next($input, &dict_pos, &key, &value)) {
589 char *key_str = PyString_AsString(key);
590 if (strcmp(key_str, "dn") != 0) {
591 msgel = ldb_msg_element_from_pyobject($1->elements, value, 0, key_str);
593 SWIG_exception(SWIG_TypeError, "unable to import element");
595 memcpy(&$1->elements[msg_pos], msgel, sizeof(*msgel));
600 if ($1->dn == NULL) {
601 SWIG_exception(SWIG_TypeError, "no dn set");
604 $1->num_elements = msg_pos;
606 if (SWIG_ConvertPtr($input, (void **)&$1, SWIGTYPE_p_ldb_message, 0) != 0) {
607 SWIG_exception(SWIG_TypeError, "unable to convert ldb message");
612 /* Top-level ldb operations */
613 typedef struct ldb_context {
615 ldb(void) { return ldb_init(NULL); }
617 ldb_error connect(const char *url, unsigned int flags = 0,
618 const char *options[] = NULL);
620 ~ldb() { talloc_free($self); }
621 ldb_error search_ex(TALLOC_CTX *mem_ctx,
623 enum ldb_scope scope = LDB_SCOPE_DEFAULT,
624 const char *expression = NULL,
625 const char *const *attrs = NULL,
626 struct ldb_control **controls = NULL,
627 struct ldb_result **OUT) {
629 struct ldb_result *res;
630 struct ldb_request *req;
631 res = talloc_zero(mem_ctx, struct ldb_result);
633 return LDB_ERR_OPERATIONS_ERROR;
636 ret = ldb_build_search_req(&req, $self, mem_ctx,
637 base?base:ldb_get_default_basedn($self),
643 ldb_search_default_callback);
645 if (ret != LDB_SUCCESS) {
650 ldb_set_timeout($self, req, 0); /* use default timeout */
652 ret = ldb_request($self, req);
654 if (ret == LDB_SUCCESS) {
655 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
664 ldb_error delete(ldb_dn *dn);
665 ldb_error rename(ldb_dn *olddn, ldb_dn *newdn);
666 struct ldb_control **parse_control_strings(TALLOC_CTX *mem_ctx,
667 const char * const*control_strings);
668 ldb_error add(ldb_msg *add_msg);
669 ldb_error modify(ldb_msg *message);
670 ldb_dn *get_config_basedn();
671 ldb_dn *get_root_basedn();
672 ldb_dn *get_schema_basedn();
673 ldb_dn *get_default_basedn();
674 PyObject *schema_format_value(const char *element_name, PyObject *val)
676 const struct ldb_schema_attribute *a;
677 struct ldb_val old_val;
678 struct ldb_val new_val;
679 TALLOC_CTX *mem_ctx = talloc_new(NULL);
682 old_val.data = PyString_AsString(val);
683 old_val.length = PyString_Size(val);
685 a = ldb_schema_attribute_by_name($self, element_name);
691 if (a->syntax->ldif_write_fn($self, mem_ctx, &old_val, &new_val) != 0) {
692 talloc_free(mem_ctx);
696 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
698 talloc_free(mem_ctx);
703 const char *errstring();
704 void set_create_perms(unsigned int perms);
705 void set_modules_dir(const char *path);
706 ldb_error set_debug(void (*debug)(void *context, enum ldb_debug_level level,
707 const char *fmt, va_list ap),
709 ldb_error set_opaque(const char *name, void *value);
710 void *get_opaque(const char *name);
711 ldb_error transaction_start();
712 ldb_error transaction_commit();
713 ldb_error transaction_cancel();
714 void schema_attribute_remove(const char *name);
715 ldb_error schema_attribute_add(const char *attribute, unsigned flags, const char *syntax);
716 ldb_error setup_wellknown_attributes(void);
719 %typemap(in,numinputs=0,noblock=1) struct ldb_result **result_as_bool (struct ldb_result *tmp) { $1 = &tmp; }
720 %typemap(argout,noblock=1) struct ldb_result **result_as_bool { $result = ((*$1)->count > 0)?Py_True:Py_False; }
721 %typemap(freearg,noblock=1) struct ldb_result **result_as_bool { talloc_free(*$1); }
722 ldb_error __contains__(ldb_dn *dn, struct ldb_result **result_as_bool)
724 return ldb_search($self, dn, LDB_SCOPE_BASE, NULL, NULL,
728 PyObject *parse_ldif(const char *s)
730 PyObject *list = PyList_New(0);
731 struct ldb_ldif *ldif;
732 while ((ldif = ldb_ldif_read_string($self, &s)) != NULL) {
733 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
735 return PyObject_GetIter(list);
741 def __init__(self, url=None, flags=0, options=None):
742 _ldb.Ldb_swiginit(self,_ldb.new_Ldb())
744 self.connect(url, flags, options)
746 def search(self, base=None, scope=SCOPE_DEFAULT, expression=None,
747 attrs=None, controls=None):
748 parsed_controls = None
749 if controls is not None:
750 parsed_controls = self.parse_control_strings(controls)
751 return self.search_ex(base, scope, expression, attrs,
757 %typemap(in,noblock=1) struct ldb_dn *;
758 %typemap(freearg,noblock=1) struct ldb_dn *;
760 %nodefault ldb_message;
761 %nodefault ldb_context;
764 %rename(valid_attr_name) ldb_valid_attr_name;
765 int ldb_valid_attr_name(const char *s);
767 typedef unsigned long time_t;
770 static char *timestring(time_t t)
772 char *tresult = ldb_timestring(NULL, t);
773 char *result = strdup(tresult);
774 talloc_free(tresult);
779 %rename(string_to_time) ldb_string_to_time;
780 time_t ldb_string_to_time(const char *s);
782 %typemap(in,noblock=1) const struct ldb_module_ops * {
783 $1 = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
785 $1->name = (char *)PyObject_GetAttrString($input, (char *)"name");
788 %rename(register_module) ldb_register_module;
789 ldb_int_error ldb_register_module(const struct ldb_module_ops *);