Refactor ownership history system to be simpler and just a usecase. See #1399.

src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py

@@ -1,6 +1,6 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase:
@@ -32,7 +32,7 @@ class Usecase:
             related_objects.remove(self.settings["product"])
             if related_objects:
                 decomposes.RelatedObjects = related_objects
-                update_owner_history(decomposes)
+                update_owner_history.Usecase(self.file, {"element": decomposes}).execute()
             else:
                 self.file.remove(decomposes)
 
@@ -40,13 +40,13 @@ class Usecase:
             related_objects = list(is_decomposed_by.RelatedObjects)
             related_objects.append(self.settings["product"])
             is_decomposed_by.RelatedObjects = related_objects
-            update_owner_history(is_decomposed_by)
+            update_owner_history.Usecase(self.file, {"element": is_decomposed_by}).execute()
         else:
             is_decomposed_by = self.file.create_entity(
                 "IfcRelAggregates",
                 **{
                     "GlobalId": ifcopenshell.guid.new(),
-                    "OwnerHistory": create_owner_history(),
+                    "OwnerHistory": create_owner_history.Usecase(self.file).execute(),
                     "RelatedObjects": [self.settings["product"]],
                     "RelatingObject": self.settings["relating_object"],
                 }

src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py

@@ -1,4 +1,4 @@
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase():
@@ -15,4 +15,4 @@ class Usecase():
         for name, value in self.settings["attributes"].items():
             setattr(self.settings["product"], name, value)
         if hasattr(self.settings["product"], "OwnerHistory"):
-            update_owner_history(self.settings["product"])
+            update_owner_history.Usecase(self.file, {"element": self.settings["product"]}).execute()

src/ifcopenshell-python/ifcopenshell/api/group/add_group.py

@@ -1,5 +1,5 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
 
 
 class Usecase:
@@ -12,6 +12,6 @@ class Usecase:
     def execute(self):
         return self.file.create_entity("IfcGroup", **{
             "GlobalId": ifcopenshell.guid.new(),
-            "OwnerHistory": create_owner_history(),
+            "OwnerHistory": create_owner_history.Usecase(self.file).execute(),
             "Name": "Unnamed"
         })

src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py

@@ -1,6 +1,6 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase:
@@ -17,7 +17,7 @@ class Usecase:
         if not self.settings["group"].IsGroupedBy:
             return self.file.create_entity("IfcRelAssignsToGroup", **{
                 "GlobalId": ifcopenshell.guid.new(),
-                "OwnerHistory": create_owner_history(),
+                "OwnerHistory": create_owner_history.Usecase(self.file).execute(),
                 "RelatedObjects": [self.settings["product"]],
                 "RelatingGroup": self.settings["group"]
             })
@@ -25,4 +25,4 @@ class Usecase:
         related_objects = set(rel.RelatedObjects) or set()
         related_objects.add(self.settings["product"])
         rel.RelatedObjects = list(related_objects)
-        update_owner_history(rel)
+        update_owner_history.Usecase(self.file, {"element": rel}).execute()

src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py

@@ -1,5 +1,5 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase:
@@ -20,6 +20,6 @@ class Usecase:
         related_objects.remove(self.settings["product"])
         if len(related_objects):
             rel.RelatedObjects = list(related_objects)
-            update_owner_history(rel)
+            update_owner_history.Usecase(self.file, {"element": rel}).execute()
         else:
             self.file.remove(rel)

src/ifcopenshell-python/ifcopenshell/api/owner/add_organisation.py

@@ -1,6 +1,12 @@
 class Usecase:
-    def __init__(self, file):
+    def __init__(self, file, settings={}):
         self.file = file
+        self.settings = {
+            "Identification": "APTR",
+            "Name": "Aperture Science",
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
 
     def execute(self):
-        self.file.createIfcOrganization("APTR", "Aperture Science")
+        return self.file.create_entity("IfcOrganization", **self.settings)

src/ifcopenshell-python/ifcopenshell/api/owner/add_person.py

@@ -1,6 +1,13 @@
 class Usecase:
-    def __init__(self, file):
+    def __init__(self, file, settings={}):
         self.file = file
+        self.settings = {
+            "Identification": "HSeldon",
+            "FamilyName": "Seldon",
+            "GivenName": "Hari",
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
 
     def execute(self):
-        self.file.createIfcPerson("HSeldon", "Seldon", "Hari")
+        return self.file.create_entity("IfcPerson", **self.settings)

src/ifcopenshell-python/ifcopenshell/api/owner/api.py

@@ -1,62 +0,0 @@
-import bpy
-import time
-import addon_utils
-import ifcopenshell.api.owner.create_owner_history as create_owner_history_usecase
-import ifcopenshell.api.owner.update_owner_history as update_owner_history_usecase
-from blenderbim.bim.ifc import IfcStore
-
-
-def update_owner_history(element, change_action=None):
-    if not element.OwnerHistory:
-        element.OwnerHistory = create_owner_history()
-        return
-    file = IfcStore.get_file()
-    return update_owner_history_usecase.Usecase(
-        file,
-        {
-            "element": element,
-            "person": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_person)),
-            "organisation": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_organisation)),
-            "ApplicationIdentifier": "BlenderBIM",
-            "ApplicationFullName": "BlenderBIM Add-on",
-            "Version": get_application_version(),
-            "ChangeAction": change_action or "MODIFIED",
-        },
-    ).execute()
-
-
-def create_owner_history(change_action=None):
-    file = IfcStore.get_file()
-
-    if (
-        not bpy.context.scene.BIMOwnerProperties.user_person
-        or not bpy.context.scene.BIMOwnerProperties.user_organisation
-    ):
-        if file.schema == "IFC2X3":
-            assert False, "A person and organisation is required in IFC2X3."
-        return None
-
-    return create_owner_history_usecase.Usecase(
-        file,
-        {
-            "person": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_person)),
-            "organisation": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_organisation)),
-            "ApplicationIdentifier": "BlenderBIM",
-            "ApplicationFullName": "BlenderBIM Add-on",
-            "Version": get_application_version(),
-            "ChangeAction": change_action or "ADDED",
-        },
-    ).execute()
-
-
-def get_application_version():
-    return ".".join(
-        [
-            str(x)
-            for x in [
-                addon.bl_info.get("version", (-1, -1, -1))
-                for addon in addon_utils.modules()
-                if addon.bl_info["name"] == "BlenderBIM"
-            ][0]
-        ]
-    )

src/ifcopenshell-python/ifcopenshell/api/owner/create_owner_history.py

@@ -1,22 +1,19 @@
 import time
 import ifcopenshell
+import ifcopenshell.api.owner.settings
 
 
 class Usecase:
     def __init__(self, file, settings={}):
         self.file = file
-        self.settings = {
+        self.settings = ifcopenshell.api.owner.settings.settings
-            "person": None,
-            "organisation": None,
-            "ApplicationIdentifier": "",
-            "ApplicationFullName": "",
-            "Version": "",
-            "ChangeAction": "NOTDEFINED",
-        }
         for key, value in settings.items():
             self.settings[key] = value
 
     def execute(self):
+        if self.file.schema != "IFC2X3":
+            if not self.settings["person"] or not self.settings["organisation"]:
+                return
         user = self.get_user()
         application = self.get_application()
         return self.file.create_entity(
@@ -25,7 +22,7 @@ class Usecase:
                 "OwningUser": user,
                 "OwningApplication": application,
                 "State": "READWRITE",
-                "ChangeAction": self.settings["ChangeAction"],
+                "ChangeAction": self.settings["ChangeAction"] or "ADDED",
                 "LastModifiedDate": int(time.time()),
                 "LastModifyingUser": user,
                 "LastModifyingApplication": application,

src/ifcopenshell-python/ifcopenshell/api/owner/settings.py

@@ -0,0 +1,33 @@
+# import bpy
+# import addon_utils
+
+settings = {
+    "person": None,
+    "organisation": None,
+    "ApplicationIdentifier": "",
+    "ApplicationFullName": "",
+    "Version": "",
+    "ChangeAction": "NOTDEFINED",
+}
+
+
+# settings = {
+#     "person": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_person)),
+#     "organisation": file.by_id(int(bpy.context.scene.BIMOwnerProperties.user_organisation)),
+#     "ApplicationIdentifier": "BlenderBIM",
+#     "ApplicationFullName": "BlenderBIM Add-on",
+#     "Version": get_application_version(),
+# }
+# 
+# 
+# def get_application_version():
+#     return ".".join(
+#         [
+#             str(x)
+#             for x in [
+#                 addon.bl_info.get("version", (-1, -1, -1))
+#                 for addon in addon_utils.modules()
+#                 if addon.bl_info["name"] == "BlenderBIM"
+#             ][0]
+#         ]
+#     )

src/ifcopenshell-python/ifcopenshell/api/owner/update_owner_history.py

@@ -1,23 +1,19 @@
 import time
 import ifcopenshell
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
 
 
 class Usecase:
     def __init__(self, file, settings={}):
         self.file = file
-        self.settings = {
+        self.settings = ifcopenshell.api.owner.settings.settings
-            "OwnerHistory": None,
-            "person": None,
-            "organisation": None,
-            "ApplicationIdentifier": "",
-            "ApplicationFullName": "",
-            "Version": "",
-            "ChangeAction": "NOTDEFINED",
-        }
         for key, value in settings.items():
             self.settings[key] = value
 
     def execute(self):
+        if not self.settings["element"].OwnerHistory:
+            self.settings["element"].OwnerHistory = create_owner_history.Usecase(self.file, self.settings).execute()
+            return
         if len(self.file.get_inverse(self.settings["element"].OwnerHistory)) > 1:
             old_history = self.settings["element"].OwnerHistory
             self.settings["element"].OwnerHistory = self.file.create_entity("IfcOwnerHistory")

src/ifcopenshell-python/ifcopenshell/api/root/create_product.py

@@ -1,5 +1,5 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
 
 
 class Usecase:
@@ -16,7 +16,7 @@ class Usecase:
     def execute(self):
         element = self.file.create_entity(self.settings["ifc_class"], **{
             "GlobalId": ifcopenshell.guid.new(),
-            "OwnerHistory": create_owner_history()
+            "OwnerHistory": create_owner_history.Usecase(self.file).execute()
         })
         element.Name = self.settings["name"] or None
         if self.settings["predefined_type"]:

src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_analysis_model.py

@@ -1,5 +1,5 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
 
 
 class Usecase:
@@ -12,7 +12,7 @@ class Usecase:
     def execute(self):
         return self.file.create_entity("IfcStructuralAnalysisModel", **{
             "GlobalId": ifcopenshell.guid.new(),
-            "OwnerHistory": create_owner_history(),
+            "OwnerHistory": create_owner_history.Usecase(self.file).execute(),
             "Name": "Unnamed",
             "PredefinedType": "LOADING_3D"
         })

src/ifcopenshell-python/ifcopenshell/api/structural/assign_structural_analysis_model.py

@@ -1,6 +1,6 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import create_owner_history
+import ifcopenshell.api.owner.create_owner_history as create_owner_history
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase:
@@ -17,7 +17,7 @@ class Usecase:
         if not self.settings["structural_analysis_model"].IsGroupedBy:
             return self.file.create_entity("IfcRelAssignsToGroup", **{
                 "GlobalId": ifcopenshell.guid.new(),
-                "OwnerHistory": create_owner_history(),
+                "OwnerHistory": create_owner_history.Usecase(self.file).execute(),
                 "RelatedObjects": [self.settings["product"]],
                 "RelatingGroup": self.settings["structural_analysis_model"]
             })
@@ -25,4 +25,4 @@ class Usecase:
         related_objects = set(rel.RelatedObjects) or set()
         related_objects.add(self.settings["product"])
         rel.RelatedObjects = list(related_objects)
-        update_owner_history(rel)
+        update_owner_history.Usecase(self.file, {"element": rel}).execute()

src/ifcopenshell-python/ifcopenshell/api/structural/unassign_structural_analysis_model.py

@@ -1,5 +1,5 @@
 import ifcopenshell
-from ifcopenshell.api.owner.api import update_owner_history
+import ifcopenshell.api.owner.update_owner_history as update_owner_history
 
 
 class Usecase:
@@ -20,6 +20,6 @@ class Usecase:
         related_objects.remove(self.settings["product"])
         if len(related_objects):
             rel.RelatedObjects = list(related_objects)
-            update_owner_history(rel)
+            update_owner_history.Usecase(self.file, {"element": rel}).execute()
         else:
             self.file.remove(rel)