core/homeassistant/components/loqed/config_flow.py

"""Config flow for loqed integration."""

import logging
import re
from typing import Any, override

import aiohttp
from loqedAPI import cloud_loqed, loqed
import voluptuous as vol

from homeassistant.components import webhook
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_API_TOKEN, CONF_WEBHOOK_ID
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo

from .const import DOMAIN

_LOGGER = logging.getLogger(__name__)


class LoqedConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a config flow for Loqed."""

    VERSION = 1
    DOMAIN = DOMAIN
    _host: str | None = None
    _locks: list[dict[str, Any]]
    _api_token: str | None = None

    def __init__(self) -> None:
        """Initialize the config flow."""
        super().__init__()
        self._locks = []

    async def validate_input(
        self, hass: HomeAssistant, data: dict[str, Any]
    ) -> dict[str, Any]:
        """Validate the user input allows us to connect."""

        session = async_get_clientsession(hass)
        if self._locks and not self._host:
            # Reuse the lock list already fetched during manual setup to
            # avoid a duplicate cloud request.
            lock_data = {"data": self._locks}
        else:
            cloud_api_client = cloud_loqed.CloudAPIClient(
                session,
                data[CONF_API_TOKEN],
            )
            cloud_client = cloud_loqed.LoqedCloudAPI(cloud_api_client)

            try:
                lock_data = await cloud_client.async_get_locks()
            except aiohttp.ClientError as err:
                _LOGGER.error("HTTP Connection error to loqed API")
                raise CannotConnect from err

        try:
            match_key, match_value = (
                ("bridge_ip", self._host) if self._host else ("id", data.get("lock_id"))
            )
            selected_lock = next(
                lock for lock in lock_data["data"] if lock[match_key] == match_value
            )

            apiclient = loqed.APIClient(session, f"http://{selected_lock['bridge_ip']}")
            api = loqed.LoqedAPI(apiclient)
            lock = await api.async_get_lock(
                selected_lock["backend_key"],
                selected_lock["bridge_key"],
                selected_lock["local_id"],
                selected_lock["bridge_ip"],
            )

            # checking getWebooks to check the bridgeKey
            await lock.getWebhooks()
            return {
                "lock_key_key": selected_lock["key_secret"],
                "bridge_key": selected_lock["bridge_key"],
                "lock_key_local_id": selected_lock["local_id"],
                "bridge_mdns_hostname": selected_lock["bridge_hostname"],
                "bridge_ip": selected_lock["bridge_ip"],
                "name": selected_lock["name"],
                "id": selected_lock["id"],
            }
        except StopIteration as err:
            raise InvalidAuth from err
        except aiohttp.ClientError as err:
            _LOGGER.error("HTTP Connection error to loqed lock")
            raise CannotConnect from err

    @override
    async def async_step_zeroconf(
        self, discovery_info: ZeroconfServiceInfo
    ) -> ConfigFlowResult:
        """Handle zeroconf discovery."""
        host = discovery_info.host
        self._host = host

        session = async_get_clientsession(self.hass)
        apiclient = loqed.APIClient(session, f"http://{host}")
        api = loqed.LoqedAPI(apiclient)
        lock_data = await api.async_get_lock_details()

        # Check if already exists
        await self.async_set_unique_id(lock_data["bridge_mac_wifi"])
        self._abort_if_unique_id_configured({"bridge_ip": host})

        return await self.async_step_user()

    @override
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Show userform to user."""
        user_data_schema = vol.Schema(
            {
                vol.Required(CONF_API_TOKEN): str,
            }
        )

        if user_input is None:
            return self.async_show_form(
                step_id="user",
                data_schema=user_data_schema,
                description_placeholders={
                    "config_url": "https://integrations.loqed.com/personal-access-tokens",
                },
            )

        errors = {}

        # If no Zeroconf discovery and no selected lock, we need to fetch locks and show picker
        if not self._host and not user_input.get("lock_id"):
            session = async_get_clientsession(self.hass)
            cloud_api_client = cloud_loqed.CloudAPIClient(
                session,
                user_input[CONF_API_TOKEN],
            )
            cloud_client = cloud_loqed.LoqedCloudAPI(cloud_api_client)

            try:
                lock_data = await cloud_client.async_get_locks()
            except aiohttp.ClientError:
                errors["base"] = "cannot_connect"
            else:
                self._locks = lock_data["data"]
                self._api_token = user_input[CONF_API_TOKEN]
                if not self._locks:
                    errors["base"] = "no_locks"
                elif len(self._locks) == 1:
                    user_input["lock_id"] = self._locks[0]["id"]
                else:
                    return await self.async_step_pick_lock()

        if errors:
            return self.async_show_form(
                step_id="user",
                data_schema=user_data_schema,
                errors=errors,
                description_placeholders={
                    "config_url": "https://integrations.loqed.com/personal-access-tokens",
                },
            )

        try:
            info = await self.validate_input(self.hass, user_input)
        except CannotConnect:
            errors["base"] = "cannot_connect"
        except InvalidAuth:
            errors["base"] = "invalid_auth"
        else:
            await self.async_set_unique_id(
                re.sub(
                    r"LOQED-([a-f0-9]+)\.local", r"\1", info["bridge_mdns_hostname"]
                ),
                raise_on_progress=False,
            )
            self._abort_if_unique_id_configured()

            return self.async_create_entry(
                title=info["name"],
                data={
                    CONF_API_TOKEN: user_input[CONF_API_TOKEN],
                    CONF_WEBHOOK_ID: webhook.async_generate_id(),
                    **info,
                },
            )

        return self.async_show_form(
            step_id="user",
            data_schema=user_data_schema,
            errors=errors,
            description_placeholders={
                "config_url": "https://integrations.loqed.com/personal-access-tokens",
            },
        )

    async def async_step_pick_lock(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle lock selection when multiple locks are available."""
        if user_input is not None:
            if self._api_token is None:
                return await self.async_step_user()
            return await self.async_step_user(
                {**user_input, CONF_API_TOKEN: self._api_token}
            )

        lock_options = {lock["id"]: lock["name"] for lock in self._locks}

        return self.async_show_form(
            step_id="pick_lock",
            data_schema=vol.Schema(
                {
                    vol.Required("lock_id"): vol.In(lock_options),
                }
            ),
        )


class CannotConnect(HomeAssistantError):
    """Error to indicate we cannot connect."""


class InvalidAuth(HomeAssistantError):
    """Error to indicate there is invalid auth."""