r15110: Start rewriting higher level ldb wrapper.
[samba.git] / source / lib / ldb / swig / Ldb.py
1 """Provide a more Pythonic and object-oriented interface to ldb."""
2
3 #
4 # Swig interface to Samba
5 #
6 # Copyright (C) Tim Potter 2006
7 #
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 2 of the License, or
11 # (at your option) any later version.
12 #   
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 # GNU General Public License for more details.
17 #   
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #
22
23 from ldb import *
24
25 ldb_global_init()
26
27 class LdbError(Exception):
28     """An exception raised when a ldb error occurs."""
29     pass
30
31 class LdbMessage:
32     """A class representing a ldb message as a Python dictionary."""
33     
34     def __init__(self, msg = None):
35
36         self._msg = msg
37         if self._msg is None:
38             self._msg = ldb_msg_new(None)
39
40     def __del__(self):
41         talloc_free(self._msg)
42
43     def len(self):
44         return self._msg.num_elements
45
46     def __getitem__(self, key):
47         elt = ldb_msg_find_element(self._msg, key)
48         if elt is None:
49             raise KeyError, "No such attribute '%s'" % key
50         return [ldb_val_array_getitem(elt.values, i)
51                 for i in range(elt.num_values)]
52
53     def __setitem__(self, key, value):
54         result = ldb_msg_add_value(self._msg, key, str(value))
55         if result != LDB_SUCCESS:
56             raise LdbError, (result, ldb.strerror(result))
57     
58 class Ldb:
59     """A class representing a binding to a ldb file."""
60
61     def __init__(self, url, flags = 0):
62         """Initialise underlying ldb."""
63     
64         self.mem_ctx = talloc_init('mem_ctx for ldb 0x%x' % id(self))
65         self.ldb_ctx = ldb_init(self.mem_ctx)
66
67         result =  ldb_connect(self.ldb_ctx, url, flags, None)
68
69         if result != LDB_SUCCESS:
70             raise ldbError, (result, ldb.strerror(result))
71         
72     def __del__(self):
73         ldb.talloc_free(self.mem_ctx)
74         self.mem_ctx = None
75         self.ldb_ctx = None
76
77     def _ldb_call(self, fn, *args):
78         """Call a ldb function with args.  Raise a LdbError exception
79         if the function returns a non-zero return value."""
80         
81         result = fn(*args)
82
83         if result != ldb.LDB_SUCCESS:
84             raise LdbError, (result, ldb.strerror(result))
85
86     def search(self, expression):
87         """Search a ldb for a given expression."""
88
89         self._ldb_call(ldb.search, self.ldb_ctx, None, ldb.LDB_SCOPE_DEFAULT,
90                        expression, None);
91
92         return [LdbMessage(ldb.ldb_message_ptr_array_getitem(result.msgs, ndx))
93                 for ndx in range(result.count)]
94
95     def delete(self, dn):
96         """Delete a dn."""
97
98         _dn = ldb_dn_explode(self.ldb_ctx, dn)
99
100         self._ldb_call(ldb.delete, self.ldb_ctx, _dn)
101
102     def rename(self, olddn, newdn):
103         """Rename a dn."""
104         
105         _olddn = ldb_dn_explode(self.ldb_ctx, olddn)
106         _newdn = ldb_dn_explode(self.ldb_ctx, newdn)
107         
108         self._ldb_call(ldb.rename, self.ldb_ctx, _olddn, _newdn)
109
110     def add(self, msg):
111         self._ldb_call(ldb.add, self.ldb_ctx, msg)