config_flow.py

Go to the documentation of this file.

"""Config flow to configure the Nextcloud integration."""
 
from __future__ import annotations
 
from collections.abc import Mapping
from typing import Any
 
from nextcloudmonitor import (
    NextcloudMonitor,
    NextcloudMonitorAuthorizationError,
    NextcloudMonitorConnectionError,
    NextcloudMonitorRequestError,
)
import voluptuous as vol
 
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
from homeassistant.const import CONF_PASSWORD, CONF_URL, CONF_USERNAME, CONF_VERIFY_SSL
 
from .const import DEFAULT_VERIFY_SSL, DOMAIN
 
DATA_SCHEMA_USER = vol.Schema(
    {
        vol.Required(CONF_URL): str,
        vol.Required(CONF_USERNAME): str,
        vol.Required(CONF_PASSWORD): str,
        vol.Required(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): bool,
    }
)
DATA_SCHEMA_REAUTH = vol.Schema(
    {
        vol.Required(CONF_USERNAME): str,
        vol.Required(CONF_PASSWORD): str,
    }
)
 
 
class NextcloudConfigFlow(ConfigFlow, domain=DOMAIN):
    """Handle a Nextcloud config flow."""
 
    VERSION = 1
 
    def _try_connect_nc(self, user_input: dict) -> NextcloudMonitor:
        """Try to connect to nextcloud server."""
        return NextcloudMonitor(
            user_input[CONF_URL],
            user_input[CONF_USERNAME],
            user_input[CONF_PASSWORD],
            user_input.get(CONF_VERIFY_SSL, DEFAULT_VERIFY_SSL),
        )
 
    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:
            self._async_abort_entries_match_async_abort_entries_match({CONF_URL: user_input.get(CONF_URL)})
            try:
                await self.hass.async_add_executor_job(self._try_connect_nc_try_connect_nc, user_input)
            except NextcloudMonitorAuthorizationError:
                errors["base"] = "invalid_auth"
            except (NextcloudMonitorConnectionError, NextcloudMonitorRequestError):
                errors["base"] = "connection_error"
            else:
                return self.async_create_entryasync_create_entryasync_create_entry(
                    title=user_input[CONF_URL],
                    data=user_input,
                )
 
        data_schema = self.add_suggested_values_to_schemaadd_suggested_values_to_schema(DATA_SCHEMA_USER, user_input)
        return self.async_show_formasync_show_formasync_show_form(
            step_id="user", data_schema=data_schema, errors=errors
        )
 
    async def async_step_reauth(
        self, entry_data: Mapping[str, Any]
    ) -> ConfigFlowResult:
        """Handle flow upon an API authentication error."""
        return await self.async_step_reauth_confirmasync_step_reauth_confirm()
 
    async def async_step_reauth_confirm(
        self, user_input: dict[str, Any] | None = None
    ) -> ConfigFlowResult:
        """Handle reauthorization flow."""
        errors = {}
 
        reauth_entry = self._get_reauth_entry_get_reauth_entry()
        if user_input is not None:
            try:
                await self.hass.async_add_executor_job(
                    self._try_connect_nc_try_connect_nc, {**reauth_entry.data, **user_input}
                )
            except NextcloudMonitorAuthorizationError:
                errors["base"] = "invalid_auth"
            except (NextcloudMonitorConnectionError, NextcloudMonitorRequestError):
                errors["base"] = "connection_error"
            else:
                return self.async_update_reload_and_abortasync_update_reload_and_abort(
                    reauth_entry, data_updates=user_input
                )
 
        data_schema = self.add_suggested_values_to_schemaadd_suggested_values_to_schema(
            DATA_SCHEMA_REAUTH,
            {CONF_USERNAME: reauth_entry.data[CONF_USERNAME], **(user_input or {})},
        )
        return self.async_show_formasync_show_formasync_show_form(
            step_id="reauth_confirm",
            data_schema=data_schema,
            description_placeholders={"url": reauth_entry.data[CONF_URL]},
            errors=errors,
        )