Improve script validation (#32461)
This commit is contained in:
1 parent
da7c5518f3
commit
6a21afa2a8
5 files changed
+141
-89
No files matched your search
@@ -39,18 +39,27 @@ from homeassistant.const import (
|
||||
CONF_ALIAS,
|
||||
CONF_BELOW,
|
||||
CONF_CONDITION,
|
||||
CONF_CONTINUE_ON_TIMEOUT,
|
||||
CONF_DELAY,
|
||||
CONF_DEVICE_ID,
|
||||
CONF_DOMAIN,
|
||||
CONF_ENTITY_ID,
|
||||
CONF_ENTITY_NAMESPACE,
|
||||
CONF_EVENT,
|
||||
CONF_EVENT_DATA,
|
||||
CONF_EVENT_DATA_TEMPLATE,
|
||||
CONF_FOR,
|
||||
CONF_PLATFORM,
|
||||
CONF_SCAN_INTERVAL,
|
||||
CONF_SCENE,
|
||||
CONF_SERVICE,
|
||||
CONF_SERVICE_TEMPLATE,
|
||||
CONF_STATE,
|
||||
CONF_TIMEOUT,
|
||||
CONF_UNIT_SYSTEM_IMPERIAL,
|
||||
CONF_UNIT_SYSTEM_METRIC,
|
||||
CONF_VALUE_TEMPLATE,
|
||||
CONF_WAIT_TEMPLATE,
|
||||
ENTITY_MATCH_ALL,
|
||||
ENTITY_MATCH_NONE,
|
||||
SUN_EVENT_SUNRISE,
|
||||
@@ -722,7 +731,7 @@ def key_value_schemas(
|
||||
|
||||
if key_value not in value_schemas:
|
||||
raise vol.Invalid(
|
||||
f"Unexpected key {key_value}. Expected {', '.join(value_schemas)}"
|
||||
f"Unexpected value for {key}: '{key_value}'. Expected {', '.join(value_schemas)}"
|
||||
)
|
||||
|
||||
return cast(Dict[str, Any], value_schemas[key_value](value))
|
||||
@@ -800,9 +809,9 @@ def make_entity_service_schema(
|
||||
EVENT_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_ALIAS): string,
|
||||
vol.Required("event"): string,
|
||||
vol.Optional("event_data"): dict,
|
||||
vol.Optional("event_data_template"): {match_all: template_complex},
|
||||
vol.Required(CONF_EVENT): string,
|
||||
vol.Optional(CONF_EVENT_DATA): dict,
|
||||
vol.Optional(CONF_EVENT_DATA_TEMPLATE): {match_all: template_complex},
|
||||
}
|
||||
)
|
||||
|
||||
@@ -810,14 +819,14 @@ SERVICE_SCHEMA = vol.All(
|
||||
vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_ALIAS): string,
|
||||
vol.Exclusive("service", "service name"): service,
|
||||
vol.Exclusive("service_template", "service name"): template,
|
||||
vol.Exclusive(CONF_SERVICE, "service name"): service,
|
||||
vol.Exclusive(CONF_SERVICE_TEMPLATE, "service name"): template,
|
||||
vol.Optional("data"): dict,
|
||||
vol.Optional("data_template"): {match_all: template_complex},
|
||||
vol.Optional(CONF_ENTITY_ID): comp_entity_ids,
|
||||
}
|
||||
),
|
||||
has_at_least_one_key("service", "service_template"),
|
||||
has_at_least_one_key(CONF_SERVICE, CONF_SERVICE_TEMPLATE),
|
||||
)
|
||||
|
||||
NUMERIC_STATE_CONDITION_SCHEMA = vol.All(
|
||||
@@ -943,7 +952,7 @@ CONDITION_SCHEMA: vol.Schema = key_value_schemas(
|
||||
_SCRIPT_DELAY_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_ALIAS): string,
|
||||
vol.Required("delay"): vol.Any(
|
||||
vol.Required(CONF_DELAY): vol.Any(
|
||||
vol.All(time_period, positive_timedelta), template, template_complex
|
||||
),
|
||||
}
|
||||
@@ -952,9 +961,9 @@ _SCRIPT_DELAY_SCHEMA = vol.Schema(
|
||||
_SCRIPT_WAIT_TEMPLATE_SCHEMA = vol.Schema(
|
||||
{
|
||||
vol.Optional(CONF_ALIAS): string,
|
||||
vol.Required("wait_template"): template,
|
||||
vol.Required(CONF_WAIT_TEMPLATE): template,
|
||||
vol.Optional(CONF_TIMEOUT): vol.All(time_period, positive_timedelta),
|
||||
vol.Optional("continue_on_timeout"): boolean,
|
||||
vol.Optional(CONF_CONTINUE_ON_TIMEOUT): boolean,
|
||||
}
|
||||
)
|
||||
|
||||
@@ -964,19 +973,57 @@ DEVICE_ACTION_BASE_SCHEMA = vol.Schema(
|
||||
|
||||
DEVICE_ACTION_SCHEMA = DEVICE_ACTION_BASE_SCHEMA.extend({}, extra=vol.ALLOW_EXTRA)
|
||||
|
||||
_SCRIPT_SCENE_SCHEMA = vol.Schema({vol.Required("scene"): entity_domain("scene")})
|
||||
_SCRIPT_SCENE_SCHEMA = vol.Schema({vol.Required(CONF_SCENE): entity_domain("scene")})
|
||||
|
||||
SCRIPT_SCHEMA = vol.All(
|
||||
ensure_list,
|
||||
[
|
||||
vol.Any(
|
||||
SERVICE_SCHEMA,
|
||||
_SCRIPT_DELAY_SCHEMA,
|
||||
_SCRIPT_WAIT_TEMPLATE_SCHEMA,
|
||||
EVENT_SCHEMA,
|
||||
CONDITION_SCHEMA,
|
||||
DEVICE_ACTION_SCHEMA,
|
||||
_SCRIPT_SCENE_SCHEMA,
|
||||
)
|
||||
],
|
||||
)
|
||||
SCRIPT_ACTION_DELAY = "delay"
|
||||
SCRIPT_ACTION_WAIT_TEMPLATE = "wait_template"
|
||||
SCRIPT_ACTION_CHECK_CONDITION = "condition"
|
||||
SCRIPT_ACTION_FIRE_EVENT = "event"
|
||||
SCRIPT_ACTION_CALL_SERVICE = "call_service"
|
||||
SCRIPT_ACTION_DEVICE_AUTOMATION = "device"
|
||||
SCRIPT_ACTION_ACTIVATE_SCENE = "scene"
|
||||
|
||||
|
||||
def determine_script_action(action: dict) -> str:
|
||||
"""Determine action type."""
|
||||
if CONF_DELAY in action:
|
||||
return SCRIPT_ACTION_DELAY
|
||||
|
||||
if CONF_WAIT_TEMPLATE in action:
|
||||
return SCRIPT_ACTION_WAIT_TEMPLATE
|
||||
|
||||
if CONF_CONDITION in action:
|
||||
return SCRIPT_ACTION_CHECK_CONDITION
|
||||
|
||||
if CONF_EVENT in action:
|
||||
return SCRIPT_ACTION_FIRE_EVENT
|
||||
|
||||
if CONF_DEVICE_ID in action:
|
||||
return SCRIPT_ACTION_DEVICE_AUTOMATION
|
||||
|
||||
if CONF_SCENE in action:
|
||||
return SCRIPT_ACTION_ACTIVATE_SCENE
|
||||
|
||||
return SCRIPT_ACTION_CALL_SERVICE
|
||||
|
||||
|
||||
ACTION_TYPE_SCHEMAS: Dict[str, Callable[[Any], dict]] = {
|
||||
SCRIPT_ACTION_CALL_SERVICE: SERVICE_SCHEMA,
|
||||
SCRIPT_ACTION_DELAY: _SCRIPT_DELAY_SCHEMA,
|
||||
SCRIPT_ACTION_WAIT_TEMPLATE: _SCRIPT_WAIT_TEMPLATE_SCHEMA,
|
||||
SCRIPT_ACTION_FIRE_EVENT: EVENT_SCHEMA,
|
||||
SCRIPT_ACTION_CHECK_CONDITION: CONDITION_SCHEMA,
|
||||
SCRIPT_ACTION_DEVICE_AUTOMATION: DEVICE_ACTION_SCHEMA,
|
||||
SCRIPT_ACTION_ACTIVATE_SCENE: _SCRIPT_SCENE_SCHEMA,
|
||||
}
|
||||
|
||||
|
||||
def script_action(value: Any) -> dict:
|
||||
"""Validate a script action."""
|
||||
if not isinstance(value, dict):
|
||||
raise vol.Invalid("expected dictionary")
|
||||
|
||||
return ACTION_TYPE_SCHEMAS[determine_script_action(value)](value)
|
||||
|
||||
|
||||
SCRIPT_SCHEMA = vol.All(ensure_list, [script_action])
|
||||
Reference in new issue
Block a user