# 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/>.

import ifcopenshell
import ifcopenshell.api
import ifcopenshell.util.element


class Usecase:
    def __init__(self, file, product=None):
        """Unassigns a product from its aggregate

        A product (i.e. a smaller part of a whole) may be aggregated into zero
        or one larger space or element. This function will remove that
        aggregation relationship.

        As all physical IFC model elements must be part of a hierarchical tree
        called the "spatial decomposition", using this function will remove the
        product from that tree. This is a dangerous operation and may result in
        the product no longer being visible in IFC applications.

        If the product is not part of an aggregation relationship, nothing will
        happen.

        :param product: The part of the aggregate, typically an IfcElement or
            IfcSpatialStructureElement subclass
        :type product: ifcopenshell.entity_instance.entity_instance
        :return: The IfcRelAggregate relationship instance, only returned if the
            whole still contains any other parts.
        :rtype: ifcopenshell.entity_instance.entity_instance, None

        Example:

        .. code:: python

            element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
            subelement1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
            subelement2 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")
            ifcopenshell.api.run("aggregate.assign_object", model, product=subelement1, relating_object=element)
            ifcopenshell.api.run("aggregate.assign_object", model, product=subelement2, relating_object=element)
            # The relationship is returned as element still has subelement2
            rel = ifcopenshell.api.run("aggregate.unassign_object", model, product=subelement1)
            # Nothing is returned, as element is now empty
            ifcopenshell.api.run("aggregate.unassign_object", model, product=subelement2)
        """
        self.file = file
        self.settings = { "product": product }

    def execute(self):
        for rel in self.settings["product"].Decomposes or []:
            if not rel.is_a("IfcRelAggregates"):
                continue
            if len(rel.RelatedObjects) == 1:
                history = rel.OwnerHistory
                self.file.remove(rel)
                if history:
                    ifcopenshell.util.element.remove_deep2(self.file, history)
                return
            related_objects = list(rel.RelatedObjects)
            related_objects.remove(self.settings["product"])
            rel.RelatedObjects = related_objects
            ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
            return rel