1ed1b45eafe3e7ef91d778d21a4882da04376895
[ira/wip.git] / source / 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 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 %module ldb
29
30 %{
31
32 #include <stdint.h>
33 #include <stdbool.h>
34 #include "talloc.h"
35 #include "ldb.h"
36 #include "ldb_errors.h"
37 #include "ldb_private.h"
38
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
46 %}
47
48 %import "carrays.i"
49 %import "typemaps.i"
50 %include "exception.i"
51 %import "stdint.i"
52
53 %constant int SCOPE_DEFAULT = LDB_SCOPE_DEFAULT;
54 %constant int SCOPE_BASE = LDB_SCOPE_BASE;
55 %constant int SCOPE_ONELEVEL = LDB_SCOPE_ONELEVEL;
56 %constant int SCOPE_SUBTREE = LDB_SCOPE_SUBTREE;
57
58 %constant int CHANGETYPE_NONE = LDB_CHANGETYPE_NONE;
59 %constant int CHANGETYPE_ADD = LDB_CHANGETYPE_ADD;
60 %constant int CHANGETYPE_DELETE = LDB_CHANGETYPE_DELETE;
61 %constant int CHANGETYPE_MODIFY = LDB_CHANGETYPE_MODIFY;
62
63 /* 
64  * Wrap struct ldb_context
65  */
66
67 /* The ldb functions will crash if a NULL ldb context is passed so
68    catch this before it happens. */
69
70 %typemap(check) struct ldb_context* {
71         if ($1 == NULL)
72                 SWIG_exception(SWIG_ValueError, 
73                         "ldb context must be non-NULL");
74 }
75
76 %typemap(check) ldb_msg * {
77         if ($1 == NULL)
78                 SWIG_exception(SWIG_ValueError, 
79                         "Message can not be None");
80 }
81
82 /*
83  * Wrap struct ldb_val
84  */
85
86 %typemap(in) struct ldb_val *INPUT (struct ldb_val temp) {
87         $1 = &temp;
88         if (!PyString_Check($input)) {
89                 PyErr_SetString(PyExc_TypeError, "string arg expected");
90                 return NULL;
91         }
92         $1->length = PyString_Size($input);
93         $1->data = PyString_AsString($input);
94 }
95
96 %typemap(out) struct ldb_val {
97         $result = PyString_FromStringAndSize((const char *)$1.data, $1.length);
98 }
99
100 /*
101  * Wrap struct ldb_result
102  */
103
104 %typemap(in, numinputs=0) struct ldb_result **OUT (struct ldb_result *temp_ldb_result) {
105         $1 = &temp_ldb_result;
106 }
107
108 #ifdef SWIGPYTHON
109 %typemap(argout) struct ldb_result ** (int i) {
110         $result = PyList_New((*$1)->count);
111     for (i = 0; i < (*$1)->count; i++) {
112         PyList_SetItem($result, i, 
113             SWIG_NewPointerObj((*$1)->msgs[i], SWIGTYPE_p_ldb_message, 0)
114         );
115     }
116 }
117
118 %typemap(in, numinputs=1) const char * const *attrs {
119     if ($input == Py_None) {
120         $1 = NULL;
121     } else if (PySequence_Check($input)) {
122         int i;
123         $1 = talloc_array(NULL, char *, PySequence_Size($input)+1);
124         for(i = 0; i < PySequence_Size($input); i++)
125             $1[i] = PyString_AsString(PySequence_GetItem($input, i));
126         $1[i] = NULL;
127     } else {
128         SWIG_exception(SWIG_TypeError, "expected sequence");
129     }
130 }
131
132 %typemap(freearg) const char * const *attrs {
133     talloc_free($1);
134 }
135 #endif
136
137 %types(struct ldb_result *);
138
139 /*
140  * Wrap struct ldb_dn
141  */
142
143 %rename(__str__) ldb_dn::get_linearized;
144 %rename(__cmp__) ldb_dn::compare;
145 %rename(__len__) ldb_dn::get_comp_num;
146 %rename(Dn) ldb_dn;
147 typedef struct ldb_dn {
148     %extend {
149         ldb_dn(ldb *ldb, const char *str)
150         {
151             ldb_dn *ret = ldb_dn_new(ldb, ldb, str);
152             /* ldb_dn_new() doesn't accept NULL as memory context, so 
153                we do it this way... */
154             talloc_steal(NULL, ret);
155
156             if (ret == NULL)
157                 SWIG_exception(SWIG_ValueError, 
158                                 "unable to parse dn string");
159 fail:
160             return ret;
161         }
162         ~ldb_dn() { talloc_free($self); }
163         bool validate();
164         const char *get_casefold();
165         const char *get_linearized();
166         ldb_dn *parent() { return ldb_dn_get_parent(NULL, $self); }
167         int compare(ldb_dn *other);
168         bool is_valid();
169         bool is_special();
170         bool is_null();
171         bool check_special(const char *name);
172         int get_comp_num();
173         bool add_child(ldb_dn *child);
174         bool add_base(ldb_dn *base);
175         const char *canonical_str() {
176             return ldb_dn_canonical_string($self, $self);
177         }
178         const char *canonical_ex_str() {
179             return ldb_dn_canonical_ex_string($self, $self);
180         }
181 #ifdef SWIGPYTHON
182         ldb_dn *__add__(ldb_dn *other)
183         {
184             ldb_dn *ret = ldb_dn_copy(NULL, $self);
185             ldb_dn_add_child(ret, other);
186             return ret;
187         }
188
189         /* FIXME: implement __getslice__ */
190 #endif
191     }
192 } ldb_dn;
193
194 #ifdef SWIGPYTHON
195 %{
196 int ldb_dn_from_pyobject(TALLOC_CTX *mem_ctx, PyObject *object, 
197                          struct ldb_context *ldb, ldb_dn **dn)
198 {
199     if (ldb != NULL && PyString_Check(object)) {
200         *dn = ldb_dn_new(mem_ctx, ldb, PyString_AsString(object));
201         return 0;
202     }
203     return SWIG_ConvertPtr(object, (void **)dn, SWIGTYPE_p_ldb_dn, 
204                            SWIG_POINTER_EXCEPTION);
205 }
206
207 ldb_msg_element *ldb_msg_element_from_pyobject(PyObject *set_obj, int flags,
208                                                const char *attr_name)
209 {
210     struct ldb_message_element *me = talloc(NULL, struct ldb_message_element);
211     me->name = attr_name;
212     me->flags = flags;
213     if (PyString_Check(set_obj)) {
214         me->num_values = 1;
215         me->values = talloc_array(me, struct ldb_val, me->num_values);
216         me->values[0].length = PyString_Size(set_obj);
217         me->values[0].data = (uint8_t *)talloc_strdup(me->values, 
218                                            PyString_AsString(set_obj));
219     } else if (PySequence_Check(set_obj)) {
220         int i;
221         me->num_values = PySequence_Size(set_obj);
222         me->values = talloc_array(me, struct ldb_val, me->num_values);
223         for (i = 0; i < me->num_values; i++) {
224             PyObject *obj = PySequence_GetItem(set_obj, i);
225             me->values[i].length = PyString_Size(obj);
226             me->values[i].data = (uint8_t *)PyString_AsString(obj);
227         }
228     } else {
229         talloc_free(me);
230         me = NULL;
231     }
232
233     return me;
234 }
235
236 PyObject *ldb_msg_element_to_set(ldb_msg_element *me)
237 {
238     int i;
239     PyObject *result;
240
241     /* Python << 2.5 doesn't have PySet_New and PySet_Add. */
242     result = PyList_New(me->num_values);
243
244     for (i = 0; i < me->num_values; i++) {
245         PyList_SetItem(result, i,
246             PyString_FromStringAndSize((const char *)me->values[i].data, 
247                                        me->values[i].length));
248     }
249
250     return result;
251 }
252
253 %}
254 #endif
255
256 /* ldb_message_element */
257 %rename(__cmp__) ldb_message_element::compare;
258 %rename(MessageElement) ldb_msg_element;
259 typedef struct ldb_message_element {
260     %extend {
261 #ifdef SWIGPYTHON
262         PyObject *__iter__(void)
263         {
264             return PyObject_GetIter(ldb_msg_element_to_set($self));
265         }
266
267         PyObject *__set__(void)
268         {
269             return ldb_msg_element_to_set($self);
270         }
271
272         ldb_msg_element(PyObject *set_obj, int flags=0, const char *name = NULL)
273         {
274             return ldb_msg_element_from_pyobject(set_obj, flags, name);
275         }
276 #endif
277         ~ldb_msg_element() { talloc_free($self); }
278         int compare(ldb_msg_element *);
279     }
280 } ldb_msg_element;
281
282 /* ldb_message */
283
284 %rename(Message) ldb_message;
285 #ifdef SWIGPYTHON
286 %rename(__delitem__) ldb_message::remove_attr;
287 %typemap(out) ldb_msg_element * {
288         if ($1 == NULL)
289                 PyErr_SetString(PyExc_KeyError, "no such element");
290     else
291         $result = SWIG_NewPointerObj($1, SWIGTYPE_p_ldb_message_element, 0);
292 }
293 %rename(__getitem__) ldb_message::find_element;
294 //%typemap(out) ldb_msg_element *;
295
296
297 %inline {
298     PyObject *ldb_msg_list_elements(ldb_msg *msg)
299     {
300         int i;
301         PyObject *obj = PyList_New(msg->num_elements);
302         for (i = 0; i < msg->num_elements; i++)
303             PyList_SetItem(obj, i, PyString_FromString(msg->elements[i].name));
304         return obj;
305     }
306 }
307
308 #endif
309
310 typedef struct ldb_message {
311         ldb_dn *dn;
312
313     %extend {
314         ldb_msg(ldb_dn *dn = NULL) { 
315             ldb_msg *ret = ldb_msg_new(NULL); 
316             ret->dn = talloc_reference(ret, dn);
317             return ret;
318         }
319         ~ldb_msg() { talloc_free($self); }
320
321         ldb_msg_element *find_element(const char *name);
322         
323 #ifdef SWIGPYTHON
324         void __setitem__(const char *attr_name, ldb_msg_element *val)
325         {
326             struct ldb_message_element *el;
327             
328             ldb_msg_remove_attr($self, attr_name);
329
330             el = talloc($self, struct ldb_message_element);
331             el->name = talloc_strdup(el, attr_name);
332             el->num_values = val->num_values;
333             el->values = talloc_reference(el, val->values);
334
335             ldb_msg_add($self, el, val->flags);
336         }
337
338         void __setitem__(const char *attr_name, PyObject *val)
339         {
340             struct ldb_message_element *el = ldb_msg_element_from_pyobject(
341                                                 val, 0, attr_name);
342             talloc_steal($self, el);
343             ldb_msg_remove_attr($self, attr_name);
344             ldb_msg_add($self, el, el->flags);
345         }
346
347         unsigned int __len__() { return $self->num_elements; }
348
349         PyObject *keys(void)
350         {
351             return ldb_msg_list_elements($self);
352         }
353
354         PyObject *__iter__(void)
355         {
356             return PyObject_GetIter(ldb_msg_list_elements($self));
357         }
358 #endif
359         void remove_attr(const char *name);
360     }
361 } ldb_msg;
362
363 /* FIXME: Convert ldb_result to 3-tuple:
364    (msgs, refs, controls)
365  */
366
367 typedef struct ldb_ldif ldb_ldif;
368
369 #ifdef SWIGPYTHON
370 %{
371 static void py_ldb_debug(void *context, enum ldb_debug_level level, const char *fmt, va_list ap)
372 {
373     char *text;
374     PyObject *fn = context;
375
376     vasprintf(&text, fmt, ap);
377     PyObject_CallFunction(fn, "(i,s)", level, text);
378     free(text);
379 }
380 %}
381
382 %typemap(in,numinputs=1) (void (*debug)(void *context, enum ldb_debug_level level, const char *fmt, va_list ap),
383                             void *context) {
384     $1 = py_ldb_debug;
385     /* FIXME: Should be decreased somewhere as well. Perhaps register a 
386        destructor and tie it to the ldb context ? */
387     Py_INCREF($input);
388     $2 = $input;
389 }
390 #endif
391
392 %inline {
393     static PyObject *ldb_ldif_to_pyobject(ldb_ldif *ldif)
394     {
395         if (ldif == NULL) {
396             return Py_None;
397         } else {
398             return Py_BuildValue("(iO)", ldif->changetype, 
399                    SWIG_NewPointerObj(ldif->msg, SWIGTYPE_p_ldb_message, 0));
400         }
401     }
402 }
403
404 /*
405  * Wrap ldb errors
406  */
407
408 %{
409 PyObject *PyExc_LdbError;
410 %}
411
412 %pythoncode %{
413     LdbError = _ldb.LdbError
414 %}
415
416 %init %{
417     PyExc_LdbError = PyErr_NewException("_ldb.LdbError", NULL, NULL);
418     PyDict_SetItemString(d, "LdbError", PyExc_LdbError);
419 %}
420
421 %ignore _LDB_ERRORS_H_;
422 %ignore LDB_SUCCESS;
423 %include "include/ldb_errors.h"
424
425 /*
426  * Wrap ldb functions 
427  */
428
429
430 %typemap(out) ldb_error {
431     if ($1 != LDB_SUCCESS) {
432         PyErr_SetObject(PyExc_LdbError, Py_BuildValue("(i,s)", $1, ldb_strerror($1)));
433         SWIG_fail;
434     }
435     $result = Py_None;
436 };
437
438 %rename(Ldb) ldb_context;
439 /* Top-level ldb operations */
440 typedef struct ldb_context {
441     %extend {
442         ldb(const char *url=NULL, unsigned int flags = 0, 
443             const char *options[] = NULL)
444         {
445             ldb *ldb = ldb_init(NULL);
446             
447             if (url != NULL) {
448                 int ret;
449
450                 ret = ldb_connect(ldb, url, flags, options);
451                 if (ret != LDB_SUCCESS)
452                     SWIG_exception(SWIG_ValueError, ldb_errstring(ldb));
453             }
454
455             return ldb;
456
457 fail:
458             talloc_free(ldb);
459             return NULL;
460         }
461
462         ldb_error connect(const char *url, unsigned int flags = 0, 
463             const char *options[] = NULL);
464
465         ~ldb() { talloc_free($self); }
466         ldb_error search(ldb_dn *base = NULL, 
467                    enum ldb_scope scope = LDB_SCOPE_DEFAULT, 
468                    const char *expression = NULL, 
469                    const char * const *attrs = NULL, 
470                    struct ldb_result **OUT);
471         ldb_error delete(ldb_dn *dn);
472         ldb_error rename(ldb_dn *olddn, ldb_dn *newdn);
473         ldb_error add(ldb_msg *add_msg);
474         ldb_error add(PyObject *py_msg) 
475         {
476             ldb_error ret;
477             int dict_pos, msg_pos;
478             PyObject *key, *value;
479             ldb_msg_element *msgel;
480             ldb_msg *msg = NULL;
481             if (PyDict_Check(py_msg)) {
482                 msg = ldb_msg_new(NULL);
483                 msg->num_elements = PyDict_Size(py_msg) - 1; /* dn isn't in there */
484                 msg->elements = talloc_zero_array(msg, struct ldb_message_element, msg->num_elements+1);
485                 msg_pos = dict_pos = 0;
486                 while (PyDict_Next(py_msg, &dict_pos, &key, &value)) {
487                     if (!strcmp(PyString_AsString(key), "dn")) {
488                         if (ldb_dn_from_pyobject(msg, value, $self, &msg->dn) != 0) {
489                             return LDB_ERR_OTHER;
490                         }
491                     } else {
492                         msgel = ldb_msg_element_from_pyobject(value, 0, PyString_AsString(key));
493                         memcpy(&msg->elements[msg_pos], msgel, sizeof(*msgel));
494                         msg_pos++;
495                     }
496                     dict_pos++;
497                 }
498
499                 if (msg->dn == NULL) {
500                     SWIG_exception(SWIG_TypeError, "no dn set");
501                     return LDB_ERR_OTHER;
502                 }
503             } else {
504                 if (SWIG_ConvertPtr(py_msg, (void **)&msg, SWIGTYPE_p_ldb_message, 0) != 0)
505                     return LDB_ERR_OTHER;
506             }
507
508             ret = ldb_add($self,msg);
509
510             talloc_free(msg);
511             return ret;
512
513             fail:
514             return LDB_ERR_OTHER;
515         }
516         ldb_error modify(ldb_msg *message);
517         ldb_dn *get_config_basedn();
518         ldb_dn *get_root_basedn();
519         ldb_dn *get_schema_basedn();
520         ldb_dn *get_default_basedn();
521         const char *errstring();
522         void set_create_perms(unsigned int perms);
523         void set_modules_dir(const char *path);
524         ldb_error set_debug(void (*debug)(void *context, enum ldb_debug_level level, 
525                                           const char *fmt, va_list ap),
526                             void *context);
527         ldb_error set_opaque(const char *name, void *value);
528         void *get_opaque(const char *name);
529         ldb_error transaction_start();
530         ldb_error transaction_commit();
531         ldb_error transaction_cancel();
532
533 #ifdef SWIGPYTHON
534         %typemap(in,numinputs=0) struct ldb_result **result_as_bool (struct ldb_result *tmp) { $1 = &tmp; }
535         %typemap(argout) struct ldb_result **result_as_bool { $result = ((*$1)->count > 0)?Py_True:Py_False; }
536         %typemap(freearg) struct ldb_result **result_as_bool { talloc_free(*$1); }
537         ldb_error __contains__(ldb_dn *dn, struct ldb_result **result_as_bool)
538         {
539             return ldb_search($self, dn, LDB_SCOPE_BASE, NULL, NULL, 
540                              result_as_bool);
541         }
542
543         PyObject *parse_ldif(const char *s)
544         {
545             PyObject *list = PyList_New(0);
546             struct ldb_ldif *ldif;
547             while ((ldif = ldb_ldif_read_string($self, &s)) != NULL) {
548                 PyList_Append(list, ldb_ldif_to_pyobject(ldif));
549             }
550             return PyObject_GetIter(list);
551         }
552
553 #endif
554     }
555 } ldb;
556
557 %nodefault ldb_message;
558 %nodefault ldb_context;
559 %nodefault Dn;
560
561 %rename(valid_attr_name) ldb_valid_attr_name;
562 int ldb_valid_attr_name(const char *s);
563
564 typedef unsigned long time_t;
565
566 %inline %{
567 static char *timestring(time_t t)
568 {
569     char *tresult = ldb_timestring(NULL, t);
570     char *result = strdup(tresult);
571     talloc_free(tresult);
572     return result; 
573 }
574 %}
575
576 %rename(string_to_time) ldb_string_to_time;
577 time_t ldb_string_to_time(const char *s);
578
579 %typemap(in) const struct ldb_module_ops * {
580     $1 = talloc_zero(talloc_autofree_context(), struct ldb_module_ops);
581
582     $1->name = PyObject_GetAttrString($input, "name");
583 }
584
585 %rename(register_module) ldb_register_module;
586 ldb_error ldb_register_module(const struct ldb_module_ops *);