Merge branch 'master' of ssh://git.samba.org/data/git/samba
[samba.git] / source4 / lib / ldb / ldb.i
1 /*
2    Unix SMB/CIFS implementation.
3
4    Swig interface to ldb.
5
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>
9
10      ** NOTE! The following LGPL license applies to the ldb
11      ** library. This does NOT imply that all of Samba is released
12      ** under the LGPL
13    
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.
18
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.
23
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/>.
26 */
27
28 %define DOCSTRING
29 "An interface to LDB, a LDAP-like API that can either to talk an embedded database (TDB-based) or a standards-compliant LDAP server."
30 %enddef
31
32 %module(docstring=DOCSTRING) ldb
33
34 %{
35
36 #include <stdint.h>
37 #include <stdbool.h>
38 #include "talloc.h"
39 #include "events.h"
40 #include "ldb.h"
41 #include "ldb_errors.h"
42 #include "ldb_private.h"
43
44 typedef struct ldb_message ldb_msg;
45 typedef struct ldb_context ldb;
46 typedef struct ldb_dn ldb_dn;
47 typedef struct ldb_ldif ldb_ldif;
48 typedef struct ldb_message_element ldb_message_element;
49 typedef struct ldb_module ldb_module;
50 typedef int ldb_error;
51 typedef int ldb_int_error;
52
53 %}
54
55 %import "carrays.i"
56 %import "typemaps.i"
57 %include "exception.i"
58 %import "stdint.i"
59
60 /* Don't expose talloc contexts in Python code. Python does reference 
61    counting for us, so just create a new top-level talloc context.
62  */
63 %typemap(in, numinputs=0, noblock=1) TALLOC_CTX * {
64     $1 = NULL;
65 }
66
67
68
69 %constant int SCOPE_DEFAULT = LDB_SCOPE_DEFAULT;
70 %constant int SCOPE_BASE = LDB_SCOPE_BASE;
71 %constant int SCOPE_ONELEVEL = LDB_SCOPE_ONELEVEL;
72 %constant int SCOPE_SUBTREE = LDB_SCOPE_SUBTREE;
73
74 %constant int CHANGETYPE_NONE = LDB_CHANGETYPE_NONE;
75 %constant int CHANGETYPE_ADD = LDB_CHANGETYPE_ADD;
76 %constant int CHANGETYPE_DELETE = LDB_CHANGETYPE_DELETE;
77 %constant int CHANGETYPE_MODIFY = LDB_CHANGETYPE_MODIFY;
78
79 /* 
80  * Wrap struct ldb_context
81  */
82
83 /* The ldb functions will crash if a NULL ldb context is passed so
84    catch this before it happens. */
85
86 %typemap(check,noblock=1) struct ldb_context* {
87         if ($1 == NULL)
88                 SWIG_exception(SWIG_ValueError, 
89                         "ldb context must be non-NULL");
90 }
91
92 %typemap(check,noblock=1) ldb_msg * {
93         if ($1 == NULL)
94                 SWIG_exception(SWIG_ValueError, 
95                         "Message can not be None");
96 }
97
98 /*
99  * Wrap struct ldb_val
100  */
101
102 %typemap(in,noblock=1) struct ldb_val *INPUT (struct ldb_val temp) {
103         $1 = &temp;
104         if (!PyString_Check($input)) {
105                 PyErr_SetString(PyExc_TypeError, "string arg expected");
106                 return NULL;
107         }
108         $1->length = PyString_Size($input);
109         $1->data = PyString_AsString($input);
110 }
111
112 %inline %{
113 PyObject *ldb_val_to_py_object(struct ldb_context *ldb_ctx, 
114                                struct ldb_message_element *el, 
115                                struct ldb_val *val)
116 {
117         const struct ldb_schema_attribute *a;
118         struct ldb_val new_val;
119         TALLOC_CTX *mem_ctx = talloc_new(NULL);
120         PyObject *ret;
121         
122         new_val = *val;
123         
124         if (ldb_ctx != NULL) {        
125                 a = ldb_schema_attribute_by_name(ldb_ctx, el->name);
126         
127                 if (a != NULL) {
128                         if (a->syntax->ldif_write_fn(ldb_ctx, mem_ctx, val, &new_val) != 0) {
129                                 talloc_free(mem_ctx);
130                                 return NULL;
131                         }
132                 }
133         } 
134         
135         ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
136         
137         talloc_free(mem_ctx);
138         
139         return ret;
140 }
141
142 %}
143
144 %typemap(out,noblock=1) struct ldb_val * {
145         $result = PyString_FromStringAndSize((const char *)$1->data, $1->length)
146 }
147
148 %typemap(out,noblock=1) struct ldb_val {
149         $result = PyString_FromStringAndSize((const char *)$1.data, $1.length)
150 }
151
152 /*
153  * Wrap struct ldb_result
154  */
155
156 %typemap(in,noblock=1,numinputs=0) struct ldb_result ** (struct ldb_result *temp_ldb_result) {
157         $1 = &temp_ldb_result;
158 }
159
160 #ifdef SWIGPYTHON
161 %typemap(argout,noblock=1) struct ldb_result ** (int i) {
162     if ($1 == NULL) {
163         $result = Py_None;
164     } else {
165         $result = PyList_New((*$1)->count);
166         for (i = 0; i < (*$1)->count; i++) {
167             PyList_SetItem($result, i, 
168                 SWIG_NewPointerObj((*$1)->msgs[i], SWIGTYPE_p_ldb_message, 0)
169             );
170         }
171     }
172 }
173
174 %typemap(in,noblock=1,numinputs=1) const char * const *NULL_STR_LIST {
175     if ($input == Py_None) {
176         $1 = NULL;
177     } else if (PySequence_Check($input)) {
178         int i;
179         $1 = talloc_array(NULL, char *, PySequence_Size($input)+1);
180         for(i = 0; i < PySequence_Size($input); i++)
181             $1[i] = PyString_AsString(PySequence_GetItem($input, i));
182         $1[i] = NULL;
183     } else {
184         SWIG_exception(SWIG_TypeError, "expected sequence");
185     }
186 }
187
188 %typemap(freearg,noblock=1) const char * const *NULL_STR_LIST {
189     talloc_free($1);
190 }
191
192 %apply const char * const *NULL_STR_LIST { const char * const *attrs }
193 %apply const char * const *NULL_STR_LIST { const char * const *options }
194 %apply const char * const *NULL_STR_LIST { const char * const *control_strings }
195
196 #endif
197
198 %types(struct ldb_result *, struct ldb_parse_tree *);
199
200 /*
201  * Wrap struct ldb_dn
202  */
203
204 %rename(__str__) ldb_dn::get_linearized;
205 %rename(__cmp__) ldb_dn::compare;
206 %rename(__len__) ldb_dn::get_comp_num;
207 %rename(Dn) ldb_dn;
208 %feature("docstring") ldb_dn "A LDB distinguished name.";
209 typedef struct ldb_dn {
210     %extend {
211         %feature("docstring") ldb_dn "S.__init__(ldb, string)\n" \
212                  "Create a new DN.";
213         ldb_dn(ldb *ldb_ctx, const char *str)
214         {
215             ldb_dn *ret = ldb_dn_new(ldb_ctx, ldb_ctx, str);
216             /* ldb_dn_new() doesn't accept NULL as memory context, so 
217                we do it this way... */
218             talloc_steal(NULL, ret);
219
220             if (ret == NULL || !ldb_dn_validate(ret))
221                 SWIG_exception(SWIG_ValueError, 
222                                 "unable to parse dn string");
223 fail:
224             return ret;
225         }
226         ~ldb_dn() { talloc_free($self); }
227         %feature("docstring") validate "S.validate() -> bool\n" \
228                                        "Validate DN is correct.";
229         bool validate();
230         const char *get_casefold();
231         const char *get_linearized();
232         %feature("docstring") parent "S.parent() -> dn\n" \
233                                      "Get the parent for this DN.";
234         ldb_dn *parent() { return ldb_dn_get_parent(NULL, $self); }
235         int compare(ldb_dn *other);
236         bool is_valid();
237         %feature("docstring") is_special "S.is_special() -> bool\n" \
238                                          "Check whether this is a special LDB DN.";
239         bool is_special();
240         %feature("docstring") is_null "S.is_null() -> bool\n" \
241                                          "Check whether this is a null DN.";
242         bool is_null();
243         bool check_special(const char *name);
244         int get_comp_num();
245         %feature("docstring") add_child "S.add_child(dn) -> None\n" \
246                                          "Add a child DN to this DN.";
247         bool add_child(ldb_dn *child);
248         %feature("docstring") add_base "S.add_base(dn) -> None\n" \
249                                          "Add a base DN to this DN.";
250         bool add_base(ldb_dn *base);
251         %feature("docstring") canonical_str "S.canonical_str() -> string\n" \
252                                          "Canonical version of this DN (like a posix path).";
253         const char *canonical_str() {
254             return ldb_dn_canonical_string($self, $self);
255         }
256         %feature("docstring") canonical_ex_str "S.canonical_ex_str() -> string\n" \
257                                                "Canonical version of this DN (like a posix path, with terminating newline).";
258         const char *canonical_ex_str() {
259             return ldb_dn_canonical_ex_string($self, $self);
260         }
261 #ifdef SWIGPYTHON
262         char *__repr__(void)
263         {
264             char *dn = ldb_dn_get_linearized($self), *ret;
265             asprintf(&ret, "Dn('%s')", dn);
266             return ret;
267         }
268
269         ldb_dn *__add__(ldb_dn *other)
270         {
271             ldb_dn *ret = ldb_dn_copy(NULL, $self);
272             ldb_dn_add_child(ret, other);
273             return ret;
274         }
275
276         /* FIXME: implement __getslice__ */
277 #endif
278     %pythoncode {
279         def __eq__(self, other):
280             if isinstance(other, self.__class__):
281                 return self.__cmp__(other) == 0
282             if isinstance(other, str):
283                 return str(self) == other
284             return False
285     }
286     }
287 } ldb_dn;
288
289 #ifdef SWIGPYTHON
290 %{
291 struct ldb_context *ldb_context_from_py_object(PyObject *py_obj)
292 {
293         struct ldb_context *ldb_ctx;
294     if (SWIG_ConvertPtr(py_obj, (void *)&ldb_ctx, SWIGTYPE_p_ldb_context, 0 |  0 ) < 0)
295         return NULL;
296     return ldb_ctx;
297 }
298
299 int ldb_dn_from_pyobject(TALLOC_CTX *mem_ctx, PyObject *object, 
300                          struct ldb_context *ldb_ctx, ldb_dn **dn)
301 {
302     int ret;
303     struct ldb_dn *odn;
304     if (ldb_ctx != NULL && PyString_Check(object)) {
305         odn = ldb_dn_new(mem_ctx, ldb_ctx, PyString_AsString(object));
306         if (!odn) {
307                 return SWIG_ERROR;
308         }
309         *dn = odn;
310         return 0;
311     }
312     ret = SWIG_ConvertPtr(object, (void **)&odn, SWIGTYPE_p_ldb_dn, 
313                            SWIG_POINTER_EXCEPTION);
314     *dn = ldb_dn_copy(mem_ctx, odn);
315     if (odn && !*dn) {
316         return SWIG_ERROR;
317     }
318     return ret;
319 }
320
321 ldb_message_element *ldb_msg_element_from_pyobject(TALLOC_CTX *mem_ctx,
322                                                PyObject *set_obj, int flags,
323                                                const char *attr_name)
324 {
325     struct ldb_message_element *me = talloc(mem_ctx, struct ldb_message_element);
326     me->name = attr_name;
327     me->flags = flags;
328     if (PyString_Check(set_obj)) {
329         me->num_values = 1;
330         me->values = talloc_array(me, struct ldb_val, me->num_values);
331         me->values[0].length = PyString_Size(set_obj);
332         me->values[0].data = (uint8_t *)talloc_strdup(me->values, 
333                                            PyString_AsString(set_obj));
334     } else if (PySequence_Check(set_obj)) {
335         int i;
336         me->num_values = PySequence_Size(set_obj);
337         me->values = talloc_array(me, struct ldb_val, me->num_values);
338         for (i = 0; i < me->num_values; i++) {
339             PyObject *obj = PySequence_GetItem(set_obj, i);
340             me->values[i].length = PyString_Size(obj);
341             me->values[i].data = (uint8_t *)PyString_AsString(obj);
342         }
343     } else {
344         talloc_free(me);
345         me = NULL;
346     }
347
348     return me;
349 }
350
351 PyObject *ldb_msg_element_to_set(struct ldb_context *ldb_ctx, 
352                                  ldb_message_element *me)
353 {
354     int i;
355     PyObject *result;
356
357     /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
358     result = PyList_New(me->num_values);
359
360     for (i = 0; i < me->num_values; i++) {
361         PyList_SetItem(result, i,
362             ldb_val_to_py_object(ldb_ctx, me, &me->values[i]));
363     }
364
365     return result;
366 }
367
368 %}
369 #endif
370
371 /* ldb_message_element */
372 %rename(MessageElement) ldb_message_element;
373 %feature("docstring") ldb_message_element "Message element.";
374 typedef struct ldb_message_element {
375     %extend {
376 #ifdef SWIGPYTHON
377         int __cmp__(ldb_message_element *other)
378         {
379             return ldb_msg_element_compare($self, other);
380         }
381
382         PyObject *__iter__(void)
383         {
384             return PyObject_GetIter(ldb_msg_element_to_set(NULL, $self));
385         }
386
387         PyObject *__set__(void)
388         {
389             return ldb_msg_element_to_set(NULL, $self);
390         }
391
392         ldb_message_element(PyObject *set_obj, int flags=0, const char *name = NULL)
393         {
394             return ldb_msg_element_from_pyobject(NULL, set_obj, flags, name);
395         }
396
397         int __len__()
398         {
399             return $self->num_values;
400         }
401 #endif
402
403         PyObject *get(int i)
404         {
405             if (i < 0 || i >= $self->num_values)
406                 return Py_None;
407
408             return ldb_val_to_py_object(NULL, $self, &$self->values[i]);
409         }
410
411         ~ldb_message_element() { talloc_free($self); }
412     }
413     %pythoncode {
414         def __getitem__(self, i):
415             ret = self.get(i)
416             if ret is None:
417                 raise KeyError("no such value")
418             return ret
419
420         def __repr__(self):
421             return "MessageElement([%s])" % (",".join(repr(x) for x in self.__set__()))
422
423         def __eq__(self, other):
424             if (len(self) == 1 and self.get(0) == other):
425                 return True
426             if isinstance(other, self.__class__):
427                 return self.__cmp__(other) == 0
428             o = iter(other)
429             for i in range(len(self)):
430                 if self.get(i) != o.next():
431                     return False
432             return True
433     }
434 } ldb_message_element;
435
436 /* ldb_message */
437
438 %feature("docstring") ldb_message "Message.";
439 %rename(Message) ldb_message;
440 #ifdef SWIGPYTHON
441 %rename(__delitem__) ldb_message::remove_attr;
442 %typemap(out) ldb_message_element * {
443         if ($1 == NULL)
444                 PyErr_SetString(PyExc_KeyError, "no such element");
445     else
446         $result = SWIG_NewPointerObj($1, SWIGTYPE_p_ldb_message_element, 0);
447 }
448
449 %inline {
450     PyObject *ldb_msg_list_elements(ldb_msg *msg)
451     {
452         int i, j = 0;
453         PyObject *obj = PyList_New(msg->num_elements+(msg->dn != NULL?1:0));
454         if (msg->dn != NULL) {
455             PyList_SetItem(obj, j, PyString_FromString("dn"));
456             j++;
457         }
458         for (i = 0; i < msg->num_elements; i++) {
459             PyList_SetItem(obj, j, PyString_FromString(msg->elements[i].name));
460             j++;
461         }
462         return obj;
463     }
464 }
465
466 #endif
467
468 typedef struct ldb_message {
469         ldb_dn *dn;
470
471     %extend {
472         ldb_msg(ldb_dn *dn = NULL) { 
473             ldb_msg *ret = ldb_msg_new(NULL); 
474             ret->dn = talloc_reference(ret, dn);
475             return ret;
476         }
477         ~ldb_msg() { talloc_free($self); }
478         ldb_message_element *find_element(const char *name);
479         
480 #ifdef SWIGPYTHON
481         void __setitem__(const char *attr_name, ldb_message_element *val)
482         {
483             struct ldb_message_element *el;
484             
485             ldb_msg_remove_attr($self, attr_name);
486
487             el = talloc($self, struct ldb_message_element);
488             el->name = talloc_strdup(el, attr_name);
489             el->num_values = val->num_values;
490             el->values = talloc_reference(el, val->values);
491
492             ldb_msg_add($self, el, val->flags);
493         }
494
495         void __setitem__(const char *attr_name, PyObject *val)
496         {
497             struct ldb_message_element *el = ldb_msg_element_from_pyobject(NULL,
498                                                 val, 0, attr_name);
499             talloc_steal($self, el);
500             ldb_msg_remove_attr($self, attr_name);
501             ldb_msg_add($self, el, el->flags);
502         }
503
504         unsigned int __len__() { return $self->num_elements; }
505
506         PyObject *keys(void)
507         {
508             return ldb_msg_list_elements($self);
509         }
510
511         PyObject *__iter__(void)
512         {
513             return PyObject_GetIter(ldb_msg_list_elements($self));
514         }
515 #endif
516         void remove_attr(const char *name);
517 %pythoncode {
518     def get(self, key, default=None):
519         if key == "dn":
520             return self.dn
521         return self.find_element(key)
522
523     def __getitem__(self, key):
524         ret = self.get(key, None)
525         if ret is None:
526             raise KeyError("No such element")
527         return ret
528
529     def iteritems(self):
530         for k in self.keys():
531             yield k, self[k]
532     
533     def items(self):
534         return list(self.iteritems())
535
536     def __repr__(self):
537         return "Message(%s)" % repr(dict(self.iteritems()))
538 }
539     }
540 } ldb_msg;
541
542 /* FIXME: Convert ldb_result to 3-tuple:
543    (msgs, refs, controls)
544  */
545
546 typedef struct ldb_ldif ldb_ldif;
547
548 #ifdef SWIGPYTHON
549 %{
550 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3, 0);
551
552 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
553 {
554     char *text;
555     PyObject *fn = context;
556
557     vasprintf(&text, fmt, ap);
558     PyObject_CallFunction(fn, (char *)"(i,s)", level, text);
559     free(text);
560 }
561 %}
562
563 %typemap(in,numinputs=1,noblock=1) (void (*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap), void *context) {
564     $1 = py_ldb_debug;
565     /* FIXME: Should be decreased somewhere as well. Perhaps register a 
566        destructor and tie it to the ldb context ? */
567     Py_INCREF($input);
568     $2 = $input;
569 }
570 #endif
571
572 %inline {
573     static PyObject *ldb_ldif_to_pyobject(ldb_ldif *ldif)
574     {
575         if (ldif == NULL) {
576             return Py_None;
577         } else {
578             return Py_BuildValue((char *)"(iO)", ldif->changetype, 
579                    SWIG_NewPointerObj(ldif->msg, SWIGTYPE_p_ldb_message, 0));
580         }
581     }
582 }
583
584 /*
585  * Wrap ldb errors
586  */
587
588 %{
589 PyObject *PyExc_LdbError;
590 %}
591
592 %pythoncode %{
593     LdbError = _ldb.LdbError
594 %}
595
596 %init %{
597     PyExc_LdbError = PyErr_NewException((char *)"_ldb.LdbError", NULL, NULL);
598     PyDict_SetItemString(d, "LdbError", PyExc_LdbError);
599 %}
600
601 %ignore _LDB_ERRORS_H_;
602 %ignore LDB_SUCCESS;
603 %include "include/ldb_errors.h"
604
605 /*
606  * Wrap ldb functions 
607  */
608
609
610 %typemap(out,noblock=1) ldb_error {
611     if ($1 != LDB_SUCCESS) {
612         PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_errstring(arg1)));
613         SWIG_fail;
614     }
615     $result = Py_None;
616 };
617
618 %typemap(out,noblock=1) ldb_int_error {
619     if ($1 != LDB_SUCCESS) {
620         PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(i,s)", $1, ldb_strerror($1)));
621         SWIG_fail;
622     }
623     $result = Py_None;
624 };
625
626 %typemap(out,noblock=1) struct ldb_control ** {
627     if ($1 == NULL) {
628         PyErr_SetObject(PyExc_LdbError, Py_BuildValue((char *)"(s)", ldb_errstring(arg1)));
629         SWIG_fail;
630     }
631     $result = SWIG_NewPointerObj($1, $1_descriptor, 0);
632 }
633
634 %rename(Ldb) ldb_context;
635 %feature("docstring") ldb_context "Connection to a LDB database.";
636
637 %typemap(in,noblock=1) struct ldb_dn * {
638     if (ldb_dn_from_pyobject(NULL, $input, arg1, &$1) != 0) {
639         SWIG_fail;
640     }
641 };
642
643 %typemap(freearg,noblock=1) struct ldb_dn * {
644     talloc_free($1);
645 };
646
647 %typemap(in,numinputs=1) ldb_msg *add_msg {
648     Py_ssize_t dict_pos, msg_pos;
649     ldb_message_element *msgel;
650     PyObject *key, *value;
651
652     if (PyDict_Check($input)) {
653         PyObject *dn_value = PyDict_GetItemString($input, "dn");
654         $1 = ldb_msg_new(NULL);
655         $1->elements = talloc_zero_array($1, struct ldb_message_element, PyDict_Size($input));
656         msg_pos = dict_pos = 0;
657         if (dn_value) {
658                 /* using argp1 (magic SWIG value) here is a hack */
659                 if (ldb_dn_from_pyobject($1, dn_value, argp1, &$1->dn) != 0) {
660                     SWIG_exception(SWIG_TypeError, "unable to import dn object");
661                 }
662                 if ($1->dn == NULL) {
663                     SWIG_exception(SWIG_TypeError, "dn set but not found");
664                 }
665         }
666
667         while (PyDict_Next($input, &dict_pos, &key, &value)) {
668             char *key_str = PyString_AsString(key);
669             if (strcmp(key_str, "dn") != 0) {
670                 msgel = ldb_msg_element_from_pyobject($1->elements, value, 0, key_str);
671                 if (msgel == NULL) {
672                     SWIG_exception(SWIG_TypeError, "unable to import element");
673                 }
674                 memcpy(&$1->elements[msg_pos], msgel, sizeof(*msgel));
675                 msg_pos++;
676             }
677         }
678
679         if ($1->dn == NULL) {
680             SWIG_exception(SWIG_TypeError, "no dn set");
681         }
682
683         $1->num_elements = msg_pos;
684     } else {
685         if (SWIG_ConvertPtr($input, (void **)&$1, SWIGTYPE_p_ldb_message, 0) != 0) {
686             SWIG_exception(SWIG_TypeError, "unable to convert ldb message");
687         }
688     }
689 }
690
691 /* Top-level ldb operations */
692 typedef struct ldb_context {
693     %rename(firstmodule) modules;
694     struct ldb_module *modules;
695
696     %pythoncode {
697         def itermodules(self):
698             m = self.firstmodule
699             while m is not None:
700                 yield m
701                 m = m.next
702
703         def modules(self):
704             return list(self.itermodules())
705     }
706
707     %extend {
708         ldb(void) { 
709             return ldb_init(NULL, event_context_init(NULL)); 
710         }
711
712         %feature("docstring") connect "S.connect(url,flags=0,options=None) -> None\n" \
713                                       "Connect to a LDB URL.";
714         ldb_error connect(const char *url, unsigned int flags = 0, 
715             const char *const *options = NULL);
716
717         ~ldb() { talloc_free($self); }
718
719         ldb_error search_ex(TALLOC_CTX *mem_ctx,
720                    ldb_dn *base = NULL, 
721                    enum ldb_scope scope = LDB_SCOPE_DEFAULT, 
722                    const char *expression = NULL, 
723                    const char *const *attrs = NULL, 
724                    struct ldb_control **controls = NULL,
725                    struct ldb_result **OUT) {
726             int ret;
727             struct ldb_result *res;
728             struct ldb_request *req;
729             res = talloc_zero(mem_ctx, struct ldb_result);
730             if (!res) {
731                 return LDB_ERR_OPERATIONS_ERROR;
732             }
733
734             ret = ldb_build_search_req(&req, $self, mem_ctx,
735                            base?base:ldb_get_default_basedn($self),
736                            scope,
737                            expression,
738                            attrs,
739                            controls,
740                            res,
741                            ldb_search_default_callback,
742                            NULL);
743
744             if (ret != LDB_SUCCESS) {
745                 talloc_free(res);
746                 return ret;
747             }
748
749             ret = ldb_request($self, req);
750                 
751             if (ret == LDB_SUCCESS) {
752                 ret = ldb_wait(req->handle, LDB_WAIT_ALL);
753             }
754
755             talloc_free(req);
756
757             *OUT = res;
758             return ret;
759         }
760
761         %feature("docstring") delete "S.delete(dn) -> None\n" \
762                                      "Remove an entry.";
763         ldb_error delete(ldb_dn *dn);
764         %feature("docstring") rename "S.rename(old_dn, new_dn) -> None\n" \
765                                      "Rename an entry.";
766         ldb_error rename(ldb_dn *olddn, ldb_dn *newdn);
767         struct ldb_control **parse_control_strings(TALLOC_CTX *mem_ctx, 
768                                                    const char * const*control_strings);
769         %feature("docstring") add "S.add(message) -> None\n" \
770                                   "Add an entry.";
771         ldb_error add(ldb_msg *add_msg);
772         %feature("docstring") modify "S.modify(message) -> None\n" \
773                                   "Modify an entry.";
774         ldb_error modify(ldb_msg *message);
775         ldb_dn *get_config_basedn();
776         ldb_dn *get_root_basedn();
777         ldb_dn *get_schema_basedn();
778         ldb_dn *get_default_basedn();
779         PyObject *schema_format_value(const char *element_name, PyObject *val)
780         {
781                 const struct ldb_schema_attribute *a;
782                 struct ldb_val old_val;
783                 struct ldb_val new_val;
784                 TALLOC_CTX *mem_ctx = talloc_new(NULL);
785                 PyObject *ret;
786                 
787                 old_val.data = PyString_AsString(val);
788                 old_val.length = PyString_Size(val);
789                 
790                 a = ldb_schema_attribute_by_name($self, element_name);
791         
792                 if (a == NULL) {
793                         return Py_None;
794                 }
795                 
796                 if (a->syntax->ldif_write_fn($self, mem_ctx, &old_val, &new_val) != 0) {
797                         talloc_free(mem_ctx);
798                         return Py_None;
799                  }
800         
801                 ret = PyString_FromStringAndSize((const char *)new_val.data, new_val.length);
802                 
803                 talloc_free(mem_ctx);
804                 
805                 return ret;
806         }
807
808         const char *errstring();
809         %feature("docstring") set_create_perms "S.set_create_perms(mode) -> None\n" \
810                                                "Set mode to use when creating new LDB files.";
811         void set_create_perms(unsigned int perms);
812         %feature("docstring") set_modules_dir "S.set_modules_dir(path) -> None\n" \
813                                               "Set path LDB should search for modules";
814         void set_modules_dir(const char *path);
815         %feature("docstring") set_debug "S.set_debug(callback) -> None\n" \
816                                         "Set callback for LDB debug messages.\n" \
817                                         "The callback should accept a debug level and debug text.";
818         ldb_error set_debug(void (*debug)(void *context, enum ldb_debug_level level, 
819                                           const char *fmt, va_list ap),
820                             void *context);
821         %feature("docstring") set_opaque "S.set_opaque(name, value) -> None\n" \
822             "Set an opaque value on this LDB connection. \n"
823             ":note: Passing incorrect values may cause crashes.";
824         ldb_error set_opaque(const char *name, void *value);
825         %feature("docstring") get_opaque "S.get_opaque(name) -> value\n" \
826             "Get an opaque value set on this LDB connection. \n"
827             ":note: The returned value may not be useful in Python.";
828         void *get_opaque(const char *name);
829         %feature("docstring") transaction_start "S.transaction_start() -> None\n" \
830                                                 "Start a new transaction.";
831         ldb_error transaction_start();
832         %feature("docstring") transaction_commit "S.transaction_commit() -> None\n" \
833                                                  "Commit currently active transaction.";
834         ldb_error transaction_commit();
835         %feature("docstring") transaction_cancel "S.transaction_cancel() -> None\n" \
836                                                  "Cancel currently active transaction.";
837         ldb_error transaction_cancel();
838         void schema_attribute_remove(const char *name);
839         ldb_error schema_attribute_add(const char *attribute, unsigned flags, const char *syntax);
840         ldb_error setup_wellknown_attributes(void);
841  
842 #ifdef SWIGPYTHON
843         %typemap(in,numinputs=0,noblock=1) struct ldb_result **result_as_bool (struct ldb_result *tmp) { $1 = &tmp; }
844         %typemap(argout,noblock=1) struct ldb_result **result_as_bool { $result = ((*$1)->count > 0)?Py_True:Py_False; }
845         %typemap(freearg,noblock=1) struct ldb_result **result_as_bool { talloc_free(*$1); }
846         ldb_error __contains__(ldb_dn *dn, struct ldb_result **result_as_bool)
847         {
848             return ldb_search($self, $self, result_as_bool, dn, LDB_SCOPE_BASE, NULL, NULL);
849         }
850
851         %feature("docstring") parse_ldif "S.parse_ldif(ldif) -> iter(messages)\n" \
852             "Parse a string formatted using LDIF.";
853
854         PyObject *parse_ldif(const char *s)
855         {
856             PyObject *list = PyList_New(0);
857             struct ldb_ldif *ldif;
858             while ((ldif = ldb_ldif_read_string($self, &s)) != NULL) {
859                 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
860             }
861             return PyObject_GetIter(list);
862         }
863
864         char *__repr__(void)
865         {
866             char *ret;
867             asprintf(&ret, "<ldb connection at 0x%x>", ret); 
868             return ret;
869         }
870 #endif
871     }
872     %pythoncode {
873         def __init__(self, url=None, flags=0, options=None):
874             """Create a new LDB object.
875
876             Will also connect to the specified URL if one was given.
877             """
878             _ldb.Ldb_swiginit(self,_ldb.new_Ldb())
879             if url is not None:
880                 self.connect(url, flags, options)
881
882         def search(self, base=None, scope=SCOPE_DEFAULT, expression=None, 
883                    attrs=None, controls=None):
884             """Search in a database.
885
886             :param base: Optional base DN to search
887             :param scope: Search scope (SCOPE_BASE, SCOPE_ONELEVEL or SCOPE_SUBTREE)
888             :param expression: Optional search expression
889             :param attrs: Attributes to return (defaults to all)
890             :param controls: Optional list of controls
891             :return: Iterator over Message objects
892             """
893             if not (attrs is None or isinstance(attrs, list)):
894                 raise TypeError("attributes not a list")
895             parsed_controls = None
896             if controls is not None:
897                 parsed_controls = self.parse_control_strings(controls)
898             return self.search_ex(base, scope, expression, attrs, 
899                                   parsed_controls)
900     }
901
902 } ldb;
903
904 %typemap(in,noblock=1) struct ldb_dn *;
905 %typemap(freearg,noblock=1) struct ldb_dn *;
906
907 %nodefault ldb_message;
908 %nodefault ldb_context;
909 %nodefault Dn;
910
911 %rename(valid_attr_name) ldb_valid_attr_name;
912 %feature("docstring") ldb_valid_attr_name "S.valid_attr_name(name) -> bool\n"
913                                           "Check whether the supplied name is a valid attribute name.";
914 int ldb_valid_attr_name(const char *s);
915
916 typedef unsigned long time_t;
917
918 %feature("docstring") timestring "S.timestring(int) -> string\n"
919                                  "Generate a LDAP time string from a UNIX timestamp";
920
921 %inline %{
922 static char *timestring(time_t t)
923 {
924     char *tresult = ldb_timestring(NULL, t);
925     char *result = strdup(tresult);
926     talloc_free(tresult);
927     return result; 
928 }
929 %}
930
931 %rename(string_to_time) ldb_string_to_time;
932 %feature("docstring") ldb_string_to_time "S.string_to_time(string) -> int\n"
933                                      "Parse a LDAP time string into a UNIX timestamp.";
934 time_t ldb_string_to_time(const char *s);
935
936 typedef struct ldb_module {
937     struct ldb_module *prev, *next;
938
939     %extend {
940 #ifdef SWIGPYTHON
941         const char *__str__() {
942             return $self->ops->name;
943         }
944         char *__repr__() {
945             char *ret;
946             asprintf(&ret, "<ldb module '%s'>", $self->ops->name);
947             return ret;
948         }
949 #endif
950         int search(struct ldb_dn *base, enum ldb_scope scope, struct ldb_parse_tree *tree, const char * const * attrs, struct ldb_result **res) {
951             int ret;
952             struct ldb_request *req = talloc_zero(NULL, struct ldb_request);
953
954             req->operation = LDB_SEARCH;
955             req->op.search.base = base;
956             req->op.search.scope = scope;
957             req->op.search.tree = tree;
958             req->op.search.attrs = attrs;
959
960             req->op.search.res = talloc_zero(NULL, struct ldb_result);
961
962             ret = $self->ops->search($self, req);
963
964             *res = req->op.search.res;
965
966             talloc_free(req);
967
968             return ret;
969         }
970         ldb_error add(struct ldb_message *message) {
971             struct ldb_request *req = talloc_zero(NULL, struct ldb_request);
972             req->operation = LDB_ADD;
973             req->op.add.message = message;
974             
975             return $self->ops->add($self, &req);
976         }
977         ldb_error modify(struct ldb_message *message) {
978             struct ldb_request *req = talloc_zero(NULL, struct ldb_request);
979             req->operation = LDB_MODIFY;
980             req->op.mod.message = message;
981             
982             return $self->ops->modify($self, &req);
983         }
984         ldb_error delete(struct ldb_dn *dn) {
985             struct ldb_request *req = talloc_zero(NULL, struct ldb_request);
986             req->operation = LDB_DELETE;
987             req->op.del.dn = dn;
988             
989             return $self->ops->del($self, &req);
990
991         }
992         ldb_error rename(struct ldb_dn *olddn, struct ldb_dn *newdn) {
993             struct ldb_request *req = talloc_zero(NULL, struct ldb_request);
994             req->operation = LDB_RENAME;
995             req->op.rename.olddn = olddn;
996             req->op.rename.olddn = newdn;
997             
998             return $self->ops->rename($self, &req);
999         }
1000         ldb_error start_transaction() {
1001             return $self->ops->start_transaction($self);
1002         }
1003         ldb_error end_transaction() {
1004             return $self->ops->end_transaction($self);
1005         }
1006         ldb_error del_transaction() {
1007             return $self->ops->del_transaction($self);
1008         }
1009     }
1010 } ldb_module;
1011
1012 %{
1013 int py_module_search(struct ldb_module *mod, struct ldb_request *req)
1014 {
1015     PyObject *py_ldb = mod->private_data;
1016     PyObject *py_result, *py_base, *py_attrs, *py_tree;
1017
1018     py_base = SWIG_NewPointerObj(req->op.search.base, SWIGTYPE_p_ldb_dn, 0);
1019
1020     if (py_base == NULL)
1021         return LDB_ERR_OPERATIONS_ERROR;
1022
1023     py_tree = SWIG_NewPointerObj(req->op.search.tree, SWIGTYPE_p_ldb_parse_tree, 0);
1024
1025     if (py_tree == NULL)
1026         return LDB_ERR_OPERATIONS_ERROR;
1027
1028     if (req->op.search.attrs == NULL) {
1029         py_attrs = Py_None;
1030     } else {
1031         int i, len;
1032         for (len = 0; req->op.search.attrs[len]; len++);
1033         py_attrs = PyList_New(len);
1034         for (i = 0; i < len; i++)
1035             PyList_SetItem(py_attrs, i, PyString_FromString(req->op.search.attrs[i]));
1036     }
1037
1038     py_result = PyObject_CallMethod(py_ldb, "search", "OiOO", py_base, req->op.search.scope, py_tree, py_attrs);
1039
1040     Py_DECREF(py_attrs);
1041     Py_DECREF(py_tree);
1042     Py_DECREF(py_base);
1043
1044     if (py_result == NULL) {
1045         return LDB_ERR_OPERATIONS_ERROR;
1046     }
1047
1048     if (SWIG_ConvertPtr(py_result, &req->op.search.res, SWIGTYPE_p_ldb_result, 0) != 0) {
1049         return LDB_ERR_OPERATIONS_ERROR;
1050     }
1051
1052     Py_DECREF(py_result);
1053
1054     return LDB_SUCCESS;
1055 }
1056
1057 int py_module_add(struct ldb_module *mod, struct ldb_request *req)
1058 {
1059     PyObject *py_ldb = mod->private_data;
1060     PyObject *py_result, *py_msg;
1061
1062     py_msg = SWIG_NewPointerObj(req->op.add.message, SWIGTYPE_p_ldb_message, 0);
1063
1064     if (py_msg == NULL) {
1065         return LDB_ERR_OPERATIONS_ERROR;
1066     }
1067
1068     py_result = PyObject_CallMethod(py_ldb, "add", "O", py_msg);
1069
1070     Py_DECREF(py_msg);
1071
1072     if (py_result == NULL) {
1073         return LDB_ERR_OPERATIONS_ERROR;
1074     }
1075
1076     Py_DECREF(py_result);
1077
1078     return LDB_SUCCESS;
1079 }
1080
1081 int py_module_modify(struct ldb_module *mod, struct ldb_request *req)
1082 {
1083     PyObject *py_ldb = mod->private_data;
1084     PyObject *py_result, *py_msg;
1085
1086     py_msg = SWIG_NewPointerObj(req->op.mod.message, SWIGTYPE_p_ldb_message, 0);
1087
1088     if (py_msg == NULL) {
1089         return LDB_ERR_OPERATIONS_ERROR;
1090     }
1091
1092     py_result = PyObject_CallMethod(py_ldb, "modify", "O", py_msg);
1093
1094     Py_DECREF(py_msg);
1095
1096     if (py_result == NULL) {
1097         return LDB_ERR_OPERATIONS_ERROR;
1098     }
1099
1100     Py_DECREF(py_result);
1101
1102     return LDB_SUCCESS;
1103 }
1104
1105 int py_module_del(struct ldb_module *mod, struct ldb_request *req)
1106 {
1107     PyObject *py_ldb = mod->private_data;
1108     PyObject *py_result, *py_dn;
1109
1110     py_dn = SWIG_NewPointerObj(req->op.del.dn, SWIGTYPE_p_ldb_dn, 0);
1111
1112     if (py_dn == NULL)
1113         return LDB_ERR_OPERATIONS_ERROR;
1114
1115     py_result = PyObject_CallMethod(py_ldb, "delete", "O", py_dn);
1116
1117     if (py_result == NULL) {
1118         return LDB_ERR_OPERATIONS_ERROR;
1119     }
1120
1121     Py_DECREF(py_result);
1122
1123     return LDB_SUCCESS;
1124 }
1125
1126 int py_module_rename(struct ldb_module *mod, struct ldb_request *req)
1127 {
1128     PyObject *py_ldb = mod->private_data;
1129     PyObject *py_result, *py_olddn, *py_newdn;
1130
1131     py_olddn = SWIG_NewPointerObj(req->op.rename.olddn, SWIGTYPE_p_ldb_dn, 0);
1132
1133     if (py_olddn == NULL)
1134         return LDB_ERR_OPERATIONS_ERROR;
1135
1136     py_newdn = SWIG_NewPointerObj(req->op.rename.newdn, SWIGTYPE_p_ldb_dn, 0);
1137
1138     if (py_newdn == NULL)
1139         return LDB_ERR_OPERATIONS_ERROR;
1140
1141     py_result = PyObject_CallMethod(py_ldb, "rename", "OO", py_olddn, py_newdn);
1142
1143     Py_DECREF(py_olddn);
1144     Py_DECREF(py_newdn);
1145
1146     if (py_result == NULL) {
1147         return LDB_ERR_OPERATIONS_ERROR;
1148     }
1149
1150     Py_DECREF(py_result);
1151
1152     return LDB_SUCCESS;
1153 }
1154
1155 int py_module_request(struct ldb_module *mod, struct ldb_request *req)
1156 {
1157     PyObject *py_ldb = mod->private_data;
1158     PyObject *py_result;
1159
1160     py_result = PyObject_CallMethod(py_ldb, "request", "");
1161
1162     return LDB_ERR_OPERATIONS_ERROR;
1163 }
1164
1165 int py_module_extended(struct ldb_module *mod, struct ldb_request *req)
1166 {
1167     PyObject *py_ldb = mod->private_data;
1168     PyObject *py_result;
1169
1170     py_result = PyObject_CallMethod(py_ldb, "extended", "");
1171
1172     return LDB_ERR_OPERATIONS_ERROR;
1173 }
1174
1175 int py_module_start_transaction(struct ldb_module *mod)
1176 {
1177     PyObject *py_ldb = mod->private_data;
1178     PyObject *py_result;
1179
1180     py_result = PyObject_CallMethod(py_ldb, "start_transaction", "");
1181
1182     if (py_result == NULL) {
1183         return LDB_ERR_OPERATIONS_ERROR;
1184     }
1185
1186     Py_DECREF(py_result);
1187
1188     return LDB_SUCCESS;
1189 }
1190
1191 int py_module_end_transaction(struct ldb_module *mod)
1192 {
1193     PyObject *py_ldb = mod->private_data;
1194     PyObject *py_result;
1195
1196     py_result = PyObject_CallMethod(py_ldb, "end_transaction", "");
1197
1198     if (py_result == NULL) {
1199         return LDB_ERR_OPERATIONS_ERROR;
1200     }
1201
1202     Py_DECREF(py_result);
1203
1204     return LDB_SUCCESS;
1205 }
1206
1207 int py_module_del_transaction(struct ldb_module *mod)
1208 {
1209     PyObject *py_ldb = mod->private_data;
1210     PyObject *py_result;
1211
1212     py_result = PyObject_CallMethod(py_ldb, "del_transaction", "");
1213
1214     if (py_result == NULL) {
1215         return LDB_ERR_OPERATIONS_ERROR;
1216     }
1217
1218     Py_DECREF(py_result);
1219
1220     return LDB_SUCCESS;
1221 }
1222
1223 static int py_module_destructor(void *_mod)
1224 {
1225     struct ldb_module *mod = _mod;
1226     Py_DECREF((PyObject *)mod->private_data);
1227     return 0;
1228 }
1229
1230 int py_module_init (struct ldb_module *mod)
1231 {
1232     PyObject *py_class = mod->ops->private_data;
1233     PyObject *py_result, *py_next, *py_ldb;
1234
1235     py_ldb = SWIG_NewPointerObj(mod->ldb, SWIGTYPE_p_ldb_context, 0);
1236
1237     if (py_ldb == NULL)
1238         return LDB_ERR_OPERATIONS_ERROR;
1239
1240     py_next = SWIG_NewPointerObj(mod->next, SWIGTYPE_p_ldb_module, 0);
1241
1242     if (py_next == NULL)
1243         return LDB_ERR_OPERATIONS_ERROR;
1244
1245     py_result = PyObject_CallFunction(py_class, "OO", py_ldb, py_next);
1246
1247     if (py_result == NULL) {
1248         return LDB_ERR_OPERATIONS_ERROR;
1249     }
1250
1251     mod->private_data = py_result;
1252
1253     talloc_set_destructor (mod, py_module_destructor);
1254
1255     return ldb_next_init(mod);
1256 }
1257 %}
1258
1259 %typemap(in,noblock=1) const struct ldb_module_ops * {
1260     $1 = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
1261
1262     $1->name = talloc_strdup($1, PyString_AsString(PyObject_GetAttrString($input, (char *)"name")));
1263
1264     Py_INCREF($input);
1265     $1->private_data = $input;
1266     $1->init_context = py_module_init;
1267     $1->search = py_module_search;
1268     $1->add = py_module_add;
1269     $1->modify = py_module_modify;
1270     $1->del = py_module_del;
1271     $1->rename = py_module_rename;
1272     $1->request = py_module_request;
1273     $1->extended = py_module_extended;
1274     $1->start_transaction = py_module_start_transaction;
1275     $1->end_transaction = py_module_end_transaction;
1276     $1->del_transaction = py_module_del_transaction;
1277 }
1278
1279 %feature("docstring") ldb_register_module "S.register_module(module) -> None\n"
1280                                           "Register a LDB module.";
1281 %rename(register_module) ldb_register_module;
1282 ldb_int_error ldb_register_module(const struct ldb_module_ops *);
1283
1284 %pythoncode {
1285 __docformat__ = "restructuredText"
1286 open = Ldb
1287 }