mirror of
https://github.com/home-assistant/core
synced 2024-08-02 23:40:32 +02:00
70 lines
2.4 KiB
Python
70 lines
2.4 KiB
Python
"""Support for command line notification services."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import subprocess
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.notify import 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.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.util.process import kill_subprocess
|
|
|
|
from .const import CONF_COMMAND_TIMEOUT, DEFAULT_TIMEOUT
|
|
|
|
_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."""
|
|
command: str = config[CONF_COMMAND]
|
|
timeout: int = 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="", **kwargs) -> None:
|
|
"""Send a message to a command line."""
|
|
with subprocess.Popen(
|
|
self.command,
|
|
universal_newlines=True,
|
|
stdin=subprocess.PIPE,
|
|
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)
|