90 lines
3.0 KiB
Python
90 lines
3.0 KiB
Python
"""Support for command line notification services."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import subprocess
|
|
from typing import Any
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.notify import (
|
|
DOMAIN as NOTIFY_DOMAIN,
|
|
PLATFORM_SCHEMA,
|
|
BaseNotificationService,
|
|
)
|
|
from homeassistant.const import CONF_COMMAND, CONF_NAME
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.issue_registry import IssueSeverity, create_issue
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.util.process import kill_subprocess
|
|
|
|
from .const import CONF_COMMAND_TIMEOUT, DEFAULT_TIMEOUT, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_COMMAND): cv.string,
|
|
vol.Optional(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
|
|
}
|
|
)
|
|
|
|
|
|
def get_service(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> CommandLineNotificationService:
|
|
"""Get the Command Line notification service."""
|
|
if notify_config := config:
|
|
create_issue(
|
|
hass,
|
|
DOMAIN,
|
|
"deprecated_yaml_notify",
|
|
breaks_in_ha_version="2023.8.0",
|
|
is_fixable=False,
|
|
severity=IssueSeverity.WARNING,
|
|
translation_key="deprecated_platform_yaml",
|
|
translation_placeholders={"platform": NOTIFY_DOMAIN},
|
|
)
|
|
if discovery_info:
|
|
notify_config = discovery_info
|
|
command: str = notify_config[CONF_COMMAND]
|
|
timeout: int = notify_config[CONF_COMMAND_TIMEOUT]
|
|
|
|
return CommandLineNotificationService(command, timeout)
|
|
|
|
|
|
class CommandLineNotificationService(BaseNotificationService):
|
|
"""Implement the notification service for the Command Line service."""
|
|
|
|
def __init__(self, command: str, timeout: int) -> None:
|
|
"""Initialize the service."""
|
|
self.command = command
|
|
self._timeout = timeout
|
|
|
|
def send_message(self, message: str = "", **kwargs: Any) -> None:
|
|
"""Send a message to a command line."""
|
|
with subprocess.Popen(
|
|
self.command,
|
|
universal_newlines=True,
|
|
stdin=subprocess.PIPE,
|
|
close_fds=False, # required for posix_spawn
|
|
shell=True, # nosec # shell by design
|
|
) as proc:
|
|
try:
|
|
proc.communicate(input=message, timeout=self._timeout)
|
|
if proc.returncode != 0:
|
|
_LOGGER.error(
|
|
"Command failed (with return code %s): %s",
|
|
proc.returncode,
|
|
self.command,
|
|
)
|
|
except subprocess.TimeoutExpired:
|
|
_LOGGER.error("Timeout for command: %s", self.command)
|
|
kill_subprocess(proc)
|
|
except subprocess.SubprocessError:
|
|
_LOGGER.error("Error trying to exec command: %s", self.command)
|