Skip to content

Home Information - Your home, your data, organized.

Python
3.1 KB
Raw Blame
from hi.apps.entity.models import Entity, EntityView, EntityPosition, EntityPath
from hi.apps.collection.models import CollectionEntity


class EditViewHelpers:
    """
    Helper utilities for edit mode functionality across all modules.

    Centralizes unused detection logic and other edit-mode utilities to avoid
    circular dependencies between modules. Since this is in the general edit
    module, it can safely depend on entity and collection modules.
    """

    @staticmethod
    def get_unused_entity_ids() -> set:
        """
        Return entity IDs that are neither visible in any location view
        nor in any collection.

        An entity is considered "unused" if it's not accessible through:
        1. Being visible in any location view (has EntityView AND EntityPosition/EntityPath)
        2. Membership in any collection (CollectionEntity)

        For efficiency, we approximate visibility as: has EntityView AND has EntityPosition OR EntityPath
        This may include some entities that aren't truly visible but is much faster to calculate.
        """
        # Get entities that have EntityView records (are in some view)
        in_view_ids = set(EntityView.objects.values_list('entity_id', flat=True))

        # Get entities that have position or path records
        positioned_ids = set(EntityPosition.objects.values_list('entity_id', flat=True))
        pathed_ids = set(EntityPath.objects.values_list('entity_id', flat=True))
        has_location_data_ids = positioned_ids | pathed_ids

        # Potentially visible = in a view AND has location data
        potentially_visible_ids = in_view_ids & has_location_data_ids

        # Get entities that are in any collection
        collection_member_ids = set(CollectionEntity.objects.values_list('entity_id', flat=True))

        # Get all entity IDs
        all_entity_ids = set(Entity.objects.values_list('id', flat=True))

        # Unused = not potentially visible AND not in any collection
        accessible_ids = potentially_visible_ids | collection_member_ids
        return all_entity_ids - accessible_ids

    @staticmethod
    def is_entity_unused(entity_id: int) -> bool:
        """
        Check if a single entity is unused (not visible in any location view
        and not in any collection).

        More efficient than get_unused_entity_ids() when checking just one entity.
        """
        # Check if entity is in any view
        has_view = EntityView.objects.filter(entity_id=entity_id).exists()
        if not has_view:
            # No view, but check if in collection
            has_collection = CollectionEntity.objects.filter(entity_id=entity_id).exists()
            return not has_collection

        # Has view, check if has location data
        has_position = EntityPosition.objects.filter(entity_id=entity_id).exists()
        has_path = EntityPath.objects.filter(entity_id=entity_id).exists()

        if has_position or has_path:
            return False  # Potentially visible

        # Has view but no location data, check if in collection
        has_collection = CollectionEntity.objects.filter(entity_id=entity_id).exists()
        return not has_collection