First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,103 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of IfcOpenShell.
+#
+# IfcOpenShell is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# IfcOpenShell 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+# Note: it is the intent for you to override these with your own functions
+
+
+from typing import Union
+
+import ifcopenshell
+
+
+def get_application(ifc: ifcopenshell.file) -> Union[ifcopenshell.entity_instance, None]:
+    """Returns the application representing the authoring software
+
+    It is expected for you to overload this function with your own
+    IfcApplication. See ifcopenshell.api.owner.create_owner_history for details.
+
+    :param ifc: The IFC file object that is being edited.
+    :return: The IfcApplication with metadata of the authoring software.
+    """
+    app = next(iter(ifc.by_type("IfcApplication")), None)
+    if not app and ifc.schema == "IFC2X3":
+        raise Exception(
+            "Please create an application to continue. See the owner.create_owner_history docs for more info."
+            "https://docs.ifcopenshell.org/autoapi/ifcopenshell/api/owner/create_owner_history/index.html"
+        )
+    return app
+
+
+def get_user(ifc: ifcopenshell.file) -> Union[ifcopenshell.entity_instance, None]:
+    """Returns the active authoring user
+
+    It is expected for you to overload this function with your own
+    IfcApplication. See ifcopenshell.api.owner.create_owner_history for details.
+
+    :param ifc: The IFC file object that is being edited.
+    :return: The IfcPersonAndOrganization with metadata of the authoring user.
+    """
+    pao = next(iter(ifc.by_type("IfcPersonAndOrganization")), None)
+    if not pao and ifc.schema == "IFC2X3":
+        raise Exception(
+            "Please create a user to continue. See the owner.create_owner_history docs for more info."
+            "https://docs.ifcopenshell.org/autoapi/ifcopenshell/api/owner/create_owner_history/index.html"
+        )
+    return pao
+
+
+get_application_factory = get_application
+get_application_backup = get_application
+get_user_factory = get_user
+get_user_backup = get_user
+
+
+def factory_reset():
+    """Reset the get_user and get_application functions to what came out of box
+
+    When you are developing a custom application, you will typically override
+    the get_user and get_application function to your own needs. Sometimes you
+    want to reset it to before you monkey-patched it. This function does that
+    reset.
+    """
+    global get_application_factory
+    global get_application_backup
+    global get_application
+    global get_user_factory
+    global get_user_backup
+    global get_user
+    get_application_backup = get_application
+    get_application = get_application_factory
+    get_user_backup = get_user
+    get_user = get_user_factory
+
+
+def restore():
+    """Restore the get_user and get_application function prior to a reset
+
+    In case you want to restore the monkey-patched version of get_user and
+    get_application that existed before you applied a factory_reset(), this
+    function will do that.
+    """
+    global get_application_factory
+    global get_application_backup
+    global get_application
+    global get_user_factory
+    global get_user_backup
+    global get_user
+    get_application = get_application_backup
+    get_user = get_user_backup