mirror of
https://github.com/home-assistant/core.git
synced 2025-07-13 16:27:08 +00:00
Move notify setup to legacy (#58033)
This commit is contained in:
Martin Hjelmare
GitHub
parent
749258a05d
commit
cc4241836e
@ -1,354 +1,60 @@
|
||||
"""Provides functionality to notify people."""
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from functools import partial
|
||||
import logging
|
||||
from typing import Any, cast
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.components.persistent_notification as pn
|
||||
from homeassistant.const import CONF_DESCRIPTION, CONF_NAME, CONF_PLATFORM
|
||||
from homeassistant.core import HomeAssistant, ServiceCall, callback
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers import config_per_platform, discovery, template
|
||||
from homeassistant.const import CONF_NAME, CONF_PLATFORM
|
||||
from homeassistant.core import HomeAssistant, ServiceCall
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.service import async_set_service_schema
|
||||
from homeassistant.loader import async_get_integration, bind_hass
|
||||
from homeassistant.setup import async_prepare_setup_platform, async_start_setup
|
||||
from homeassistant.util import slugify
|
||||
from homeassistant.util.yaml import load_yaml
|
||||
from homeassistant.helpers.typing import ConfigType
|
||||
|
||||
# mypy: allow-untyped-defs, no-check-untyped-defs
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
from .const import ( # noqa: F401
|
||||
ATTR_DATA,
|
||||
ATTR_MESSAGE,
|
||||
ATTR_TARGET,
|
||||
ATTR_TITLE,
|
||||
DOMAIN,
|
||||
NOTIFY_SERVICE_SCHEMA,
|
||||
PERSISTENT_NOTIFICATION_SERVICE_SCHEMA,
|
||||
SERVICE_NOTIFY,
|
||||
SERVICE_PERSISTENT_NOTIFICATION,
|
||||
)
|
||||
from .legacy import ( # noqa: F401
|
||||
BaseNotificationService,
|
||||
async_reload,
|
||||
async_reset_platform,
|
||||
async_setup_legacy,
|
||||
check_templates_warn,
|
||||
)
|
||||
|
||||
# Platform specific data
|
||||
ATTR_DATA = "data"
|
||||
|
||||
# Text to notify user of
|
||||
ATTR_MESSAGE = "message"
|
||||
|
||||
# Target of the notification (user, device, etc)
|
||||
ATTR_TARGET = "target"
|
||||
|
||||
# Title of notification
|
||||
ATTR_TITLE = "title"
|
||||
ATTR_TITLE_DEFAULT = "Home Assistant"
|
||||
|
||||
DOMAIN = "notify"
|
||||
|
||||
SERVICE_NOTIFY = "notify"
|
||||
SERVICE_PERSISTENT_NOTIFICATION = "persistent_notification"
|
||||
|
||||
NOTIFY_SERVICES = "notify_services"
|
||||
|
||||
CONF_FIELDS = "fields"
|
||||
|
||||
PLATFORM_SCHEMA = vol.Schema(
|
||||
{vol.Required(CONF_PLATFORM): cv.string, vol.Optional(CONF_NAME): cv.string},
|
||||
extra=vol.ALLOW_EXTRA,
|
||||
)
|
||||
|
||||
NOTIFY_SERVICE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_MESSAGE): cv.template,
|
||||
vol.Optional(ATTR_TITLE): cv.template,
|
||||
vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
}
|
||||
)
|
||||
|
||||
PERSISTENT_NOTIFICATION_SERVICE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_MESSAGE): cv.template,
|
||||
vol.Optional(ATTR_TITLE): cv.template,
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@callback
|
||||
def _check_templates_warn(hass: HomeAssistant, tpl: template.Template) -> None:
|
||||
"""Warn user that passing templates to notify service is deprecated."""
|
||||
if tpl.is_static or hass.data.get("notify_template_warned"):
|
||||
return
|
||||
|
||||
hass.data["notify_template_warned"] = True
|
||||
_LOGGER.warning(
|
||||
"Passing templates to notify service is deprecated and will be removed in 2021.12. "
|
||||
"Automations and scripts handle templates automatically"
|
||||
)
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reload(hass: HomeAssistant, integration_name: str) -> None:
|
||||
"""Register notify services for an integration."""
|
||||
if not _async_integration_has_notify_services(hass, integration_name):
|
||||
return
|
||||
|
||||
tasks = [
|
||||
notify_service.async_register_services()
|
||||
for notify_service in hass.data[NOTIFY_SERVICES][integration_name]
|
||||
]
|
||||
|
||||
await asyncio.gather(*tasks)
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reset_platform(hass: HomeAssistant, integration_name: str) -> None:
|
||||
"""Unregister notify services for an integration."""
|
||||
if not _async_integration_has_notify_services(hass, integration_name):
|
||||
return
|
||||
|
||||
tasks = [
|
||||
notify_service.async_unregister_services()
|
||||
for notify_service in hass.data[NOTIFY_SERVICES][integration_name]
|
||||
]
|
||||
|
||||
await asyncio.gather(*tasks)
|
||||
|
||||
del hass.data[NOTIFY_SERVICES][integration_name]
|
||||
|
||||
|
||||
def _async_integration_has_notify_services(
|
||||
hass: HomeAssistant, integration_name: str
|
||||
) -> bool:
|
||||
"""Determine if an integration has notify services registered."""
|
||||
if (
|
||||
NOTIFY_SERVICES not in hass.data
|
||||
or integration_name not in hass.data[NOTIFY_SERVICES]
|
||||
):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
class BaseNotificationService:
|
||||
"""An abstract class for notification services."""
|
||||
|
||||
# While not purely typed, it makes typehinting more useful for us
|
||||
# and removes the need for constant None checks or asserts.
|
||||
hass: HomeAssistant = None # type: ignore
|
||||
|
||||
# Name => target
|
||||
registered_targets: dict[str, str]
|
||||
|
||||
def send_message(self, message, **kwargs):
|
||||
"""Send a message.
|
||||
|
||||
kwargs can contain ATTR_TITLE to specify a title.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
|
||||
async def async_send_message(self, message: Any, **kwargs: Any) -> None:
|
||||
"""Send a message.
|
||||
|
||||
kwargs can contain ATTR_TITLE to specify a title.
|
||||
"""
|
||||
await self.hass.async_add_executor_job(
|
||||
partial(self.send_message, message, **kwargs)
|
||||
)
|
||||
|
||||
async def _async_notify_message_service(self, service: ServiceCall) -> None:
|
||||
"""Handle sending notification message service calls."""
|
||||
kwargs = {}
|
||||
message = service.data[ATTR_MESSAGE]
|
||||
title = service.data.get(ATTR_TITLE)
|
||||
|
||||
if title:
|
||||
_check_templates_warn(self.hass, title)
|
||||
title.hass = self.hass
|
||||
kwargs[ATTR_TITLE] = title.async_render(parse_result=False)
|
||||
|
||||
if self.registered_targets.get(service.service) is not None:
|
||||
kwargs[ATTR_TARGET] = [self.registered_targets[service.service]]
|
||||
elif service.data.get(ATTR_TARGET) is not None:
|
||||
kwargs[ATTR_TARGET] = service.data.get(ATTR_TARGET)
|
||||
|
||||
_check_templates_warn(self.hass, message)
|
||||
message.hass = self.hass
|
||||
kwargs[ATTR_MESSAGE] = message.async_render(parse_result=False)
|
||||
kwargs[ATTR_DATA] = service.data.get(ATTR_DATA)
|
||||
|
||||
await self.async_send_message(**kwargs)
|
||||
|
||||
async def async_setup(
|
||||
self,
|
||||
hass: HomeAssistant,
|
||||
service_name: str,
|
||||
target_service_name_prefix: str,
|
||||
) -> None:
|
||||
"""Store the data for the notify service."""
|
||||
# pylint: disable=attribute-defined-outside-init
|
||||
self.hass = hass
|
||||
self._service_name = service_name
|
||||
self._target_service_name_prefix = target_service_name_prefix
|
||||
self.registered_targets = {}
|
||||
|
||||
# Load service descriptions from notify/services.yaml
|
||||
integration = await async_get_integration(hass, DOMAIN)
|
||||
services_yaml = integration.file_path / "services.yaml"
|
||||
self.services_dict = cast(
|
||||
dict, await hass.async_add_executor_job(load_yaml, str(services_yaml))
|
||||
)
|
||||
|
||||
async def async_register_services(self) -> None:
|
||||
"""Create or update the notify services."""
|
||||
if hasattr(self, "targets"):
|
||||
stale_targets = set(self.registered_targets)
|
||||
|
||||
for name, target in self.targets.items(): # type: ignore
|
||||
target_name = slugify(f"{self._target_service_name_prefix}_{name}")
|
||||
if target_name in stale_targets:
|
||||
stale_targets.remove(target_name)
|
||||
if (
|
||||
target_name in self.registered_targets
|
||||
and target == self.registered_targets[target_name]
|
||||
):
|
||||
continue
|
||||
self.registered_targets[target_name] = target
|
||||
self.hass.services.async_register(
|
||||
DOMAIN,
|
||||
target_name,
|
||||
self._async_notify_message_service,
|
||||
schema=NOTIFY_SERVICE_SCHEMA,
|
||||
)
|
||||
# Register the service description
|
||||
service_desc = {
|
||||
CONF_NAME: f"Send a notification via {target_name}",
|
||||
CONF_DESCRIPTION: f"Sends a notification message using the {target_name} integration.",
|
||||
CONF_FIELDS: self.services_dict[SERVICE_NOTIFY][CONF_FIELDS],
|
||||
}
|
||||
async_set_service_schema(self.hass, DOMAIN, target_name, service_desc)
|
||||
|
||||
for stale_target_name in stale_targets:
|
||||
del self.registered_targets[stale_target_name]
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
stale_target_name,
|
||||
)
|
||||
|
||||
if self.hass.services.has_service(DOMAIN, self._service_name):
|
||||
return
|
||||
|
||||
self.hass.services.async_register(
|
||||
DOMAIN,
|
||||
self._service_name,
|
||||
self._async_notify_message_service,
|
||||
schema=NOTIFY_SERVICE_SCHEMA,
|
||||
)
|
||||
|
||||
# Register the service description
|
||||
service_desc = {
|
||||
CONF_NAME: f"Send a notification with {self._service_name}",
|
||||
CONF_DESCRIPTION: f"Sends a notification message using the {self._service_name} service.",
|
||||
CONF_FIELDS: self.services_dict[SERVICE_NOTIFY][CONF_FIELDS],
|
||||
}
|
||||
async_set_service_schema(self.hass, DOMAIN, self._service_name, service_desc)
|
||||
|
||||
async def async_unregister_services(self) -> None:
|
||||
"""Unregister the notify services."""
|
||||
if self.registered_targets:
|
||||
remove_targets = set(self.registered_targets)
|
||||
for remove_target_name in remove_targets:
|
||||
del self.registered_targets[remove_target_name]
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
remove_target_name,
|
||||
)
|
||||
|
||||
if not self.hass.services.has_service(DOMAIN, self._service_name):
|
||||
return
|
||||
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
self._service_name,
|
||||
)
|
||||
|
||||
|
||||
async def async_setup(hass, config):
|
||||
async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
||||
"""Set up the notify services."""
|
||||
hass.data.setdefault(NOTIFY_SERVICES, {})
|
||||
await async_setup_legacy(hass, config)
|
||||
|
||||
async def persistent_notification(service: ServiceCall) -> None:
|
||||
"""Send notification via the built-in persistsent_notify integration."""
|
||||
message = service.data[ATTR_MESSAGE]
|
||||
message.hass = hass
|
||||
_check_templates_warn(hass, message)
|
||||
check_templates_warn(hass, message)
|
||||
|
||||
title = None
|
||||
if title_tpl := service.data.get(ATTR_TITLE):
|
||||
_check_templates_warn(hass, title_tpl)
|
||||
check_templates_warn(hass, title_tpl)
|
||||
title_tpl.hass = hass
|
||||
title = title_tpl.async_render(parse_result=False)
|
||||
|
||||
pn.async_create(hass, message.async_render(parse_result=False), title)
|
||||
|
||||
async def async_setup_platform(
|
||||
integration_name, p_config=None, discovery_info=None
|
||||
):
|
||||
"""Set up a notify platform."""
|
||||
if p_config is None:
|
||||
p_config = {}
|
||||
|
||||
platform = await async_prepare_setup_platform(
|
||||
hass, config, DOMAIN, integration_name
|
||||
)
|
||||
|
||||
if platform is None:
|
||||
_LOGGER.error("Unknown notification service specified")
|
||||
return
|
||||
|
||||
full_name = f"{DOMAIN}.{integration_name}"
|
||||
_LOGGER.info("Setting up %s", full_name)
|
||||
with async_start_setup(hass, [full_name]):
|
||||
notify_service = None
|
||||
try:
|
||||
if hasattr(platform, "async_get_service"):
|
||||
notify_service = await platform.async_get_service(
|
||||
hass, p_config, discovery_info
|
||||
)
|
||||
elif hasattr(platform, "get_service"):
|
||||
notify_service = await hass.async_add_executor_job(
|
||||
platform.get_service, hass, p_config, discovery_info
|
||||
)
|
||||
else:
|
||||
raise HomeAssistantError("Invalid notify platform.")
|
||||
|
||||
if notify_service is None:
|
||||
# Platforms can decide not to create a service based
|
||||
# on discovery data.
|
||||
if discovery_info is None:
|
||||
_LOGGER.error(
|
||||
"Failed to initialize notification service %s",
|
||||
integration_name,
|
||||
)
|
||||
return
|
||||
|
||||
except Exception: # pylint: disable=broad-except
|
||||
_LOGGER.exception("Error setting up platform %s", integration_name)
|
||||
return
|
||||
|
||||
if discovery_info is None:
|
||||
discovery_info = {}
|
||||
|
||||
conf_name = p_config.get(CONF_NAME) or discovery_info.get(CONF_NAME)
|
||||
target_service_name_prefix = conf_name or integration_name
|
||||
service_name = slugify(conf_name or SERVICE_NOTIFY)
|
||||
|
||||
await notify_service.async_setup(
|
||||
hass, service_name, target_service_name_prefix
|
||||
)
|
||||
await notify_service.async_register_services()
|
||||
|
||||
hass.data[NOTIFY_SERVICES].setdefault(integration_name, []).append(
|
||||
notify_service
|
||||
)
|
||||
hass.config.components.add(f"{DOMAIN}.{integration_name}")
|
||||
|
||||
return True
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN,
|
||||
SERVICE_PERSISTENT_NOTIFICATION,
|
||||
@ -356,18 +62,4 @@ async def async_setup(hass, config):
|
||||
schema=PERSISTENT_NOTIFICATION_SERVICE_SCHEMA,
|
||||
)
|
||||
|
||||
setup_tasks = [
|
||||
asyncio.create_task(async_setup_platform(integration_name, p_config))
|
||||
for integration_name, p_config in config_per_platform(config, DOMAIN)
|
||||
]
|
||||
|
||||
if setup_tasks:
|
||||
await asyncio.wait(setup_tasks)
|
||||
|
||||
async def async_platform_discovered(platform, info):
|
||||
"""Handle for discovered platform."""
|
||||
await async_setup_platform(platform, discovery_info=info)
|
||||
|
||||
discovery.async_listen_platform(hass, DOMAIN, async_platform_discovered)
|
||||
|
||||
return True
|
||||
|
||||
40
homeassistant/components/notify/const.py
Normal file
40
homeassistant/components/notify/const.py
Normal file
@ -0,0 +1,40 @@
|
||||
"""Provide common notify constants."""
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
|
||||
ATTR_DATA = "data"
|
||||
|
||||
# Text to notify user of
|
||||
ATTR_MESSAGE = "message"
|
||||
|
||||
# Target of the notification (user, device, etc)
|
||||
ATTR_TARGET = "target"
|
||||
|
||||
# Title of notification
|
||||
ATTR_TITLE = "title"
|
||||
|
||||
DOMAIN = "notify"
|
||||
|
||||
LOGGER = logging.getLogger(__package__)
|
||||
|
||||
SERVICE_NOTIFY = "notify"
|
||||
SERVICE_PERSISTENT_NOTIFICATION = "persistent_notification"
|
||||
|
||||
NOTIFY_SERVICE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_MESSAGE): cv.template,
|
||||
vol.Optional(ATTR_TITLE): cv.template,
|
||||
vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(ATTR_DATA): dict,
|
||||
}
|
||||
)
|
||||
|
||||
PERSISTENT_NOTIFICATION_SERVICE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Required(ATTR_MESSAGE): cv.template,
|
||||
vol.Optional(ATTR_TITLE): cv.template,
|
||||
}
|
||||
)
|
||||
315
homeassistant/components/notify/legacy.py
Normal file
315
homeassistant/components/notify/legacy.py
Normal file
@ -0,0 +1,315 @@
|
||||
"""Handle legacy notification platforms."""
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from functools import partial
|
||||
from typing import Any, cast
|
||||
|
||||
from homeassistant.const import CONF_DESCRIPTION, CONF_NAME
|
||||
from homeassistant.core import HomeAssistant, ServiceCall, callback
|
||||
from homeassistant.exceptions import HomeAssistantError
|
||||
from homeassistant.helpers import config_per_platform, discovery, template
|
||||
from homeassistant.helpers.service import async_set_service_schema
|
||||
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
||||
from homeassistant.loader import async_get_integration, bind_hass
|
||||
from homeassistant.setup import async_prepare_setup_platform, async_start_setup
|
||||
from homeassistant.util import slugify
|
||||
from homeassistant.util.yaml import load_yaml
|
||||
|
||||
from .const import (
|
||||
ATTR_DATA,
|
||||
ATTR_MESSAGE,
|
||||
ATTR_TARGET,
|
||||
ATTR_TITLE,
|
||||
DOMAIN,
|
||||
LOGGER,
|
||||
NOTIFY_SERVICE_SCHEMA,
|
||||
SERVICE_NOTIFY,
|
||||
)
|
||||
|
||||
CONF_FIELDS = "fields"
|
||||
NOTIFY_SERVICES = "notify_services"
|
||||
|
||||
|
||||
async def async_setup_legacy(hass: HomeAssistant, config: ConfigType) -> None:
|
||||
"""Set up legacy notify services."""
|
||||
hass.data.setdefault(NOTIFY_SERVICES, {})
|
||||
|
||||
async def async_setup_platform(
|
||||
integration_name: str,
|
||||
p_config: ConfigType | None = None,
|
||||
discovery_info: DiscoveryInfoType | None = None,
|
||||
) -> None:
|
||||
"""Set up a notify platform."""
|
||||
if p_config is None:
|
||||
p_config = {}
|
||||
|
||||
platform = await async_prepare_setup_platform(
|
||||
hass, config, DOMAIN, integration_name
|
||||
)
|
||||
|
||||
if platform is None:
|
||||
LOGGER.error("Unknown notification service specified")
|
||||
return
|
||||
|
||||
full_name = f"{DOMAIN}.{integration_name}"
|
||||
LOGGER.info("Setting up %s", full_name)
|
||||
with async_start_setup(hass, [full_name]):
|
||||
notify_service = None
|
||||
try:
|
||||
if hasattr(platform, "async_get_service"):
|
||||
notify_service = await platform.async_get_service( # type: ignore
|
||||
hass, p_config, discovery_info
|
||||
)
|
||||
elif hasattr(platform, "get_service"):
|
||||
notify_service = await hass.async_add_executor_job(
|
||||
platform.get_service, hass, p_config, discovery_info # type: ignore
|
||||
)
|
||||
else:
|
||||
raise HomeAssistantError("Invalid notify platform.")
|
||||
|
||||
if notify_service is None:
|
||||
# Platforms can decide not to create a service based
|
||||
# on discovery data.
|
||||
if discovery_info is None:
|
||||
LOGGER.error(
|
||||
"Failed to initialize notification service %s",
|
||||
integration_name,
|
||||
)
|
||||
return
|
||||
|
||||
except Exception: # pylint: disable=broad-except
|
||||
LOGGER.exception("Error setting up platform %s", integration_name)
|
||||
return
|
||||
|
||||
if discovery_info is None:
|
||||
discovery_info = {}
|
||||
|
||||
conf_name = p_config.get(CONF_NAME) or discovery_info.get(CONF_NAME)
|
||||
target_service_name_prefix = conf_name or integration_name
|
||||
service_name = slugify(conf_name or SERVICE_NOTIFY)
|
||||
|
||||
await notify_service.async_setup(
|
||||
hass, service_name, target_service_name_prefix
|
||||
)
|
||||
await notify_service.async_register_services()
|
||||
|
||||
hass.data[NOTIFY_SERVICES].setdefault(integration_name, []).append(
|
||||
notify_service
|
||||
)
|
||||
hass.config.components.add(f"{DOMAIN}.{integration_name}")
|
||||
|
||||
setup_tasks = [
|
||||
asyncio.create_task(async_setup_platform(integration_name, p_config))
|
||||
for integration_name, p_config in config_per_platform(config, DOMAIN)
|
||||
]
|
||||
|
||||
if setup_tasks:
|
||||
await asyncio.wait(setup_tasks)
|
||||
|
||||
async def async_platform_discovered(
|
||||
platform: str, info: DiscoveryInfoType | None
|
||||
) -> None:
|
||||
"""Handle for discovered platform."""
|
||||
await async_setup_platform(platform, discovery_info=info)
|
||||
|
||||
discovery.async_listen_platform(hass, DOMAIN, async_platform_discovered)
|
||||
|
||||
|
||||
@callback
|
||||
def check_templates_warn(hass: HomeAssistant, tpl: template.Template) -> None:
|
||||
"""Warn user that passing templates to notify service is deprecated."""
|
||||
if tpl.is_static or hass.data.get("notify_template_warned"):
|
||||
return
|
||||
|
||||
hass.data["notify_template_warned"] = True
|
||||
LOGGER.warning(
|
||||
"Passing templates to notify service is deprecated and will be removed in 2021.12. "
|
||||
"Automations and scripts handle templates automatically"
|
||||
)
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reload(hass: HomeAssistant, integration_name: str) -> None:
|
||||
"""Register notify services for an integration."""
|
||||
if not _async_integration_has_notify_services(hass, integration_name):
|
||||
return
|
||||
|
||||
tasks = [
|
||||
notify_service.async_register_services()
|
||||
for notify_service in hass.data[NOTIFY_SERVICES][integration_name]
|
||||
]
|
||||
|
||||
await asyncio.gather(*tasks)
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reset_platform(hass: HomeAssistant, integration_name: str) -> None:
|
||||
"""Unregister notify services for an integration."""
|
||||
if not _async_integration_has_notify_services(hass, integration_name):
|
||||
return
|
||||
|
||||
tasks = [
|
||||
notify_service.async_unregister_services()
|
||||
for notify_service in hass.data[NOTIFY_SERVICES][integration_name]
|
||||
]
|
||||
|
||||
await asyncio.gather(*tasks)
|
||||
|
||||
del hass.data[NOTIFY_SERVICES][integration_name]
|
||||
|
||||
|
||||
def _async_integration_has_notify_services(
|
||||
hass: HomeAssistant, integration_name: str
|
||||
) -> bool:
|
||||
"""Determine if an integration has notify services registered."""
|
||||
if (
|
||||
NOTIFY_SERVICES not in hass.data
|
||||
or integration_name not in hass.data[NOTIFY_SERVICES]
|
||||
):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
|
||||
class BaseNotificationService:
|
||||
"""An abstract class for notification services."""
|
||||
|
||||
# While not purely typed, it makes typehinting more useful for us
|
||||
# and removes the need for constant None checks or asserts.
|
||||
hass: HomeAssistant = None # type: ignore
|
||||
|
||||
# Name => target
|
||||
registered_targets: dict[str, str]
|
||||
|
||||
def send_message(self, message: str, **kwargs: Any) -> None:
|
||||
"""Send a message.
|
||||
|
||||
kwargs can contain ATTR_TITLE to specify a title.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
|
||||
async def async_send_message(self, message: str, **kwargs: Any) -> None:
|
||||
"""Send a message.
|
||||
|
||||
kwargs can contain ATTR_TITLE to specify a title.
|
||||
"""
|
||||
await self.hass.async_add_executor_job(
|
||||
partial(self.send_message, message, **kwargs)
|
||||
)
|
||||
|
||||
async def _async_notify_message_service(self, service: ServiceCall) -> None:
|
||||
"""Handle sending notification message service calls."""
|
||||
kwargs = {}
|
||||
message = service.data[ATTR_MESSAGE]
|
||||
title = service.data.get(ATTR_TITLE)
|
||||
|
||||
if title:
|
||||
check_templates_warn(self.hass, title)
|
||||
title.hass = self.hass
|
||||
kwargs[ATTR_TITLE] = title.async_render(parse_result=False)
|
||||
|
||||
if self.registered_targets.get(service.service) is not None:
|
||||
kwargs[ATTR_TARGET] = [self.registered_targets[service.service]]
|
||||
elif service.data.get(ATTR_TARGET) is not None:
|
||||
kwargs[ATTR_TARGET] = service.data.get(ATTR_TARGET)
|
||||
|
||||
check_templates_warn(self.hass, message)
|
||||
message.hass = self.hass
|
||||
kwargs[ATTR_MESSAGE] = message.async_render(parse_result=False)
|
||||
kwargs[ATTR_DATA] = service.data.get(ATTR_DATA)
|
||||
|
||||
await self.async_send_message(**kwargs)
|
||||
|
||||
async def async_setup(
|
||||
self,
|
||||
hass: HomeAssistant,
|
||||
service_name: str,
|
||||
target_service_name_prefix: str,
|
||||
) -> None:
|
||||
"""Store the data for the notify service."""
|
||||
# pylint: disable=attribute-defined-outside-init
|
||||
self.hass = hass
|
||||
self._service_name = service_name
|
||||
self._target_service_name_prefix = target_service_name_prefix
|
||||
self.registered_targets = {}
|
||||
|
||||
# Load service descriptions from notify/services.yaml
|
||||
integration = await async_get_integration(hass, DOMAIN)
|
||||
services_yaml = integration.file_path / "services.yaml"
|
||||
self.services_dict = cast(
|
||||
dict, await hass.async_add_executor_job(load_yaml, str(services_yaml))
|
||||
)
|
||||
|
||||
async def async_register_services(self) -> None:
|
||||
"""Create or update the notify services."""
|
||||
if hasattr(self, "targets"):
|
||||
stale_targets = set(self.registered_targets)
|
||||
|
||||
for name, target in self.targets.items(): # type: ignore
|
||||
target_name = slugify(f"{self._target_service_name_prefix}_{name}")
|
||||
if target_name in stale_targets:
|
||||
stale_targets.remove(target_name)
|
||||
if (
|
||||
target_name in self.registered_targets
|
||||
and target == self.registered_targets[target_name]
|
||||
):
|
||||
continue
|
||||
self.registered_targets[target_name] = target
|
||||
self.hass.services.async_register(
|
||||
DOMAIN,
|
||||
target_name,
|
||||
self._async_notify_message_service,
|
||||
schema=NOTIFY_SERVICE_SCHEMA,
|
||||
)
|
||||
# Register the service description
|
||||
service_desc = {
|
||||
CONF_NAME: f"Send a notification via {target_name}",
|
||||
CONF_DESCRIPTION: f"Sends a notification message using the {target_name} integration.",
|
||||
CONF_FIELDS: self.services_dict[SERVICE_NOTIFY][CONF_FIELDS],
|
||||
}
|
||||
async_set_service_schema(self.hass, DOMAIN, target_name, service_desc)
|
||||
|
||||
for stale_target_name in stale_targets:
|
||||
del self.registered_targets[stale_target_name]
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
stale_target_name,
|
||||
)
|
||||
|
||||
if self.hass.services.has_service(DOMAIN, self._service_name):
|
||||
return
|
||||
|
||||
self.hass.services.async_register(
|
||||
DOMAIN,
|
||||
self._service_name,
|
||||
self._async_notify_message_service,
|
||||
schema=NOTIFY_SERVICE_SCHEMA,
|
||||
)
|
||||
|
||||
# Register the service description
|
||||
service_desc = {
|
||||
CONF_NAME: f"Send a notification with {self._service_name}",
|
||||
CONF_DESCRIPTION: f"Sends a notification message using the {self._service_name} service.",
|
||||
CONF_FIELDS: self.services_dict[SERVICE_NOTIFY][CONF_FIELDS],
|
||||
}
|
||||
async_set_service_schema(self.hass, DOMAIN, self._service_name, service_desc)
|
||||
|
||||
async def async_unregister_services(self) -> None:
|
||||
"""Unregister the notify services."""
|
||||
if self.registered_targets:
|
||||
remove_targets = set(self.registered_targets)
|
||||
for remove_target_name in remove_targets:
|
||||
del self.registered_targets[remove_target_name]
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
remove_target_name,
|
||||
)
|
||||
|
||||
if not self.hass.services.has_service(DOMAIN, self._service_name):
|
||||
return
|
||||
|
||||
self.hass.services.async_remove(
|
||||
DOMAIN,
|
||||
self._service_name,
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user