core/homeassistant/components/whois/config_flow.py

"""Config flow to configure the Whois integration."""

from functools import partial
from typing import Any, override

import voluptuous as vol
import whoisdomain
from whoisdomain.exceptions import (
    FailedParsingWhoisOutputError,
    UnknownDateFormatError,
    UnknownTldError,
    WhoisCommandFailedError,
    WhoisPrivateRegistryError,
    WhoisQuotaExceededError,
)

from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_DOMAIN

from .const import DOMAIN


class WhoisFlowHandler(ConfigFlow, domain=DOMAIN):
    """Config flow for Whois."""

    VERSION = 1

    imported_name: str | None = None

    @override
    async def async_step_user(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle a flow initialized by the user."""
        errors = {}

        if user_input is not None:
            domain = user_input[CONF_DOMAIN].lower()

            await self.async_set_unique_id(domain)
            self._abort_if_unique_id_configured()

            try:
                await self.hass.async_add_executor_job(
                    partial(whoisdomain.query, domain, whoisOnly=True)
                )
            except UnknownTldError:
                errors["base"] = "unknown_tld"
            except WhoisCommandFailedError:
                errors["base"] = "whois_command_failed"
            except FailedParsingWhoisOutputError:
                errors["base"] = "unexpected_response"
            except UnknownDateFormatError:
                errors["base"] = "unknown_date_format"
            except WhoisPrivateRegistryError:
                errors["base"] = "private_registry"
            except WhoisQuotaExceededError:
                errors["base"] = "quota_exceeded"
            else:
                return self.async_create_entry(
                    title=self.imported_name or user_input[CONF_DOMAIN],
                    data={
                        CONF_DOMAIN: domain,
                    },
                )
        else:
            user_input = {}

        return self.async_show_form(
            step_id="user",
            data_schema=vol.Schema(
                {
                    vol.Required(
                        CONF_DOMAIN, default=user_input.get(CONF_DOMAIN, "")
                    ): str,
                }
            ),
            errors=errors,
        )