r26538: Pass path generation function around rather than base directory.
[ira/wip.git] / source / scripting / python / samba / __init__.py
1 #!/usr/bin/python
2
3 # Unix SMB/CIFS implementation.
4 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
5 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
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 import os
22
23 def _in_source_tree():
24     """Check whether the script is being run from the source dir. """
25     return os.path.exists("%s/../../../samba4-skip" % os.path.dirname(__file__))
26
27
28 # When running, in-tree, make sure bin/python is in the PYTHONPATH
29 if _in_source_tree():
30     import sys
31     srcdir = "%s/../../.." % os.path.dirname(__file__)
32     sys.path.append("%s/bin/python" % srcdir)
33     default_ldb_modules_dir = "%s/bin/modules/ldb" % srcdir
34
35
36 import ldb
37 import credentials
38 import misc
39
40 class Ldb(ldb.Ldb):
41     """Simple Samba-specific LDB subclass that takes care 
42     of setting up the modules dir, credentials pointers, etc.
43     
44     Please note that this is intended to be for all Samba LDB files, 
45     not necessarily the Sam database. For Sam-specific helper 
46     functions see samdb.py.
47     """
48     def __init__(self, url=None, session_info=None, credentials=None, 
49                  modules_dir=None, lp=None):
50         """Open a Samba Ldb file. 
51
52         :param url: Optional LDB URL to open
53         :param session_info: Optional session information
54         :param credentials: Optional credentials, defaults to anonymous.
55         :param modules_dir: Modules directory, if not the default.
56         :param lp: Loadparm object, optional.
57
58         This is different from a regular Ldb file in that the Samba-specific
59         modules-dir is used by default and that credentials and session_info 
60         can be passed through (required by some modules).
61         """
62         super(Ldb, self).__init__()
63
64         if modules_dir is not None:
65             self.set_modules_dir(modules_dir)
66         elif default_ldb_modules_dir is not None:
67             self.set_modules_dir(default_ldb_modules_dir)
68
69         if credentials is not None:
70             self.set_credentials(self, credentials)
71
72         if session_info is not None:
73             self.set_session_info(self, session_info)
74
75         if lp is not None:
76             self.set_loadparm(self, lp)
77
78         def msg(l,text):
79             print text
80         #self.set_debug(msg)
81
82         if url is not None:
83             self.connect(url)
84
85
86     set_credentials = misc.ldb_set_credentials
87     set_session_info = misc.ldb_set_session_info
88     set_loadparm = misc.ldb_set_loadparm
89
90     def searchone(self, basedn, attribute, expression=None, 
91                   scope=ldb.SCOPE_BASE):
92         """Search for one attribute as a string."""
93         res = self.search(basedn, scope, expression, [attribute])
94         if len(res) != 1 or res[0][attribute] is None:
95             return None
96         values = set(res[0][attribute])
97         assert len(values) == 1
98         return values.pop()
99
100     def erase(self):
101         """Erase an ldb, removing all records."""
102         # delete the specials
103         for attr in ["@INDEXLIST", "@ATTRIBUTES", "@SUBCLASSES", "@MODULES", 
104                      "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
105             try:
106                 self.delete(ldb.Dn(self, attr))
107             except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
108                 # Ignore missing dn errors
109                 pass
110
111         basedn = ldb.Dn(self, "")
112         # and the rest
113         for msg in self.search(basedn, ldb.SCOPE_SUBTREE, 
114                 "(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", 
115                 ["dn"]):
116             try:
117                 self.delete(msg.dn)
118             except ldb.LdbError, (LDB_ERR_NO_SUCH_OBJECT, _):
119                 # Ignor eno such object errors
120                 pass
121
122         res = self.search(basedn, ldb.SCOPE_SUBTREE, "(&(|(objectclass=*)(dn=*))(!(dn=@BASEINFO)))", ["dn"])
123         assert len(res) == 0
124
125     def erase_partitions(self):
126         """Erase an ldb, removing all records."""
127         res = self.search(ldb.Dn(self, ""), ldb.SCOPE_BASE, "(objectClass=*)", 
128                          ["namingContexts"])
129         assert len(res) == 1
130         if not "namingContexts" in res[0]:
131             return
132         for basedn in res[0]["namingContexts"]:
133             previous_remaining = 1
134             current_remaining = 0
135
136             k = 0
137             while ++k < 10 and (previous_remaining != current_remaining):
138                 # and the rest
139                 res2 = self.search(ldb.Dn(self, basedn), ldb.SCOPE_SUBTREE, "(|(objectclass=*)(dn=*))", ["dn"])
140                 previous_remaining = current_remaining
141                 current_remaining = len(res2)
142                 for msg in res2:
143                     self.delete(msg.dn)
144
145     def load_ldif_file_add(self, ldif_path):
146         """Load a LDIF file.
147
148         :param ldif_path: Path to LDIF file.
149         """
150         self.load_ldif_add(open(ldif_path, 'r').read())
151
152     def load_ldif_add(self, ldif):
153         for changetype, msg in self.parse_ldif(ldif):
154             assert changetype == ldb.CHANGETYPE_NONE
155             self.add(msg)
156
157
158 def substitute_var(text, values):
159     """substitute strings of the form ${NAME} in str, replacing
160     with substitutions from subobj.
161     
162     :param text: Text in which to subsitute.
163     :param values: Dictionary with keys and values.
164     """
165
166     for (name, value) in values.items():
167         assert isinstance(name, str), "%r is not a string" % name
168         assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
169         text = text.replace("${%s}" % name, value)
170
171     return text
172
173
174 def valid_netbios_name(name):
175     """Check whether a name is valid as a NetBIOS name. """
176     # FIXME: There are probably more constraints here. 
177     # crh has a paragraph on this in his book (1.4.1.1)
178     if len(name) > 13:
179         return False
180     return True
181
182 version = misc.version