e9fc26af20b846a470d3994807f260a4dfc799a1
[amitay/samba.git] / source4 / scripting / python / samba / __init__.py
1 #!/usr/bin/python
2
3 # Unix SMB/CIFS implementation.
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
5
6 # Based on the original in EJS:
7 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
8 #   
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
13 #   
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 # GNU General Public License for more details.
18 #   
19 # You should have received a copy of the GNU General Public License
20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 #
22
23 """Samba 4."""
24
25 __docformat__ = "restructuredText"
26
27 import os
28
29 def _in_source_tree():
30     """Check whether the script is being run from the source dir. """
31     return os.path.exists("%s/../../../samba4-skip" % os.path.dirname(__file__))
32
33
34 # When running, in-tree, make sure bin/python is in the PYTHONPATH
35 if _in_source_tree():
36     import sys
37     srcdir = "%s/../../.." % os.path.dirname(__file__)
38     sys.path.append("%s/bin/python" % srcdir)
39     default_ldb_modules_dir = "%s/bin/modules/ldb" % srcdir
40 else:
41     default_ldb_modules_dir = None
42
43
44 import ldb
45 import credentials
46 import glue
47
48 class Ldb(ldb.Ldb):
49     """Simple Samba-specific LDB subclass that takes care 
50     of setting up the modules dir, credentials pointers, etc.
51     
52     Please note that this is intended to be for all Samba LDB files, 
53     not necessarily the Sam database. For Sam-specific helper 
54     functions see samdb.py.
55     """
56     def __init__(self, url=None, session_info=None, credentials=None, 
57                  modules_dir=None, lp=None):
58         """Open a Samba Ldb file. 
59
60         :param url: Optional LDB URL to open
61         :param session_info: Optional session information
62         :param credentials: Optional credentials, defaults to anonymous.
63         :param modules_dir: Modules directory, if not the default.
64         :param lp: Loadparm object, optional.
65
66         This is different from a regular Ldb file in that the Samba-specific
67         modules-dir is used by default and that credentials and session_info 
68         can be passed through (required by some modules).
69         """
70         super(Ldb, self).__init__()
71
72         if modules_dir is not None:
73             self.set_modules_dir(modules_dir)
74         elif default_ldb_modules_dir is not None:
75             self.set_modules_dir(default_ldb_modules_dir)
76
77         if credentials is not None:
78             self.set_credentials(credentials)
79
80         if session_info is not None:
81             self.set_session_info(session_info)
82
83         glue.ldb_register_samba_handlers(self)
84
85         if lp is not None:
86             self.set_loadparm(lp)
87
88         def msg(l,text):
89             print text
90         #self.set_debug(msg)
91
92         if url is not None:
93             self.connect(url)
94
95     def set_credentials(self, credentials):
96         glue.ldb_set_credentials(self, credentials)
97
98     def set_session_info(self, session_info):
99         glue.ldb_set_session_info(self, session_info)
100
101     def set_loadparm(self, lp_ctx):
102         glue.ldb_set_loadparm(self, lp_ctx)
103
104     def searchone(self, attribute, basedn=None, expression=None, 
105                   scope=ldb.SCOPE_BASE):
106         """Search for one attribute as a string.
107         
108         :param basedn: BaseDN for the search.
109         :param attribute: Name of the attribute
110         :param expression: Optional search expression.
111         :param scope: Search scope (defaults to base).
112         :return: Value of attribute as a string or None if it wasn't found.
113         """
114         res = self.search(basedn, scope, expression, [attribute])
115         if len(res) != 1 or res[0][attribute] is None:
116             return None
117         values = set(res[0][attribute])
118         assert len(values) == 1
119         return self.schema_format_value(attribute, values.pop())
120
121     def erase(self):
122         """Erase this ldb, removing all records."""
123         # delete the specials
124         for attr in ["@INDEXLIST", "@ATTRIBUTES", "@SUBCLASSES", "@MODULES", 
125                      "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
126             try:
127                 self.delete(attr)
128             except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
129                 # Ignore missing dn errors
130                 pass
131
132         basedn = ""
133         # and the rest
134         for msg in self.search(basedn, ldb.SCOPE_SUBTREE, 
135                 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", 
136                 ["distinguishedName"]):
137             try:
138                 self.delete(msg.dn)
139             except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
140                 # Ignore no such object errors
141                 pass
142
143         res = self.search(basedn, ldb.SCOPE_SUBTREE, "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", ["distinguishedName"])
144         assert len(res) == 0
145
146     def erase_partitions(self):
147         """Erase an ldb, removing all records."""
148         res = self.search("", ldb.SCOPE_BASE, "(objectClass=*)", 
149                          ["namingContexts"])
150         assert len(res) == 1
151         if not "namingContexts" in res[0]:
152             return
153         for basedn in res[0]["namingContexts"]:
154             previous_remaining = 1
155             current_remaining = 0
156
157             k = 0
158             while ++k < 10 and (previous_remaining != current_remaining):
159                 # and the rest
160                 try:
161                     res2 = self.search(basedn, ldb.SCOPE_SUBTREE, "(|(objectclass=*)(distinguishedName=*))", ["distinguishedName"])
162                 except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
163                     # Ignore missing dn errors
164                     return
165
166                 previous_remaining = current_remaining
167                 current_remaining = len(res2)
168                 for msg in res2:
169                     try:
170                         self.delete(msg.dn)
171                     # Ignore no such object errors
172                     except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
173                         pass
174                     # Ignore not allowed on non leaf errors
175                     except ldb.LdbError, (LDB_ERR_NOT_ALLOWED_ON_NON_LEAF, _):
176                         pass
177
178     def load_ldif_file_add(self, ldif_path):
179         """Load a LDIF file.
180
181         :param ldif_path: Path to LDIF file.
182         """
183         self.add_ldif(open(ldif_path, 'r').read())
184
185     def add_ldif(self, ldif):
186         """Add data based on a LDIF string.
187
188         :param ldif: LDIF text.
189         """
190         for changetype, msg in self.parse_ldif(ldif):
191             assert changetype == ldb.CHANGETYPE_NONE
192             self.add(msg)
193
194     def modify_ldif(self, ldif):
195         """Modify database based on a LDIF string.
196
197         :param ldif: LDIF text.
198         """
199         for changetype, msg in self.parse_ldif(ldif):
200             self.modify(msg)
201
202
203 def substitute_var(text, values):
204     """substitute strings of the form ${NAME} in str, replacing
205     with substitutions from subobj.
206     
207     :param text: Text in which to subsitute.
208     :param values: Dictionary with keys and values.
209     """
210
211     for (name, value) in values.items():
212         assert isinstance(name, str), "%r is not a string" % name
213         assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
214         text = text.replace("${%s}" % name, value)
215
216     return text
217
218
219 def check_all_substituted(text):
220     """Make sure that all substitution variables in a string have been replaced.
221     If not, raise an exception.
222     
223     :param text: The text to search for substitution variables
224     """
225     if not "${" in text:
226         return
227     
228     var_start = text.find("${")
229     var_end = text.find("}", var_start)
230     
231     raise Exception("Not all variables substituted: %s" % text[var_start:var_end+1])
232
233
234 def valid_netbios_name(name):
235     """Check whether a name is valid as a NetBIOS name. """
236     # FIXME: There are probably more constraints here. 
237     # crh has a paragraph on this in his book (1.4.1.1)
238     if len(name) > 15:
239         return False
240     return True
241
242 version = glue.version