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 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);
105 %typemap(out,noblock=1) struct ldb_val {
106 $result = PyString_FromStringAndSize((const char *)$1.data, $1.length);
110 * Wrap struct ldb_result
113 %typemap(in,noblock=1,numinputs=0) struct ldb_result **OUT (struct ldb_result *temp_ldb_result) {
114 $1 = &temp_ldb_result;
118 %typemap(argout,noblock=1) struct ldb_result ** (int i) {
119 $result = PyList_New((*$1)->count);
120 for (i = 0; i < (*$1)->count; i++) {
121 PyList_SetItem($result, i,
122 SWIG_NewPointerObj((*$1)->msgs[i], SWIGTYPE_p_ldb_message, 0)
127 %typemap(in,noblock=1,numinputs=1) const char * const *NULL_STR_LIST {
128 if ($input == Py_None) {
130 } else if (PySequence_Check($input)) {
132 $1 = talloc_array(NULL, char *, PySequence_Size($input)+1);
133 for(i = 0; i < PySequence_Size($input); i++)
134 $1[i] = PyString_AsString(PySequence_GetItem($input, i));
137 SWIG_exception(SWIG_TypeError, "expected sequence");
141 %typemap(freearg,noblock=1) const char * const *NULL_STR_LIST {
145 %apply const char * const *NULL_STR_LIST { const char * const *attrs }
146 %apply const char * const *NULL_STR_LIST { const char * const *control_strings }
150 %types(struct ldb_result *);
156 %rename(__str__) ldb_dn::get_linearized;
157 %rename(__cmp__) ldb_dn::compare;
158 %rename(__len__) ldb_dn::get_comp_num;
160 typedef struct ldb_dn {
162 ldb_dn(ldb *ldb_ctx, const char *str)
164 ldb_dn *ret = ldb_dn_new(ldb_ctx, ldb_ctx, str);
165 /* ldb_dn_new() doesn't accept NULL as memory context, so
166 we do it this way... */
167 talloc_steal(NULL, ret);
170 SWIG_exception(SWIG_ValueError,
171 "unable to parse dn string");
175 ~ldb_dn() { talloc_free($self); }
177 const char *get_casefold();
178 const char *get_linearized();
179 ldb_dn *parent() { return ldb_dn_get_parent(NULL, $self); }
180 int compare(ldb_dn *other);
184 bool check_special(const char *name);
186 bool add_child(ldb_dn *child);
187 bool add_base(ldb_dn *base);
188 const char *canonical_str() {
189 return ldb_dn_canonical_string($self, $self);
191 const char *canonical_ex_str() {
192 return ldb_dn_canonical_ex_string($self, $self);
195 ldb_dn *__add__(ldb_dn *other)
197 ldb_dn *ret = ldb_dn_copy(NULL, $self);
198 ldb_dn_add_child(ret, other);
202 /* FIXME: implement __getslice__ */
205 def __eq__(self, other):
206 if isinstance(other, self.__class__):
207 return self.__cmp__(other) == 0
208 if isinstance(other, str):
209 return str(self) == other
217 int ldb_dn_from_pyobject(TALLOC_CTX *mem_ctx, PyObject *object,
218 struct ldb_context *ldb_ctx, ldb_dn **dn)
222 if (ldb_ctx != NULL && PyString_Check(object)) {
223 *dn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
226 ret = SWIG_ConvertPtr(object, (void **)&odn, SWIGTYPE_p_ldb_dn,
227 SWIG_POINTER_EXCEPTION);
228 *dn = ldb_dn_copy(mem_ctx, odn);
232 ldb_msg_element *ldb_msg_element_from_pyobject(TALLOC_CTX *mem_ctx,
233 PyObject *set_obj, int flags,
234 const char *attr_name)
236 struct ldb_message_element *me = talloc(mem_ctx, struct ldb_message_element);
237 me->name = attr_name;
239 if (PyString_Check(set_obj)) {
241 me->values = talloc_array(me, struct ldb_val, me->num_values);
242 me->values[0].length = PyString_Size(set_obj);
243 me->values[0].data = (uint8_t *)talloc_strdup(me->values,
244 PyString_AsString(set_obj));
245 } else if (PySequence_Check(set_obj)) {
247 me->num_values = PySequence_Size(set_obj);
248 me->values = talloc_array(me, struct ldb_val, me->num_values);
249 for (i = 0; i < me->num_values; i++) {
250 PyObject *obj = PySequence_GetItem(set_obj, i);
251 me->values[i].length = PyString_Size(obj);
252 me->values[i].data = (uint8_t *)PyString_AsString(obj);
262 PyObject *ldb_msg_element_to_set(ldb_msg_element *me)
267 /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
268 result = PyList_New(me->num_values);
270 for (i = 0; i < me->num_values; i++) {
271 PyList_SetItem(result, i,
272 PyString_FromStringAndSize((const char *)me->values[i].data,
273 me->values[i].length));
282 /* ldb_message_element */
283 %rename(__cmp__) ldb_message_element::compare;
284 %rename(MessageElement) ldb_msg_element;
285 typedef struct ldb_message_element {
288 PyObject *__iter__(void)
290 return PyObject_GetIter(ldb_msg_element_to_set($self));
293 PyObject *__set__(void)
295 return ldb_msg_element_to_set($self);
298 ldb_msg_element(PyObject *set_obj, int flags=0, const char *name = NULL)
300 return ldb_msg_element_from_pyobject(NULL, set_obj, flags, name);
305 return $self->num_values;
311 if (i < 0 || i >= $self->num_values)
314 return PyString_FromStringAndSize(
315 (const char *)$self->values[i].data,
316 $self->values[i].length);
319 ~ldb_msg_element() { talloc_free($self); }
320 int compare(ldb_msg_element *);
323 def __getitem__(self, i):
326 raise KeyError("no such value")
329 def __eq__(self, other):
330 if (len(self) == 1 and self.get(0) == other):
332 if isinstance(other, self.__class__):
333 return self.__cmp__(other) == 0
335 for i in range(len(self)):
336 if self.get(i) != o.next():
344 %rename(Message) ldb_message;
346 %rename(__delitem__) ldb_message::remove_attr;
347 %typemap(out) ldb_msg_element * {
349 PyErr_SetString(PyExc_KeyError, "no such element");
351 $result = SWIG_NewPointerObj($1, SWIGTYPE_p_ldb_message_element, 0);
353 %rename(__getitem__) ldb_message::find_element;
354 //%typemap(out) ldb_msg_element *;
358 PyObject *ldb_msg_list_elements(ldb_msg *msg)
361 PyObject *obj = PyList_New(msg->num_elements);
362 for (i = 0; i < msg->num_elements; i++)
363 PyList_SetItem(obj, i, PyString_FromString(msg->elements[i].name));
370 typedef struct ldb_message {
374 ldb_msg(ldb_dn *dn = NULL) {
375 ldb_msg *ret = ldb_msg_new(NULL);
376 ret->dn = talloc_reference(ret, dn);
379 ~ldb_msg() { talloc_free($self); }
380 ldb_msg_element *find_element(const char *name);
383 void __setitem__(const char *attr_name, ldb_msg_element *val)
385 struct ldb_message_element *el;
387 ldb_msg_remove_attr($self, attr_name);
389 el = talloc($self, struct ldb_message_element);
390 el->name = talloc_strdup(el, attr_name);
391 el->num_values = val->num_values;
392 el->values = talloc_reference(el, val->values);
394 ldb_msg_add($self, el, val->flags);
397 void __setitem__(const char *attr_name, PyObject *val)
399 struct ldb_message_element *el = ldb_msg_element_from_pyobject(NULL,
401 talloc_steal($self, el);
402 ldb_msg_remove_attr($self, attr_name);
403 ldb_msg_add($self, el, el->flags);
406 unsigned int __len__() { return $self->num_elements; }
410 return ldb_msg_list_elements($self);
413 PyObject *__iter__(void)
415 return PyObject_GetIter(ldb_msg_list_elements($self));
418 void remove_attr(const char *name);
422 /* FIXME: Convert ldb_result to 3-tuple:
423 (msgs, refs, controls)
426 typedef struct ldb_ldif ldb_ldif;
430 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
433 PyObject *fn = context;
435 vasprintf(&text, fmt, ap);
436 PyObject_CallFunction(fn, (char *)"(i,s)", level, text);
441 %typemap(in,numinputs=1,noblock=1) (void (*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap), void *context) {
443 /* FIXME: Should be decreased somewhere as well. Perhaps register a
444 destructor and tie it to the ldb context ? */
451 static PyObject *ldb_ldif_to_pyobject(ldb_ldif *ldif)
456 return Py_BuildValue((char *)"(iO)", ldif->changetype,
457 SWIG_NewPointerObj(ldif->msg, SWIGTYPE_p_ldb_message, 0));
467 PyObject *PyExc_LdbError;
471 LdbError = _ldb.LdbError
475 PyExc_LdbError = PyErr_NewException((char *)"_ldb.LdbError", NULL, NULL);
476 PyDict_SetItemString(d, "LdbError", PyExc_LdbError);
479 %ignore _LDB_ERRORS_H_;
481 %include "include/ldb_errors.h"
488 %typemap(out,noblock=1) ldb_error {
489 if ($1 != LDB_SUCCESS) {
490 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_strerror($1)));
496 %typemap(out,noblock=1) struct ldb_control ** {
498 PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(s)", ldb_errstring(arg1)));
501 $result = SWIG_NewPointerObj($1, $1_descriptor, 0);
504 %rename(Ldb) ldb_context;
506 %typemap(in,noblock=1) struct ldb_dn * {
507 if (ldb_dn_from_pyobject(NULL, $input, arg1, &$1) != 0) {
512 %typemap(freearg,noblock=1) struct ldb_dn * {
516 /* Top-level ldb operations */
517 typedef struct ldb_context {
519 ldb(void) { return ldb_init(NULL); }
521 ldb_error connect(const char *url, unsigned int flags = 0,
522 const char *options[] = NULL);
524 ~ldb() { talloc_free($self); }
525 ldb_error search_ex(TALLOC_CTX *mem_ctx,
527 enum ldb_scope scope = LDB_SCOPE_DEFAULT,
528 const char *expression = NULL,
529 const char *const *attrs = NULL,
530 struct ldb_control **controls = NULL,
531 struct ldb_result **OUT) {
533 struct ldb_result *res;
534 struct ldb_request *req;
535 res = talloc_zero(mem_ctx, struct ldb_result);
537 return LDB_ERR_OPERATIONS_ERROR;
540 ret = ldb_build_search_req(&req, $self, mem_ctx,
541 base?base:ldb_get_default_basedn($self),
547 ldb_search_default_callback);
549 if (ret != LDB_SUCCESS) {
554 ldb_set_timeout($self, req, 0); /* use default timeout */
556 ret = ldb_request($self, req);
558 if (ret == LDB_SUCCESS) {
559 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
568 ldb_error delete(ldb_dn *dn);
569 ldb_error rename(ldb_dn *olddn, ldb_dn *newdn);
570 struct ldb_control **parse_control_strings(TALLOC_CTX *mem_ctx,
571 const char * const*control_strings);
572 ldb_error add(ldb_msg *add_msg);
573 ldb_error add(PyObject *py_msg)
576 int dict_pos, msg_pos;
577 PyObject *key, *value;
578 ldb_msg_element *msgel;
581 if (PyDict_Check(py_msg)) {
582 msg = ldb_msg_new(NULL);
583 msg->elements = talloc_zero_array(msg, struct ldb_message_element, PyDict_Size(py_msg));
584 msg_pos = dict_pos = 0;
585 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
586 if (!strcmp(PyString_AsString(key), "dn")) {
587 if (ldb_dn_from_pyobject(msg, value, $self, &msg->dn) != 0) {
588 return LDB_ERR_OTHER;
591 msgel = ldb_msg_element_from_pyobject(msg->elements, value, 0, PyString_AsString(key));
593 SWIG_exception(SWIG_TypeError, "unable to import element");
594 return LDB_ERR_OTHER;
596 memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
601 if (msg->dn == NULL) {
602 SWIG_exception(SWIG_TypeError, "no dn set");
603 return LDB_ERR_OTHER;
606 msg->num_elements = msg_pos;
608 if (SWIG_ConvertPtr(py_msg, (void **)&msg, SWIGTYPE_p_ldb_message, 0) != 0)
609 return LDB_ERR_OTHER;
612 ret = ldb_add($self, msg);
618 return LDB_ERR_OTHER;
620 ldb_error modify(ldb_msg *message);
621 ldb_dn *get_config_basedn();
622 ldb_dn *get_root_basedn();
623 ldb_dn *get_schema_basedn();
624 ldb_dn *get_default_basedn();
625 const char *errstring();
626 void set_create_perms(unsigned int perms);
627 void set_modules_dir(const char *path);
628 ldb_error set_debug(void (*debug)(void *context, enum ldb_debug_level level,
629 const char *fmt, va_list ap),
631 ldb_error set_opaque(const char *name, void *value);
632 void *get_opaque(const char *name);
633 ldb_error transaction_start();
634 ldb_error transaction_commit();
635 ldb_error transaction_cancel();
638 %typemap(in,numinputs=0,noblock=1) struct ldb_result **result_as_bool (struct ldb_result *tmp) { $1 = &tmp; }
639 %typemap(argout,noblock=1) struct ldb_result **result_as_bool { $result = ((*$1)->count > 0)?Py_True:Py_False; }
640 %typemap(freearg,noblock=1) struct ldb_result **result_as_bool { talloc_free(*$1); }
641 ldb_error __contains__(ldb_dn *dn, struct ldb_result **result_as_bool)
643 return ldb_search($self, dn, LDB_SCOPE_BASE, NULL, NULL,
647 PyObject *parse_ldif(const char *s)
649 PyObject *list = PyList_New(0);
650 struct ldb_ldif *ldif;
651 while ((ldif = ldb_ldif_read_string($self, &s)) != NULL) {
652 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
654 return PyObject_GetIter(list);
660 def __init__(self, url=None, flags=0, options=None):
661 _ldb.Ldb_swiginit(self,_ldb.new_Ldb())
663 self.connect(url, flags, options)
665 def search(self, base=None, scope=SCOPE_DEFAULT, expression=None,
666 attrs=None, controls=None):
667 parsed_controls = None
668 if controls is not None:
669 parsed_controls = self.parse_control_strings(controls)
670 return self.search_ex(base, scope, expression, attrs,
676 %typemap(in,noblock=1) struct ldb_dn *;
677 %typemap(freearg,noblock=1) struct ldb_dn *;
679 %nodefault ldb_message;
680 %nodefault ldb_context;
683 %rename(valid_attr_name) ldb_valid_attr_name;
684 int ldb_valid_attr_name(const char *s);
686 typedef unsigned long time_t;
689 static char *timestring(time_t t)
691 char *tresult = ldb_timestring(NULL, t);
692 char *result = strdup(tresult);
693 talloc_free(tresult);
698 %rename(string_to_time) ldb_string_to_time;
699 time_t ldb_string_to_time(const char *s);
701 %typemap(in,noblock=1) const struct ldb_module_ops * {
702 $1 = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
704 $1->name = (char *)PyObject_GetAttrString($input, (char *)"name");
707 %rename(register_module) ldb_register_module;
708 ldb_error ldb_register_module(const struct ldb_module_ops *);