"""Provide a way to connect devices to one physical location.""" import logging import uuid from collections import OrderedDict from typing import List, Optional import attr from homeassistant.core import callback from homeassistant.loader import bind_hass _LOGGER = logging.getLogger(__name__) DATA_REGISTRY = 'area_registry' STORAGE_KEY = 'core.area_registry' STORAGE_VERSION = 1 SAVE_DELAY = 10 @attr.s(slots=True, frozen=True) class AreaEntry: """Area Registry Entry.""" name = attr.ib(type=str, default=None) id = attr.ib(type=str, default=attr.Factory(lambda: uuid.uuid4().hex)) class AreaRegistry: """Class to hold a registry of areas.""" def __init__(self, hass) -> None: """Initialize the area registry.""" self.hass = hass self.areas = None self._store = hass.helpers.storage.Store(STORAGE_VERSION, STORAGE_KEY) @callback def async_list_areas(self) -> List[AreaEntry]: """Get all areas.""" return self.areas.values() @callback def async_create(self, name: str) -> AreaEntry: """Create a new area.""" if self._async_is_registered(name): raise ValueError('Name is already in use') area = AreaEntry() self.areas[area.id] = area return self.async_update(area.id, name=name) async def async_delete(self, area_id: str) -> None: """Delete area.""" device_registry = await \ self.hass.helpers.device_registry.async_get_registry() device_registry.async_clear_area_id(area_id) del self.areas[area_id] self.async_schedule_save() @callback def async_update(self, area_id: str, name: str) -> AreaEntry: """Update name of area.""" old = self.areas[area_id] changes = {} if name == old.name: return old if self._async_is_registered(name): raise ValueError('Name is already in use') else: changes['name'] = name new = self.areas[area_id] = attr.evolve(old, **changes) self.async_schedule_save() return new @callback def _async_is_registered(self, name) -> Optional[AreaEntry]: """Check if a name is currently registered.""" for area in self.areas.values(): if name == area.name: return area return False async def async_load(self) -> None: """Load the area registry.""" data = await self._store.async_load() areas = OrderedDict() if data is not None: for area in data['areas']: areas[area['id']] = AreaEntry( name=area['name'], id=area['id'] ) self.areas = areas @callback def async_schedule_save(self) -> None: """Schedule saving the area registry.""" self._store.async_delay_save(self._data_to_save, SAVE_DELAY) @callback def _data_to_save(self) -> dict: """Return data of area registry to store in a file.""" data = {} data['areas'] = [ { 'name': entry.name, 'id': entry.id, } for entry in self.areas.values() ] return data @bind_hass async def async_get_registry(hass) -> AreaRegistry: """Return area registry instance.""" task = hass.data.get(DATA_REGISTRY) if task is None: async def _load_reg(): registry = AreaRegistry(hass) await registry.async_load() return registry task = hass.data[DATA_REGISTRY] = hass.async_create_task(_load_reg()) return await task