VERSION: Bump version number up to 4.0.4.
[samba.git] / source4 / scripting / python / samba / schema.py
index f702e9829fa56bff33c40c3320218f8042cd9ba2..5c8f506f26e757ab542cd7bbf42e601a3ddfa5fa 100644 (file)
@@ -6,19 +6,16 @@
 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2008-2009
 # Copyright (C) Oliver Liebel <oliver@itc.li> 2008-2009
 #
-# Based on the original in EJS:
-# Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
-#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 3 of the License, or
 # (at your option) any later version.
-#   
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
-#   
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """Functions for setting up a Samba Schema."""
 
 from base64 import b64encode
-from ms_schema import read_ms_schema
-from samba.dcerpc import security
 from samba import read_and_sub_file, substitute_var, check_all_substituted
-from samba import Ldb
+from samba.dcerpc import security
+from samba.ms_schema import read_ms_schema
 from samba.ndr import ndr_pack
-from ldb import SCOPE_SUBTREE, SCOPE_ONELEVEL, SCOPE_BASE
+from samba.samdb import SamDB
+from samba import dsdb
+from ldb import SCOPE_SUBTREE, SCOPE_ONELEVEL
 import os
 
-def get_schema_descriptor(domain_sid):
-    sddl = "O:SAG:SAD:AI(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c" \
-           ";;ER)(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;ER)(OA;;CR;1131f6ad-9c07-1" \
-           "1d1-f79f-00c04fc2dcd2;;ER)(OA;;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;SA)(O" \
-           "A;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;BA)(OA;;CR;1131f6aa-9c07-11d1-f79" \
-           "f-00c04fc2dcd2;;BA)(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2;;BA)(OA;;CR;1" \
-           "131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;BA)(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04" \
-           "fc2dcd2;;BA)(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ED)(OA;;CR;1131f6aa" \
-           "-9c07-11d1-f79f-00c04fc2dcd2;;ED)(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2" \
-           ";;ED)(OA;;CR;1131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;ED)(OA;;CR;1131f6ad-9c07-1" \
-           "1d1-f79f-00c04fc2dcd2;;ED)(A;;RPWPCCDCLCLORCWOWDSDDTSW;;;LA)(A;CI;RPWPCRCCLCL" \
-           "ORCWOWDSW;;;SA)(A;CI;RPLCLORC;;;AU)(A;CI;RPWPCRCCDCLCLORCWOWDSDDTSW;;;SY)S:(O" \
-           "U;SA;CR;45ec5156-db7e-47bb-b53f-dbeb2d03c40f;;WD)(OU;SA;CR;e12b56b6-0a95-11d1" \
-           "-adbb-00c04fd8d5cd;;WD)(AU;SA;CR;;;DU)(AU;SA;CR;;;BA)(AU;SA;WPCCDCWOWDSDDTSW;" \
-           ";;WD)(AU;CISA;WP;;;WD)"
+def get_schema_descriptor(domain_sid, name_map={}):
+    sddl = "O:SAG:SAD:AI(OA;;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;SA)" \
+           "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
+           "(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
+           "(OA;;CR;1131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
+           "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
+           "(OA;;CR;1131f6ab-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
+           "(OA;;CR;1131f6ac-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
+           "(A;CI;RPLCLORC;;;AU)" \
+           "(A;CI;RPWPCRCCLCLORCWOWDSW;;;SA)" \
+           "(A;CI;RPWPCRCCDCLCLORCWOWDSDDTSW;;;SY)" \
+           "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;ED)" \
+           "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ED)" \
+           "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;BA)" \
+           "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;BA)" \
+           "(OA;;CR;1131f6aa-9c07-11d1-f79f-00c04fc2dcd2;;ER)" \
+           "(OA;;CR;1131f6ad-9c07-11d1-f79f-00c04fc2dcd2;;ER)" \
+           "(OA;;CR;89e95b76-444d-4c62-991a-0facbeda640c;;ER)" \
+           "S:(AU;SA;WPCCDCWOWDSDDTSW;;;WD)" \
+           "(AU;CISA;WP;;;WD)" \
+           "(AU;SA;CR;;;BA)" \
+           "(AU;SA;CR;;;DU)" \
+           "(OU;SA;CR;e12b56b6-0a95-11d1-adbb-00c04fd8d5cd;;WD)" \
+           "(OU;SA;CR;45ec5156-db7e-47bb-b53f-dbeb2d03c40f;;WD)"
     sec = security.descriptor.from_sddl(sddl, domain_sid)
     return ndr_pack(sec)
 
-   
+
 class Schema(object):
-    def __init__(self, setup_path, domain_sid, schemadn=None,
-                 serverdn=None, files=None, prefixmap=None):
-        """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
-        
+
+    def __init__(self, domain_sid, invocationid=None, schemadn=None,
+                 files=None, override_prefixmap=None, additional_prefixmap=None):
+        from samba.provision import setup_path
+
+        """Load schema for the SamDB from the AD schema files and
+        samba4_schema.ldif
+
         :param samdb: Load a schema into a SamDB.
-        :param setup_path: Setup path function.
         :param schemadn: DN of the schema
-        :param serverdn: DN of the server
-        
-        Returns the schema data loaded, to avoid double-parsing when then needing to add it to the db
+
+        Returns the schema data loaded, to avoid double-parsing when then
+        needing to add it to the db
         """
 
         self.schemadn = schemadn
-        self.ldb = Ldb()
-        self.schema_data = read_ms_schema(setup_path('ad-schema/MS-AD_Schema_2K8_R2_Attributes.txt'),
-                                          setup_path('ad-schema/MS-AD_Schema_2K8_R2_Classes.txt'))
+        # We need to have the am_rodc=False just to keep some warnings quiet -
+        # this isn't a real SAM, so it's meaningless.
+        self.ldb = SamDB(global_schema=False, am_rodc=False)
+        if invocationid is not None:
+            self.ldb.set_invocation_id(invocationid)
+
+        self.schema_data = read_ms_schema(
+            setup_path('ad-schema/MS-AD_Schema_2K8_R2_Attributes.txt'),
+            setup_path('ad-schema/MS-AD_Schema_2K8_R2_Classes.txt'))
 
         if files is not None:
             for file in files:
                 self.schema_data += open(file, 'r').read()
 
-        self.schema_data = substitute_var(self.schema_data, {"SCHEMADN": schemadn})
+        self.schema_data = substitute_var(self.schema_data,
+            {"SCHEMADN": schemadn})
         check_all_substituted(self.schema_data)
 
-        self.schema_dn_modify = read_and_sub_file(setup_path("provision_schema_basedn_modify.ldif"),
-                                                  {"SCHEMADN": schemadn,
-                                                   "SERVERDN": serverdn,
-                                                   })
+        self.schema_dn_modify = read_and_sub_file(
+            setup_path("provision_schema_basedn_modify.ldif"),
+            {"SCHEMADN": schemadn})
 
         descr = b64encode(get_schema_descriptor(domain_sid))
-        self.schema_dn_add = read_and_sub_file(setup_path("provision_schema_basedn.ldif"),
-                                               {"SCHEMADN": schemadn,
-                                                "DESCRIPTOR": descr
-                                                })
+        self.schema_dn_add = read_and_sub_file(
+            setup_path("provision_schema_basedn.ldif"),
+            {"SCHEMADN": schemadn, "DESCRIPTOR": descr})
 
-        self.prefixmap_data = open(setup_path("prefixMap.txt"), 'r').read()
+        if override_prefixmap is not None:
+            self.prefixmap_data = override_prefixmap
+        else:
+            self.prefixmap_data = open(setup_path("prefixMap.txt"), 'r').read()
 
-        if prefixmap is not None:
-            for map in prefixmap:
+        if additional_prefixmap is not None:
+            for map in additional_prefixmap:
                 self.prefixmap_data += "%s\n" % map
 
         self.prefixmap_data = b64encode(self.prefixmap_data)
 
-        
-
         # We don't actually add this ldif, just parse it
-        prefixmap_ldif = "dn: cn=schema\nprefixMap:: %s\n\n" % self.prefixmap_data
-        self.ldb.set_schema_from_ldif(prefixmap_ldif, self.schema_data)
+        prefixmap_ldif = "dn: %s\nprefixMap:: %s\n\n" % (self.schemadn, self.prefixmap_data)
+        self.set_from_ldif(prefixmap_ldif, self.schema_data, self.schemadn)
+
+    def set_from_ldif(self, pf, df, dn):
+        dsdb._dsdb_set_schema_from_ldif(self.ldb, pf, df, dn)
 
     def write_to_tmp_ldb(self, schemadb_path):
-        self.ldb.connect(schemadb_path)
+        self.ldb.connect(url=schemadb_path)
         self.ldb.transaction_start()
-    
-        self.ldb.add_ldif("""dn: @ATTRIBUTES
+        try:
+            self.ldb.add_ldif("""dn: @ATTRIBUTES
 linkID: INTEGER
 
 dn: @INDEXLIST
 @IDXATTR: linkID
 @IDXATTR: attributeSyntax
 """)
-        # These bits of LDIF are supplied when the Schema object is created
-        self.ldb.add_ldif(self.schema_dn_add)
-        self.ldb.modify_ldif(self.schema_dn_modify)
-        self.ldb.add_ldif(self.schema_data)
-        self.ldb.transaction_commit()
-
-    # Return a hash with the forward attribute as a key and the back as the value 
+            # These bits of LDIF are supplied when the Schema object is created
+            self.ldb.add_ldif(self.schema_dn_add)
+            self.ldb.modify_ldif(self.schema_dn_modify)
+            self.ldb.add_ldif(self.schema_data)
+        except:
+            self.ldb.transaction_cancel()
+            raise
+        else:
+            self.ldb.transaction_commit()
+
+    # Return a hash with the forward attribute as a key and the back as the
+    # value
     def linked_attributes(self):
         return get_linked_attributes(self.schemadn, self.ldb)
 
     def dnsyntax_attributes(self):
         return get_dnsyntax_attributes(self.schemadn, self.ldb)
 
-# Return a hash with the forward attribute as a key and the back as the value 
+    def convert_to_openldap(self, target, mapping):
+        return dsdb._dsdb_convert_schema_to_openldap(self.ldb, target, mapping)
+
+
+# Return a hash with the forward attribute as a key and the back as the value
 def get_linked_attributes(schemadn,schemaldb):
     attrs = ["linkID", "lDAPDisplayName"]
     res = schemaldb.search(expression="(&(linkID=*)(!(linkID:1.2.840.113556.1.4.803:=1))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))", base=schemadn, scope=SCOPE_ONELEVEL, attrs=attrs)
     attributes = {}
     for i in range (0, len(res)):
         expression = "(&(objectclass=attributeSchema)(linkID=%d)(attributeSyntax=2.5.5.1))" % (int(res[i]["linkID"][0])+1)
-        target = schemaldb.searchone(basedn=schemadn, 
-                                     expression=expression, 
-                                     attribute="lDAPDisplayName", 
+        target = schemaldb.searchone(basedn=schemadn,
+                                     expression=expression,
+                                     attribute="lDAPDisplayName",
                                      scope=SCOPE_SUBTREE)
         if target is not None:
             attributes[str(res[i]["lDAPDisplayName"])]=str(target)
-            
+
     return attributes
 
+
 def get_dnsyntax_attributes(schemadn,schemaldb):
-    attrs = ["linkID", "lDAPDisplayName"]
-    res = schemaldb.search(expression="(&(!(linkID=*))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))", base=schemadn, scope=SCOPE_ONELEVEL, attrs=attrs)
+    res = schemaldb.search(
+        expression="(&(!(linkID=*))(objectclass=attributeSchema)(attributeSyntax=2.5.5.1))",
+        base=schemadn, scope=SCOPE_ONELEVEL,
+        attrs=["linkID", "lDAPDisplayName"])
     attributes = []
     for i in range (0, len(res)):
         attributes.append(str(res[i]["lDAPDisplayName"]))
-        
     return attributes
 
-def ldb_with_schema(setup_dir=None, schemadn="cn=schema,cn=configuration,dc=example,dc=com", 
-                    serverdn="cn=server,cn=servers,cn=default-first-site-name,cn=sites,cn=cn=configuration,dc=example,dc=com",
-                    domainsid=None):
+
+def ldb_with_schema(schemadn="cn=schema,cn=configuration,dc=example,dc=com",
+                    domainsid=None,
+                    override_prefixmap=None):
     """Load schema for the SamDB from the AD schema files and samba4_schema.ldif
-    
-    :param setup_dir: Setup path
+
     :param schemadn: DN of the schema
     :param serverdn: DN of the server
-    
+
     Returns the schema data loaded as an object, with .ldb being a
     new ldb with the schema loaded.  This allows certain tests to
     operate without a remote or local schema.
     """
-    
-    def setup_path(file):
-        return os.path.join(setup_dir, file)
 
     if domainsid is None:
         domainsid = security.random_sid()
     else:
         domainsid = security.dom_sid(domainsid)
-    return Schema(setup_path, domainsid, schemadn=schemadn, serverdn=serverdn)
+    return Schema(domainsid, schemadn=schemadn,
+        override_prefixmap=override_prefixmap)