298 lines
11 KiB
Python
298 lines
11 KiB
Python
"""Config flow for the Huawei LTE platform."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import Any
|
|
from urllib.parse import urlparse
|
|
|
|
from huawei_lte_api.AuthorizedConnection import AuthorizedConnection
|
|
from huawei_lte_api.Client import Client
|
|
from huawei_lte_api.Connection import Connection
|
|
from huawei_lte_api.exceptions import (
|
|
LoginErrorPasswordWrongException,
|
|
LoginErrorUsernamePasswordOverrunException,
|
|
LoginErrorUsernamePasswordWrongException,
|
|
LoginErrorUsernameWrongException,
|
|
ResponseErrorException,
|
|
)
|
|
from requests.exceptions import Timeout
|
|
from url_normalize import url_normalize
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import config_entries
|
|
from homeassistant.components import ssdp
|
|
from homeassistant.const import (
|
|
CONF_NAME,
|
|
CONF_PASSWORD,
|
|
CONF_RECIPIENT,
|
|
CONF_URL,
|
|
CONF_USERNAME,
|
|
)
|
|
from homeassistant.core import callback
|
|
from homeassistant.data_entry_flow import FlowResultDict
|
|
from homeassistant.helpers.typing import DiscoveryInfoType
|
|
|
|
from .const import (
|
|
CONF_TRACK_WIRED_CLIENTS,
|
|
CONNECTION_TIMEOUT,
|
|
DEFAULT_DEVICE_NAME,
|
|
DEFAULT_NOTIFY_SERVICE_NAME,
|
|
DEFAULT_TRACK_WIRED_CLIENTS,
|
|
DOMAIN,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class ConfigFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
|
|
"""Handle Huawei LTE config flow."""
|
|
|
|
VERSION = 2
|
|
CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_POLL
|
|
|
|
@staticmethod
|
|
@callback
|
|
def async_get_options_flow(
|
|
config_entry: config_entries.ConfigEntry,
|
|
) -> OptionsFlowHandler:
|
|
"""Get options flow."""
|
|
return OptionsFlowHandler(config_entry)
|
|
|
|
async def _async_show_user_form(
|
|
self,
|
|
user_input: dict[str, Any] | None = None,
|
|
errors: dict[str, str] | None = None,
|
|
) -> FlowResultDict:
|
|
if user_input is None:
|
|
user_input = {}
|
|
return self.async_show_form(
|
|
step_id="user",
|
|
data_schema=vol.Schema(
|
|
{
|
|
vol.Required(
|
|
CONF_URL,
|
|
default=user_input.get(
|
|
CONF_URL,
|
|
self.context.get(CONF_URL, ""),
|
|
),
|
|
): str,
|
|
vol.Optional(
|
|
CONF_USERNAME, default=user_input.get(CONF_USERNAME, "")
|
|
): str,
|
|
vol.Optional(
|
|
CONF_PASSWORD, default=user_input.get(CONF_PASSWORD, "")
|
|
): str,
|
|
}
|
|
),
|
|
errors=errors or {},
|
|
)
|
|
|
|
async def async_step_import(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResultDict:
|
|
"""Handle import initiated config flow."""
|
|
return await self.async_step_user(user_input)
|
|
|
|
def _already_configured(self, user_input: dict[str, Any]) -> bool:
|
|
"""See if we already have a router matching user input configured."""
|
|
existing_urls = {
|
|
url_normalize(entry.data[CONF_URL], default_scheme="http")
|
|
for entry in self._async_current_entries()
|
|
}
|
|
return user_input[CONF_URL] in existing_urls
|
|
|
|
async def async_step_user(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResultDict:
|
|
"""Handle user initiated config flow."""
|
|
if user_input is None:
|
|
return await self._async_show_user_form()
|
|
|
|
errors = {}
|
|
|
|
# Normalize URL
|
|
user_input[CONF_URL] = url_normalize(
|
|
user_input[CONF_URL], default_scheme="http"
|
|
)
|
|
if "://" not in user_input[CONF_URL]:
|
|
errors[CONF_URL] = "invalid_url"
|
|
return await self._async_show_user_form(
|
|
user_input=user_input, errors=errors
|
|
)
|
|
|
|
if self._already_configured(user_input):
|
|
return self.async_abort(reason="already_configured")
|
|
|
|
conn: Connection | None = None
|
|
|
|
def logout() -> None:
|
|
if isinstance(conn, AuthorizedConnection):
|
|
try:
|
|
conn.user.logout()
|
|
except Exception: # pylint: disable=broad-except
|
|
_LOGGER.debug("Could not logout", exc_info=True)
|
|
|
|
def try_connect(user_input: dict[str, Any]) -> Connection:
|
|
"""Try connecting with given credentials."""
|
|
username = user_input.get(CONF_USERNAME)
|
|
password = user_input.get(CONF_PASSWORD)
|
|
conn: Connection
|
|
if username or password:
|
|
conn = AuthorizedConnection(
|
|
user_input[CONF_URL],
|
|
username=username,
|
|
password=password,
|
|
timeout=CONNECTION_TIMEOUT,
|
|
)
|
|
else:
|
|
try:
|
|
conn = AuthorizedConnection(
|
|
user_input[CONF_URL],
|
|
username="",
|
|
password="",
|
|
timeout=CONNECTION_TIMEOUT,
|
|
)
|
|
user_input[CONF_USERNAME] = ""
|
|
user_input[CONF_PASSWORD] = ""
|
|
except ResponseErrorException:
|
|
_LOGGER.debug(
|
|
"Could not login with empty credentials, proceeding unauthenticated",
|
|
exc_info=True,
|
|
)
|
|
conn = Connection(user_input[CONF_URL], timeout=CONNECTION_TIMEOUT)
|
|
del user_input[CONF_USERNAME]
|
|
del user_input[CONF_PASSWORD]
|
|
return conn
|
|
|
|
def get_router_title(conn: Connection) -> str:
|
|
"""Get title for router."""
|
|
title = None
|
|
client = Client(conn)
|
|
try:
|
|
info = client.device.basic_information()
|
|
except Exception: # pylint: disable=broad-except
|
|
_LOGGER.debug("Could not get device.basic_information", exc_info=True)
|
|
else:
|
|
title = info.get("devicename")
|
|
if not title:
|
|
try:
|
|
info = client.device.information()
|
|
except Exception: # pylint: disable=broad-except
|
|
_LOGGER.debug("Could not get device.information", exc_info=True)
|
|
else:
|
|
title = info.get("DeviceName")
|
|
return title or DEFAULT_DEVICE_NAME
|
|
|
|
try:
|
|
conn = await self.hass.async_add_executor_job(try_connect, user_input)
|
|
except LoginErrorUsernameWrongException:
|
|
errors[CONF_USERNAME] = "incorrect_username"
|
|
except LoginErrorPasswordWrongException:
|
|
errors[CONF_PASSWORD] = "incorrect_password"
|
|
except LoginErrorUsernamePasswordWrongException:
|
|
errors[CONF_USERNAME] = "invalid_auth"
|
|
except LoginErrorUsernamePasswordOverrunException:
|
|
errors["base"] = "login_attempts_exceeded"
|
|
except ResponseErrorException:
|
|
_LOGGER.warning("Response error", exc_info=True)
|
|
errors["base"] = "response_error"
|
|
except Timeout:
|
|
_LOGGER.warning("Connection timeout", exc_info=True)
|
|
errors[CONF_URL] = "connection_timeout"
|
|
except Exception: # pylint: disable=broad-except
|
|
_LOGGER.warning("Unknown error connecting to device", exc_info=True)
|
|
errors[CONF_URL] = "unknown"
|
|
if errors:
|
|
await self.hass.async_add_executor_job(logout)
|
|
return await self._async_show_user_form(
|
|
user_input=user_input, errors=errors
|
|
)
|
|
|
|
title = self.context.get("title_placeholders", {}).get(
|
|
CONF_NAME
|
|
) or await self.hass.async_add_executor_job(get_router_title, conn)
|
|
await self.hass.async_add_executor_job(logout)
|
|
|
|
return self.async_create_entry(title=title, data=user_input)
|
|
|
|
async def async_step_ssdp(
|
|
self, discovery_info: DiscoveryInfoType
|
|
) -> FlowResultDict:
|
|
"""Handle SSDP initiated config flow."""
|
|
await self.async_set_unique_id(discovery_info[ssdp.ATTR_UPNP_UDN])
|
|
self._abort_if_unique_id_configured()
|
|
|
|
# Attempt to distinguish from other non-LTE Huawei router devices, at least
|
|
# some ones we are interested in have "Mobile Wi-Fi" friendlyName.
|
|
if "mobile" not in discovery_info.get(ssdp.ATTR_UPNP_FRIENDLY_NAME, "").lower():
|
|
return self.async_abort(reason="not_huawei_lte")
|
|
|
|
url = self.context[CONF_URL] = url_normalize(
|
|
discovery_info.get(
|
|
ssdp.ATTR_UPNP_PRESENTATION_URL,
|
|
f"http://{urlparse(discovery_info[ssdp.ATTR_SSDP_LOCATION]).hostname}/",
|
|
)
|
|
)
|
|
|
|
if any(
|
|
url == flow["context"].get(CONF_URL) for flow in self._async_in_progress()
|
|
):
|
|
return self.async_abort(reason="already_in_progress")
|
|
|
|
user_input = {CONF_URL: url}
|
|
if self._already_configured(user_input):
|
|
return self.async_abort(reason="already_configured")
|
|
|
|
self.context["title_placeholders"] = {
|
|
CONF_NAME: discovery_info.get(ssdp.ATTR_UPNP_FRIENDLY_NAME)
|
|
}
|
|
return await self._async_show_user_form(user_input)
|
|
|
|
|
|
class OptionsFlowHandler(config_entries.OptionsFlow):
|
|
"""Huawei LTE options flow."""
|
|
|
|
def __init__(self, config_entry: config_entries.ConfigEntry):
|
|
"""Initialize options flow."""
|
|
self.config_entry = config_entry
|
|
|
|
async def async_step_init(
|
|
self, user_input: dict[str, Any] | None = None
|
|
) -> FlowResultDict:
|
|
"""Handle options flow."""
|
|
|
|
# Recipients are persisted as a list, but handled as comma separated string in UI
|
|
|
|
if user_input is not None:
|
|
# Preserve existing options, for example *_from_yaml markers
|
|
data = {**self.config_entry.options, **user_input}
|
|
if not isinstance(data[CONF_RECIPIENT], list):
|
|
data[CONF_RECIPIENT] = [
|
|
x.strip() for x in data[CONF_RECIPIENT].split(",")
|
|
]
|
|
return self.async_create_entry(title="", data=data)
|
|
|
|
data_schema = vol.Schema(
|
|
{
|
|
vol.Optional(
|
|
CONF_NAME,
|
|
default=self.config_entry.options.get(
|
|
CONF_NAME, DEFAULT_NOTIFY_SERVICE_NAME
|
|
),
|
|
): str,
|
|
vol.Optional(
|
|
CONF_RECIPIENT,
|
|
default=", ".join(
|
|
self.config_entry.options.get(CONF_RECIPIENT, [])
|
|
),
|
|
): str,
|
|
vol.Optional(
|
|
CONF_TRACK_WIRED_CLIENTS,
|
|
default=self.config_entry.options.get(
|
|
CONF_TRACK_WIRED_CLIENTS, DEFAULT_TRACK_WIRED_CLIENTS
|
|
),
|
|
): bool,
|
|
}
|
|
)
|
|
return self.async_show_form(step_id="init", data_schema=data_schema)
|