261 lines
9.1 KiB
Python
261 lines
9.1 KiB
Python
"""Helpers for data entry flows for config entries."""
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Awaitable, Callable
|
|
import logging
|
|
from typing import TYPE_CHECKING, Any, Generic, TypeVar, Union, cast
|
|
|
|
from homeassistant import config_entries
|
|
from homeassistant.components import dhcp, mqtt, ssdp, zeroconf
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.data_entry_flow import FlowResult
|
|
|
|
from .typing import UNDEFINED, DiscoveryInfoType, UndefinedType
|
|
|
|
if TYPE_CHECKING:
|
|
import asyncio
|
|
|
|
_R = TypeVar("_R", bound="Awaitable[bool] | bool")
|
|
DiscoveryFunctionType = Callable[[HomeAssistant], _R]
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class DiscoveryFlowHandler(config_entries.ConfigFlow, Generic[_R]):
|
|
"""Handle a discovery config flow."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(
|
|
self,
|
|
domain: str,
|
|
title: str,
|
|
discovery_function: DiscoveryFunctionType[_R],
|
|
) -> None:
|
|
"""Initialize the discovery config flow."""
|
|
self._domain = domain
|
|
self._title = title
|
|
self._discovery_function = discovery_function
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResult:
|
|
"""Handle a flow initialized by the user."""
|
|
if self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain, raise_on_progress=False)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_confirm(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResult:
|
|
"""Confirm setup."""
|
|
if user_input is None:
|
|
self._set_confirm_only()
|
|
return self.async_show_form(step_id="confirm")
|
|
|
|
if self.source == config_entries.SOURCE_USER:
|
|
# Get current discovered entries.
|
|
in_progress = self._async_in_progress()
|
|
|
|
if not (has_devices := bool(in_progress)):
|
|
has_devices = await cast(
|
|
"asyncio.Future[bool]",
|
|
self.hass.async_add_job(self._discovery_function, self.hass),
|
|
)
|
|
|
|
if not has_devices:
|
|
return self.async_abort(reason="no_devices_found")
|
|
|
|
# Cancel the discovered one.
|
|
for flow in in_progress:
|
|
self.hass.config_entries.flow.async_abort(flow["flow_id"])
|
|
|
|
if self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
return self.async_create_entry(title=self._title, data={})
|
|
|
|
async def async_step_discovery(
|
|
self, discovery_info: DiscoveryInfoType
|
|
) -> FlowResult:
|
|
"""Handle a flow initialized by discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_dhcp(self, discovery_info: dhcp.DhcpServiceInfo) -> FlowResult:
|
|
"""Handle a flow initialized by dhcp discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_homekit(
|
|
self, discovery_info: zeroconf.ZeroconfServiceInfo
|
|
) -> FlowResult:
|
|
"""Handle a flow initialized by Homekit discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_mqtt(self, discovery_info: mqtt.MqttServiceInfo) -> FlowResult:
|
|
"""Handle a flow initialized by mqtt discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_zeroconf(
|
|
self, discovery_info: zeroconf.ZeroconfServiceInfo
|
|
) -> FlowResult:
|
|
"""Handle a flow initialized by Zeroconf discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_ssdp(self, discovery_info: ssdp.SsdpServiceInfo) -> FlowResult:
|
|
"""Handle a flow initialized by Ssdp discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
await self.async_set_unique_id(self._domain)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_import(self, _: dict[str, Any] | None) -> FlowResult:
|
|
"""Handle a flow initialized by import."""
|
|
if self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
# Cancel other flows.
|
|
in_progress = self._async_in_progress()
|
|
for flow in in_progress:
|
|
self.hass.config_entries.flow.async_abort(flow["flow_id"])
|
|
|
|
return self.async_create_entry(title=self._title, data={})
|
|
|
|
|
|
def register_discovery_flow(
|
|
domain: str,
|
|
title: str,
|
|
discovery_function: DiscoveryFunctionType[Awaitable[bool] | bool],
|
|
connection_class: str | UndefinedType = UNDEFINED,
|
|
) -> None:
|
|
"""Register flow for discovered integrations that not require auth."""
|
|
if connection_class is not UNDEFINED:
|
|
_LOGGER.warning(
|
|
(
|
|
"The %s (%s) integration is setting a connection_class"
|
|
" when calling the 'register_discovery_flow()' method in its"
|
|
" config flow. The connection class has been deprecated and will"
|
|
" be removed in a future release of Home Assistant."
|
|
" If '%s' is a custom integration, please contact the author"
|
|
" of that integration about this warning.",
|
|
),
|
|
title,
|
|
domain,
|
|
domain,
|
|
)
|
|
|
|
class DiscoveryFlow(DiscoveryFlowHandler[Union[Awaitable[bool], bool]]):
|
|
"""Discovery flow handler."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__(domain, title, discovery_function)
|
|
|
|
config_entries.HANDLERS.register(domain)(DiscoveryFlow)
|
|
|
|
|
|
class WebhookFlowHandler(config_entries.ConfigFlow):
|
|
"""Handle a webhook config flow."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(
|
|
self,
|
|
domain: str,
|
|
title: str,
|
|
description_placeholder: dict,
|
|
allow_multiple: bool,
|
|
) -> None:
|
|
"""Initialize the discovery config flow."""
|
|
self._domain = domain
|
|
self._title = title
|
|
self._description_placeholder = description_placeholder
|
|
self._allow_multiple = allow_multiple
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResult:
|
|
"""Handle a user initiated set up flow to create a webhook."""
|
|
if not self._allow_multiple and self._async_current_entries():
|
|
return self.async_abort(reason="single_instance_allowed")
|
|
|
|
if user_input is None:
|
|
return self.async_show_form(step_id="user")
|
|
|
|
webhook_id = self.hass.components.webhook.async_generate_id()
|
|
|
|
if (
|
|
"cloud" in self.hass.config.components
|
|
and self.hass.components.cloud.async_active_subscription()
|
|
):
|
|
if not self.hass.components.cloud.async_is_connected():
|
|
return self.async_abort(reason="cloud_not_connected")
|
|
|
|
webhook_url = await self.hass.components.cloud.async_create_cloudhook(
|
|
webhook_id
|
|
)
|
|
cloudhook = True
|
|
else:
|
|
webhook_url = self.hass.components.webhook.async_generate_url(webhook_id)
|
|
cloudhook = False
|
|
|
|
self._description_placeholder["webhook_url"] = webhook_url
|
|
|
|
return self.async_create_entry(
|
|
title=self._title,
|
|
data={"webhook_id": webhook_id, "cloudhook": cloudhook},
|
|
description_placeholders=self._description_placeholder,
|
|
)
|
|
|
|
|
|
def register_webhook_flow(
|
|
domain: str, title: str, description_placeholder: dict, allow_multiple: bool = False
|
|
) -> None:
|
|
"""Register flow for webhook integrations."""
|
|
|
|
class WebhookFlow(WebhookFlowHandler):
|
|
"""Webhook flow handler."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__(domain, title, description_placeholder, allow_multiple)
|
|
|
|
config_entries.HANDLERS.register(domain)(WebhookFlow)
|
|
|
|
|
|
async def webhook_async_remove_entry(
|
|
hass: HomeAssistant, entry: config_entries.ConfigEntry
|
|
) -> None:
|
|
"""Remove a webhook config entry."""
|
|
if not entry.data.get("cloudhook") or "cloud" not in hass.config.components:
|
|
return
|
|
|
|
await hass.components.cloud.async_delete_cloudhook(entry.data["webhook_id"])
|