145 lines
4.8 KiB
Python
145 lines
4.8 KiB
Python
"""Helpers for data entry flows for config entries."""
|
|
from functools import partial
|
|
from ipaddress import ip_address
|
|
from urllib.parse import urlparse
|
|
|
|
from homeassistant import config_entries
|
|
from homeassistant.util.network import is_local
|
|
|
|
|
|
def register_discovery_flow(domain, title, discovery_function,
|
|
connection_class):
|
|
"""Register flow for discovered integrations that not require auth."""
|
|
config_entries.HANDLERS.register(domain)(
|
|
partial(DiscoveryFlowHandler, domain, title, discovery_function,
|
|
connection_class))
|
|
|
|
|
|
def register_webhook_flow(domain, title, description_placeholder,
|
|
allow_multiple=False):
|
|
"""Register flow for webhook integrations."""
|
|
config_entries.HANDLERS.register(domain)(
|
|
partial(WebhookFlowHandler, domain, title, description_placeholder,
|
|
allow_multiple))
|
|
|
|
|
|
class DiscoveryFlowHandler(config_entries.ConfigFlow):
|
|
"""Handle a discovery config flow."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(self, domain, title, discovery_function, connection_class):
|
|
"""Initialize the discovery config flow."""
|
|
self._domain = domain
|
|
self._title = title
|
|
self._discovery_function = discovery_function
|
|
self.CONNECTION_CLASS = connection_class # pylint: disable=C0103
|
|
|
|
async def async_step_user(self, user_input=None):
|
|
"""Handle a flow initialized by the user."""
|
|
if self._async_current_entries():
|
|
return self.async_abort(
|
|
reason='single_instance_allowed'
|
|
)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_confirm(self, user_input=None):
|
|
"""Confirm setup."""
|
|
if user_input is None:
|
|
return self.async_show_form(
|
|
step_id='confirm',
|
|
)
|
|
|
|
if self.context and self.context.get('source') != \
|
|
config_entries.SOURCE_DISCOVERY:
|
|
# Get current discovered entries.
|
|
in_progress = self._async_in_progress()
|
|
|
|
has_devices = in_progress
|
|
if not has_devices:
|
|
has_devices = await 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'])
|
|
|
|
return self.async_create_entry(
|
|
title=self._title,
|
|
data={},
|
|
)
|
|
|
|
async def async_step_discovery(self, discovery_info):
|
|
"""Handle a flow initialized by discovery."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(
|
|
reason='single_instance_allowed'
|
|
)
|
|
|
|
return await self.async_step_confirm()
|
|
|
|
async def async_step_import(self, _):
|
|
"""Handle a flow initialized by import."""
|
|
if self._async_in_progress() or self._async_current_entries():
|
|
return self.async_abort(
|
|
reason='single_instance_allowed'
|
|
)
|
|
|
|
return self.async_create_entry(
|
|
title=self._title,
|
|
data={},
|
|
)
|
|
|
|
|
|
class WebhookFlowHandler(config_entries.ConfigFlow):
|
|
"""Handle a webhook config flow."""
|
|
|
|
VERSION = 1
|
|
|
|
def __init__(self, domain, title, description_placeholder,
|
|
allow_multiple):
|
|
"""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=None):
|
|
"""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='one_instance_allowed')
|
|
|
|
try:
|
|
url_parts = urlparse(self.hass.config.api.base_url)
|
|
|
|
if is_local(ip_address(url_parts.hostname)):
|
|
return self.async_abort(reason='not_internet_accessible')
|
|
except ValueError:
|
|
# If it's not an IP address, it's very likely publicly accessible
|
|
pass
|
|
|
|
if user_input is None:
|
|
return self.async_show_form(
|
|
step_id='user',
|
|
)
|
|
|
|
webhook_id = self.hass.components.webhook.async_generate_id()
|
|
webhook_url = \
|
|
self.hass.components.webhook.async_generate_url(webhook_id)
|
|
|
|
self._description_placeholder['webhook_url'] = webhook_url
|
|
|
|
return self.async_create_entry(
|
|
title=self._title,
|
|
data={
|
|
'webhook_id': webhook_id
|
|
},
|
|
description_placeholders=self._description_placeholder
|
|
)
|