core/homeassistant/components/tautulli/config_flow.py

143 lines
5.0 KiB
Python

"""Config flow for Tautulli."""
from __future__ import annotations
from typing import Any
from pytautulli import (
PyTautulli,
PyTautulliException,
PyTautulliHostConfiguration,
exceptions,
)
import voluptuous as vol
from homeassistant.components.sensor import _LOGGER
from homeassistant.config_entries import ConfigFlow
from homeassistant.const import (
CONF_API_KEY,
CONF_HOST,
CONF_PATH,
CONF_PORT,
CONF_SSL,
CONF_URL,
CONF_VERIFY_SSL,
)
from homeassistant.data_entry_flow import FlowResult
from homeassistant.helpers.aiohttp_client import async_get_clientsession
from .const import (
DEFAULT_NAME,
DEFAULT_PATH,
DEFAULT_PORT,
DEFAULT_SSL,
DEFAULT_VERIFY_SSL,
DOMAIN,
)
class TautulliConfigFlow(ConfigFlow, domain=DOMAIN):
"""Handle a config flow for Tautulli."""
VERSION = 1
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle a flow initiated by the user."""
if self._async_current_entries():
return self.async_abort(reason="single_instance_allowed")
errors = {}
if user_input is not None:
if (error := await self.validate_input(user_input)) is None:
return self.async_create_entry(
title=DEFAULT_NAME,
data=user_input,
)
errors["base"] = error
user_input = user_input or {}
data_schema = {
vol.Required(CONF_API_KEY, default=user_input.get(CONF_API_KEY, "")): str,
vol.Required(CONF_URL, default=user_input.get(CONF_URL, "")): str,
vol.Optional(
CONF_VERIFY_SSL, default=user_input.get(CONF_VERIFY_SSL, True)
): bool,
}
return self.async_show_form(
step_id="user",
data_schema=vol.Schema(data_schema),
errors=errors or {},
)
async def async_step_reauth(self, config: dict[str, Any]) -> FlowResult:
"""Handle a reauthorization flow request."""
return await self.async_step_reauth_confirm()
async def async_step_reauth_confirm(
self, user_input: dict[str, str] | None = None
) -> FlowResult:
"""Confirm reauth dialog."""
errors = {}
if user_input is not None and (
entry := self.hass.config_entries.async_get_entry(self.context["entry_id"])
):
_input = {**entry.data, CONF_API_KEY: user_input[CONF_API_KEY]}
if (error := await self.validate_input(_input)) is None:
self.hass.config_entries.async_update_entry(entry, data=_input)
await self.hass.config_entries.async_reload(entry.entry_id)
return self.async_abort(reason="reauth_successful")
errors["base"] = error
return self.async_show_form(
step_id="reauth_confirm",
data_schema=vol.Schema({vol.Required(CONF_API_KEY): str}),
errors=errors,
)
async def async_step_import(self, config: dict[str, Any]) -> FlowResult:
"""Import a config entry from configuration.yaml."""
_LOGGER.warning(
"Configuration of the Tautulli platform in YAML is deprecated and will be "
"removed in Home Assistant 2022.6; Your existing configuration for host %s"
"has been imported into the UI automatically and can be safely removed "
"from your configuration.yaml file",
config[CONF_HOST],
)
if self._async_current_entries():
return self.async_abort(reason="single_instance_allowed")
host_configuration = PyTautulliHostConfiguration(
config[CONF_API_KEY],
ipaddress=config[CONF_HOST],
port=config.get(CONF_PORT, DEFAULT_PORT),
ssl=config.get(CONF_SSL, DEFAULT_SSL),
verify_ssl=config.get(CONF_VERIFY_SSL, DEFAULT_VERIFY_SSL),
base_api_path=config.get(CONF_PATH, DEFAULT_PATH),
)
return await self.async_step_user(
{
CONF_API_KEY: host_configuration.api_token,
CONF_URL: host_configuration.base_url,
CONF_VERIFY_SSL: host_configuration.verify_ssl,
}
)
async def validate_input(self, user_input: dict[str, Any]) -> str | None:
"""Try connecting to Tautulli."""
try:
api_client = PyTautulli(
api_token=user_input[CONF_API_KEY],
url=user_input[CONF_URL],
session=async_get_clientsession(
self.hass, user_input.get(CONF_VERIFY_SSL, True)
),
verify_ssl=user_input.get(CONF_VERIFY_SSL, True),
)
await api_client.async_get_server_info()
except exceptions.PyTautulliConnectionException:
return "cannot_connect"
except exceptions.PyTautulliAuthenticationException:
return "invalid_auth"
except PyTautulliException:
return "unknown"
return None