libreplace: Fix the build on Solaris
[sfrench/samba-autobuild/.git] / python / samba / __init__.py
1 # Unix SMB/CIFS implementation.
2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
3 #
4 # Based on the original in EJS:
5 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
6 #
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 #
20
21 """Samba 4."""
22
23 __docformat__ = "restructuredText"
24
25 import os
26 import sys
27 import time
28 import samba.param
29
30
31 def source_tree_topdir():
32     """Return the top level source directory."""
33     paths = ["../../..", "../../../.."]
34     for p in paths:
35         topdir = os.path.normpath(os.path.join(os.path.dirname(__file__), p))
36         if os.path.exists(os.path.join(topdir, 'source4')):
37             return topdir
38     raise RuntimeError("unable to find top level source directory")
39
40
41 def in_source_tree():
42     """Return True if we are running from within the samba source tree"""
43     try:
44         topdir = source_tree_topdir()
45     except RuntimeError:
46         return False
47     return True
48
49
50 import ldb
51 from samba._ldb import Ldb as _Ldb
52
53
54 class Ldb(_Ldb):
55     """Simple Samba-specific LDB subclass that takes care
56     of setting up the modules dir, credentials pointers, etc.
57
58     Please note that this is intended to be for all Samba LDB files,
59     not necessarily the Sam database. For Sam-specific helper
60     functions see samdb.py.
61     """
62
63     def __init__(self, url=None, lp=None, modules_dir=None, session_info=None,
64                  credentials=None, flags=0, options=None):
65         """Opens a Samba Ldb file.
66
67         :param url: Optional LDB URL to open
68         :param lp: Optional loadparm object
69         :param modules_dir: Optional modules directory
70         :param session_info: Optional session information
71         :param credentials: Optional credentials, defaults to anonymous.
72         :param flags: Optional LDB flags
73         :param options: Additional options (optional)
74
75         This is different from a regular Ldb file in that the Samba-specific
76         modules-dir is used by default and that credentials and session_info
77         can be passed through (required by some modules).
78         """
79
80         if modules_dir is not None:
81             self.set_modules_dir(modules_dir)
82         else:
83             self.set_modules_dir(os.path.join(samba.param.modules_dir(), "ldb"))
84
85         if session_info is not None:
86             self.set_session_info(session_info)
87
88         if credentials is not None:
89             self.set_credentials(credentials)
90
91         if lp is not None:
92             self.set_loadparm(lp)
93
94         # This must be done before we load the schema, as these handlers for
95         # objectSid and objectGUID etc must take precedence over the 'binary
96         # attribute' declaration in the schema
97         self.register_samba_handlers()
98
99         # TODO set debug
100         def msg(l, text):
101             print text
102         #self.set_debug(msg)
103
104         self.set_utf8_casefold()
105
106         # Allow admins to force non-sync ldb for all databases
107         if lp is not None:
108             nosync_p = lp.get("nosync", "ldb")
109             if nosync_p is not None and nosync_p:
110                 flags |= ldb.FLG_NOSYNC
111
112         self.set_create_perms(0600)
113
114         if url is not None:
115             self.connect(url, flags, options)
116
117     def searchone(self, attribute, basedn=None, expression=None,
118                   scope=ldb.SCOPE_BASE):
119         """Search for one attribute as a string.
120
121         :param basedn: BaseDN for the search.
122         :param attribute: Name of the attribute
123         :param expression: Optional search expression.
124         :param scope: Search scope (defaults to base).
125         :return: Value of attribute as a string or None if it wasn't found.
126         """
127         res = self.search(basedn, scope, expression, [attribute])
128         if len(res) != 1 or res[0][attribute] is None:
129             return None
130         values = set(res[0][attribute])
131         assert len(values) == 1
132         return self.schema_format_value(attribute, values.pop())
133
134     def erase_users_computers(self, dn):
135         """Erases user and computer objects from our AD.
136
137         This is needed since the 'samldb' module denies the deletion of primary
138         groups. Therefore all groups shouldn't be primary somewhere anymore.
139         """
140
141         try:
142             res = self.search(base=dn, scope=ldb.SCOPE_SUBTREE, attrs=[],
143                       expression="(|(objectclass=user)(objectclass=computer))")
144         except ldb.LdbError, (errno, _):
145             if errno == ldb.ERR_NO_SUCH_OBJECT:
146                 # Ignore no such object errors
147                 return
148             else:
149                 raise
150
151         try:
152             for msg in res:
153                 self.delete(msg.dn, ["relax:0"])
154         except ldb.LdbError, (errno, _):
155             if errno != ldb.ERR_NO_SUCH_OBJECT:
156                 # Ignore no such object errors
157                 raise
158
159     def erase_except_schema_controlled(self):
160         """Erase this ldb.
161
162         :note: Removes all records, except those that are controlled by
163             Samba4's schema.
164         """
165
166         basedn = ""
167
168         # Try to delete user/computer accounts to allow deletion of groups
169         self.erase_users_computers(basedn)
170
171         # Delete the 'visible' records, and the invisble 'deleted' records (if
172         # this DB supports it)
173         for msg in self.search(basedn, ldb.SCOPE_SUBTREE,
174                        "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
175                        [], controls=["show_deleted:0", "show_recycled:0"]):
176             try:
177                 self.delete(msg.dn, ["relax:0"])
178             except ldb.LdbError, (errno, _):
179                 if errno != ldb.ERR_NO_SUCH_OBJECT:
180                     # Ignore no such object errors
181                     raise
182
183         res = self.search(basedn, ldb.SCOPE_SUBTREE,
184             "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
185             [], controls=["show_deleted:0", "show_recycled:0"])
186         assert len(res) == 0
187
188         # delete the specials
189         for attr in ["@SUBCLASSES", "@MODULES",
190                      "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
191             try:
192                 self.delete(attr, ["relax:0"])
193             except ldb.LdbError, (errno, _):
194                 if errno != ldb.ERR_NO_SUCH_OBJECT:
195                     # Ignore missing dn errors
196                     raise
197
198     def erase(self):
199         """Erase this ldb, removing all records."""
200         self.erase_except_schema_controlled()
201
202         # delete the specials
203         for attr in ["@INDEXLIST", "@ATTRIBUTES"]:
204             try:
205                 self.delete(attr, ["relax:0"])
206             except ldb.LdbError, (errno, _):
207                 if errno != ldb.ERR_NO_SUCH_OBJECT:
208                     # Ignore missing dn errors
209                     raise
210
211     def load_ldif_file_add(self, ldif_path):
212         """Load a LDIF file.
213
214         :param ldif_path: Path to LDIF file.
215         """
216         self.add_ldif(open(ldif_path, 'r').read())
217
218     def add_ldif(self, ldif, controls=None):
219         """Add data based on a LDIF string.
220
221         :param ldif: LDIF text.
222         """
223         for changetype, msg in self.parse_ldif(ldif):
224             assert changetype == ldb.CHANGETYPE_NONE
225             self.add(msg, controls)
226
227     def modify_ldif(self, ldif, controls=None):
228         """Modify database based on a LDIF string.
229
230         :param ldif: LDIF text.
231         """
232         for changetype, msg in self.parse_ldif(ldif):
233             if changetype == ldb.CHANGETYPE_ADD:
234                 self.add(msg, controls)
235             else:
236                 self.modify(msg, controls)
237
238
239 def substitute_var(text, values):
240     """Substitute strings of the form ${NAME} in str, replacing
241     with substitutions from values.
242
243     :param text: Text in which to subsitute.
244     :param values: Dictionary with keys and values.
245     """
246
247     for (name, value) in values.items():
248         assert isinstance(name, str), "%r is not a string" % name
249         assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
250         text = text.replace("${%s}" % name, value)
251
252     return text
253
254
255 def check_all_substituted(text):
256     """Check that all substitution variables in a string have been replaced.
257
258     If not, raise an exception.
259
260     :param text: The text to search for substitution variables
261     """
262     if not "${" in text:
263         return
264
265     var_start = text.find("${")
266     var_end = text.find("}", var_start)
267
268     raise Exception("Not all variables substituted: %s" %
269         text[var_start:var_end+1])
270
271
272 def read_and_sub_file(file_name, subst_vars):
273     """Read a file and sub in variables found in it
274
275     :param file_name: File to be read (typically from setup directory)
276      param subst_vars: Optional variables to subsitute in the file.
277     """
278     data = open(file_name, 'r').read()
279     if subst_vars is not None:
280         data = substitute_var(data, subst_vars)
281         check_all_substituted(data)
282     return data
283
284
285 def setup_file(template, fname, subst_vars=None):
286     """Setup a file in the private dir.
287
288     :param template: Path of the template file.
289     :param fname: Path of the file to create.
290     :param subst_vars: Substitution variables.
291     """
292     if os.path.exists(fname):
293         os.unlink(fname)
294
295     data = read_and_sub_file(template, subst_vars)
296     f = open(fname, 'w')
297     try:
298         f.write(data)
299     finally:
300         f.close()
301
302 MAX_NETBIOS_NAME_LEN = 15
303 def is_valid_netbios_char(c):
304     return (c.isalnum() or c in " !#$%&'()-.@^_{}~")
305
306
307 def valid_netbios_name(name):
308     """Check whether a name is valid as a NetBIOS name. """
309     # See crh's book (1.4.1.1)
310     if len(name) > MAX_NETBIOS_NAME_LEN:
311         return False
312     for x in name:
313         if not is_valid_netbios_char(x):
314             return False
315     return True
316
317
318 def import_bundled_package(modulename, location, source_tree_container,
319                            namespace):
320     """Import the bundled version of a package.
321
322     :note: This should only be called if the system version of the package
323         is not adequate.
324
325     :param modulename: Module name to import
326     :param location: Location to add to sys.path (can be relative to
327         ${srcdir}/${source_tree_container})
328     :param source_tree_container: Directory under source root that
329         contains the bundled third party modules.
330     :param namespace: Namespace to import module from, when not in source tree
331     """
332     if in_source_tree():
333         extra_path = os.path.join(source_tree_topdir(), source_tree_container,
334             location)
335         if not extra_path in sys.path:
336             sys.path.insert(0, extra_path)
337         sys.modules[modulename] = __import__(modulename)
338     else:
339         sys.modules[modulename] = __import__(
340             "%s.%s" % (namespace, modulename), fromlist=[namespace])
341
342
343 def ensure_third_party_module(modulename, location):
344     """Add a location to sys.path if a third party dependency can't be found.
345
346     :param modulename: Module name to import
347     :param location: Location to add to sys.path (can be relative to
348         ${srcdir}/third_party)
349     """
350     try:
351         __import__(modulename)
352     except ImportError:
353         import_bundled_package(modulename, location,
354             source_tree_container="third_party",
355             namespace="samba.third_party")
356
357
358 def dn_from_dns_name(dnsdomain):
359     """return a DN from a DNS name domain/forest root"""
360     return "DC=" + ",DC=".join(dnsdomain.split("."))
361
362 def current_unix_time():
363     return int(time.time())
364
365 import _glue
366 version = _glue.version
367 interface_ips = _glue.interface_ips
368 set_debug_level = _glue.set_debug_level
369 get_debug_level = _glue.get_debug_level
370 unix2nttime = _glue.unix2nttime
371 nttime2string = _glue.nttime2string
372 nttime2unix = _glue.nttime2unix
373 unix2nttime = _glue.unix2nttime
374 generate_random_password = _glue.generate_random_password
375 strcasecmp_m = _glue.strcasecmp_m
376 strstr_m = _glue.strstr_m