"""Config flow for generic (IP Camera).""" from __future__ import annotations from collections.abc import Mapping import contextlib from datetime import datetime from errno import EHOSTUNREACH, EIO import io import logging from typing import Any import PIL from aiohttp import web from async_timeout import timeout from httpx import HTTPStatusError, RequestError, TimeoutException import voluptuous as vol import yarl from homeassistant.components.camera import ( CAMERA_IMAGE_TIMEOUT, DynamicStreamSettings, _async_get_image, ) from homeassistant.components.http.view import HomeAssistantView from homeassistant.components.stream import ( CONF_RTSP_TRANSPORT, CONF_USE_WALLCLOCK_AS_TIMESTAMPS, HLS_PROVIDER, RTSP_TRANSPORTS, SOURCE_TIMEOUT, create_stream, ) from homeassistant.config_entries import ConfigEntry, ConfigFlow, OptionsFlow from homeassistant.const import ( CONF_AUTHENTICATION, CONF_NAME, CONF_PASSWORD, CONF_USERNAME, CONF_VERIFY_SSL, HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION, ) from homeassistant.core import HomeAssistant from homeassistant.data_entry_flow import FlowResult, UnknownFlow from homeassistant.exceptions import TemplateError from homeassistant.helpers import config_validation as cv, template as template_helper from homeassistant.helpers.httpx_client import get_async_client from homeassistant.util import slugify from .camera import GenericCamera, generate_auth from .const import ( CONF_CONFIRMED_OK, CONF_CONTENT_TYPE, CONF_FRAMERATE, CONF_LIMIT_REFETCH_TO_URL_CHANGE, CONF_STILL_IMAGE_URL, CONF_STREAM_SOURCE, DEFAULT_NAME, DOMAIN, GET_IMAGE_TIMEOUT, ) _LOGGER = logging.getLogger(__name__) DEFAULT_DATA = { CONF_NAME: DEFAULT_NAME, CONF_AUTHENTICATION: HTTP_BASIC_AUTHENTICATION, CONF_LIMIT_REFETCH_TO_URL_CHANGE: False, CONF_FRAMERATE: 2, CONF_VERIFY_SSL: True, } SUPPORTED_IMAGE_TYPES = {"png", "jpeg", "gif", "svg+xml", "webp"} IMAGE_PREVIEWS_ACTIVE = "previews" def build_schema( user_input: Mapping[str, Any], is_options_flow: bool = False, show_advanced_options=False, ): """Create schema for camera config setup.""" spec = { vol.Optional( CONF_STILL_IMAGE_URL, description={"suggested_value": user_input.get(CONF_STILL_IMAGE_URL, "")}, ): str, vol.Optional( CONF_STREAM_SOURCE, description={"suggested_value": user_input.get(CONF_STREAM_SOURCE, "")}, ): str, vol.Optional( CONF_RTSP_TRANSPORT, description={"suggested_value": user_input.get(CONF_RTSP_TRANSPORT)}, ): vol.In(RTSP_TRANSPORTS), vol.Optional( CONF_AUTHENTICATION, description={"suggested_value": user_input.get(CONF_AUTHENTICATION)}, ): vol.In([HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]), vol.Optional( CONF_USERNAME, description={"suggested_value": user_input.get(CONF_USERNAME, "")}, ): str, vol.Optional( CONF_PASSWORD, description={"suggested_value": user_input.get(CONF_PASSWORD, "")}, ): str, vol.Required( CONF_FRAMERATE, description={"suggested_value": user_input.get(CONF_FRAMERATE, 2)}, ): vol.All(vol.Range(min=0, min_included=False), cv.positive_float), vol.Required( CONF_VERIFY_SSL, default=user_input.get(CONF_VERIFY_SSL, True) ): bool, } if is_options_flow: spec[ vol.Required( CONF_LIMIT_REFETCH_TO_URL_CHANGE, default=user_input.get(CONF_LIMIT_REFETCH_TO_URL_CHANGE, False), ) ] = bool if show_advanced_options: spec[ vol.Required( CONF_USE_WALLCLOCK_AS_TIMESTAMPS, default=user_input.get(CONF_USE_WALLCLOCK_AS_TIMESTAMPS, False), ) ] = bool return vol.Schema(spec) def get_image_type(image: bytes) -> str | None: """Get the format of downloaded bytes that could be an image.""" fmt = None imagefile = io.BytesIO(image) with contextlib.suppress(PIL.UnidentifiedImageError): img = PIL.Image.open(imagefile) fmt = img.format.lower() if fmt is None: # if PIL can't figure it out, could be svg. with contextlib.suppress(UnicodeDecodeError): if image.decode("utf-8").lstrip().startswith(" tuple[dict[str, str], str | None]: """Verify that the still image is valid before we create an entity.""" fmt = None if not (url := info.get(CONF_STILL_IMAGE_URL)): return {}, info.get(CONF_CONTENT_TYPE, "image/jpeg") try: if not isinstance(url, template_helper.Template): url = template_helper.Template(url, hass) url = url.async_render(parse_result=False) except TemplateError as err: _LOGGER.warning("Problem rendering template %s: %s", url, err) return {CONF_STILL_IMAGE_URL: "template_error"}, None try: yarl_url = yarl.URL(url) except ValueError: return {CONF_STILL_IMAGE_URL: "malformed_url"}, None if not yarl_url.is_absolute(): return {CONF_STILL_IMAGE_URL: "relative_url"}, None verify_ssl = info[CONF_VERIFY_SSL] auth = generate_auth(info) try: async_client = get_async_client(hass, verify_ssl=verify_ssl) async with timeout(GET_IMAGE_TIMEOUT): response = await async_client.get(url, auth=auth, timeout=GET_IMAGE_TIMEOUT) response.raise_for_status() image = response.content except ( TimeoutError, RequestError, HTTPStatusError, TimeoutException, ) as err: _LOGGER.error("Error getting camera image from %s: %s", url, type(err).__name__) return {CONF_STILL_IMAGE_URL: "unable_still_load"}, None if not image: return {CONF_STILL_IMAGE_URL: "unable_still_load"}, None fmt = get_image_type(image) _LOGGER.debug( "Still image at '%s' detected format: %s", info[CONF_STILL_IMAGE_URL], fmt, ) if fmt not in SUPPORTED_IMAGE_TYPES: return {CONF_STILL_IMAGE_URL: "invalid_still_image"}, None return {}, f"image/{fmt}" def slug( hass: HomeAssistant, template: str | template_helper.Template | None ) -> str | None: """Convert a camera url into a string suitable for a camera name.""" url = "" if not template: return None if not isinstance(template, template_helper.Template): template = template_helper.Template(template, hass) try: url = template.async_render(parse_result=False) return slugify(yarl.URL(url).host) except (ValueError, TemplateError, TypeError) as err: _LOGGER.error("Syntax error in '%s': %s", template, err) return None async def async_test_stream( hass: HomeAssistant, info: Mapping[str, Any] ) -> dict[str, str]: """Verify that the stream is valid before we create an entity.""" if not (stream_source := info.get(CONF_STREAM_SOURCE)): return {} # Import from stream.worker as stream cannot reexport from worker # without forcing the av dependency on default_config # pylint: disable-next=import-outside-toplevel from homeassistant.components.stream.worker import StreamWorkerError if not isinstance(stream_source, template_helper.Template): stream_source = template_helper.Template(stream_source, hass) try: stream_source = stream_source.async_render(parse_result=False) except TemplateError as err: _LOGGER.warning("Problem rendering template %s: %s", stream_source, err) return {CONF_STREAM_SOURCE: "template_error"} stream_options: dict[str, str | bool | float] = {} if rtsp_transport := info.get(CONF_RTSP_TRANSPORT): stream_options[CONF_RTSP_TRANSPORT] = rtsp_transport if info.get(CONF_USE_WALLCLOCK_AS_TIMESTAMPS): stream_options[CONF_USE_WALLCLOCK_AS_TIMESTAMPS] = True try: url = yarl.URL(stream_source) except ValueError: return {CONF_STREAM_SOURCE: "malformed_url"} if not url.is_absolute(): return {CONF_STREAM_SOURCE: "relative_url"} if not url.user and not url.password: username = info.get(CONF_USERNAME) password = info.get(CONF_PASSWORD) if username and password: url = url.with_user(username).with_password(password) stream_source = str(url) try: stream = create_stream( hass, stream_source, stream_options, DynamicStreamSettings(), "test_stream", ) hls_provider = stream.add_provider(HLS_PROVIDER) await stream.start() if not await hls_provider.part_recv(timeout=SOURCE_TIMEOUT): hass.async_create_task(stream.stop()) return {CONF_STREAM_SOURCE: "timeout"} await stream.stop() except StreamWorkerError as err: return {CONF_STREAM_SOURCE: str(err)} except PermissionError: return {CONF_STREAM_SOURCE: "stream_not_permitted"} except OSError as err: if err.errno == EHOSTUNREACH: return {CONF_STREAM_SOURCE: "stream_no_route_to_host"} if err.errno == EIO: # input/output error return {CONF_STREAM_SOURCE: "stream_io_error"} raise err return {} def register_preview(hass: HomeAssistant): """Set up previews for camera feeds during config flow.""" hass.data.setdefault(DOMAIN, {}) if not hass.data[DOMAIN].get(IMAGE_PREVIEWS_ACTIVE): _LOGGER.debug("Registering camera image preview handler") hass.http.register_view(CameraImagePreview(hass)) hass.data[DOMAIN][IMAGE_PREVIEWS_ACTIVE] = True class GenericIPCamConfigFlow(ConfigFlow, domain=DOMAIN): """Config flow for generic IP camera.""" VERSION = 1 def __init__(self) -> None: """Initialize Generic ConfigFlow.""" self.user_input: dict[str, Any] = {} self.title = "" @staticmethod def async_get_options_flow( config_entry: ConfigEntry, ) -> GenericOptionsFlowHandler: """Get the options flow for this handler.""" return GenericOptionsFlowHandler(config_entry) def check_for_existing(self, options: dict[str, Any]) -> bool: """Check whether an existing entry is using the same URLs.""" return any( entry.options.get(CONF_STILL_IMAGE_URL) == options.get(CONF_STILL_IMAGE_URL) and entry.options.get(CONF_STREAM_SOURCE) == options.get(CONF_STREAM_SOURCE) for entry in self._async_current_entries() ) async def async_step_user( self, user_input: dict[str, Any] | None = None ) -> FlowResult: """Handle the start of the config flow.""" errors = {} hass = self.hass if user_input: # Secondary validation because serialised vol can't seem to handle this complexity: if not user_input.get(CONF_STILL_IMAGE_URL) and not user_input.get( CONF_STREAM_SOURCE ): errors["base"] = "no_still_image_or_stream_url" else: errors, still_format = await async_test_still(hass, user_input) errors = errors | await async_test_stream(hass, user_input) if not errors: user_input[CONF_CONTENT_TYPE] = still_format user_input[CONF_LIMIT_REFETCH_TO_URL_CHANGE] = False still_url = user_input.get(CONF_STILL_IMAGE_URL) stream_url = user_input.get(CONF_STREAM_SOURCE) name = ( slug(hass, still_url) or slug(hass, stream_url) or DEFAULT_NAME ) if still_url is None: # If user didn't specify a still image URL, # The automatically generated still image that stream generates # is always jpeg user_input[CONF_CONTENT_TYPE] = "image/jpeg" self.user_input = user_input self.title = name # temporary preview for user to check the image self.context["preview_cam"] = user_input return await self.async_step_user_confirm_still() elif self.user_input: user_input = self.user_input else: user_input = DEFAULT_DATA.copy() return self.async_show_form( step_id="user", data_schema=build_schema(user_input), errors=errors, ) async def async_step_user_confirm_still( self, user_input: dict[str, Any] | None = None ) -> FlowResult: """Handle user clicking confirm after still preview.""" if user_input: if not user_input.get(CONF_CONFIRMED_OK): return await self.async_step_user() return self.async_create_entry( title=self.title, data={}, options=self.user_input ) register_preview(self.hass) preview_url = f"/api/generic/preview_flow_image/{self.flow_id}?t={datetime.now().isoformat()}" return self.async_show_form( step_id="user_confirm_still", data_schema=vol.Schema( { vol.Required(CONF_CONFIRMED_OK, default=False): bool, } ), description_placeholders={"preview_url": preview_url}, errors=None, ) async def async_step_import(self, import_config: dict[str, Any]) -> FlowResult: """Handle config import from yaml.""" # abort if we've already got this one. if self.check_for_existing(import_config): return self.async_abort(reason="already_exists") # Don't bother testing the still or stream details on yaml import. still_url = import_config.get(CONF_STILL_IMAGE_URL) stream_url = import_config.get(CONF_STREAM_SOURCE) name = import_config.get( CONF_NAME, slug(self.hass, still_url) or slug(self.hass, stream_url) or DEFAULT_NAME, ) if CONF_LIMIT_REFETCH_TO_URL_CHANGE not in import_config: import_config[CONF_LIMIT_REFETCH_TO_URL_CHANGE] = False still_format = import_config.get(CONF_CONTENT_TYPE, "image/jpeg") import_config[CONF_CONTENT_TYPE] = still_format return self.async_create_entry(title=name, data={}, options=import_config) class GenericOptionsFlowHandler(OptionsFlow): """Handle Generic IP Camera options.""" def __init__(self, config_entry: ConfigEntry) -> None: """Initialize Generic IP Camera options flow.""" self.config_entry = config_entry self.user_input: dict[str, Any] = {} async def async_step_init( self, user_input: dict[str, Any] | None = None ) -> FlowResult: """Manage Generic IP Camera options.""" errors: dict[str, str] = {} hass = self.hass if user_input is not None: errors, still_format = await async_test_still( hass, self.config_entry.options | user_input ) errors = errors | await async_test_stream(hass, user_input) still_url = user_input.get(CONF_STILL_IMAGE_URL) if not errors: if still_url is None: # If user didn't specify a still image URL, # The automatically generated still image that stream generates # is always jpeg still_format = "image/jpeg" data = { CONF_AUTHENTICATION: user_input.get(CONF_AUTHENTICATION), CONF_STREAM_SOURCE: user_input.get(CONF_STREAM_SOURCE), CONF_PASSWORD: user_input.get(CONF_PASSWORD), CONF_STILL_IMAGE_URL: user_input.get(CONF_STILL_IMAGE_URL), CONF_CONTENT_TYPE: still_format or self.config_entry.options.get(CONF_CONTENT_TYPE), CONF_USERNAME: user_input.get(CONF_USERNAME), CONF_LIMIT_REFETCH_TO_URL_CHANGE: user_input[ CONF_LIMIT_REFETCH_TO_URL_CHANGE ], CONF_FRAMERATE: user_input[CONF_FRAMERATE], CONF_VERIFY_SSL: user_input[CONF_VERIFY_SSL], CONF_USE_WALLCLOCK_AS_TIMESTAMPS: user_input.get( CONF_USE_WALLCLOCK_AS_TIMESTAMPS, self.config_entry.options.get( CONF_USE_WALLCLOCK_AS_TIMESTAMPS, False ), ), } self.user_input = data # temporary preview for user to check the image self.context["preview_cam"] = data return await self.async_step_confirm_still() return self.async_show_form( step_id="init", data_schema=build_schema( user_input or self.config_entry.options, True, self.show_advanced_options, ), errors=errors, ) async def async_step_confirm_still( self, user_input: dict[str, Any] | None = None ) -> FlowResult: """Handle user clicking confirm after still preview.""" if user_input: if not user_input.get(CONF_CONFIRMED_OK): return await self.async_step_init() return self.async_create_entry( title=self.config_entry.title, data=self.user_input, ) register_preview(self.hass) preview_url = f"/api/generic/preview_flow_image/{self.flow_id}?t={datetime.now().isoformat()}" return self.async_show_form( step_id="confirm_still", data_schema=vol.Schema( { vol.Required(CONF_CONFIRMED_OK, default=False): bool, } ), description_placeholders={"preview_url": preview_url}, errors=None, ) class CameraImagePreview(HomeAssistantView): """Camera view to temporarily serve an image.""" url = "/api/generic/preview_flow_image/{flow_id}" name = "api:generic:preview_flow_image" requires_auth = False def __init__(self, hass: HomeAssistant) -> None: """Initialise.""" self.hass = hass async def get(self, request: web.Request, flow_id: str) -> web.Response: """Start a GET request.""" _LOGGER.debug("processing GET request for flow_id=%s", flow_id) try: flow = self.hass.config_entries.flow.async_get(flow_id) except UnknownFlow: try: flow = self.hass.config_entries.options.async_get(flow_id) except UnknownFlow as exc: _LOGGER.warning("Unknown flow while getting image preview") raise web.HTTPNotFound() from exc user_input = flow["context"]["preview_cam"] camera = GenericCamera(self.hass, user_input, flow_id, "preview") if not camera.is_on: _LOGGER.debug("Camera is off") raise web.HTTPServiceUnavailable() image = await _async_get_image( camera, CAMERA_IMAGE_TIMEOUT, ) return web.Response(body=image.content, content_type=image.content_type)