Skip to content

Add config.update_entity and config.remove_entity services #86281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add config.update_entity and config.remove_entity services #86281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
233 changes: 179 additions & 54 deletions homeassistant/components/config/entity_registry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,66 @@
import voluptuous as vol

from homeassistant import config_entries
from homeassistant.auth.permissions.const import CAT_ENTITIES, POLICY_EDIT
from homeassistant.components import websocket_api
from homeassistant.components.websocket_api import ERR_NOT_FOUND
from homeassistant.components.websocket_api.decorators import require_admin
from homeassistant.const import (
ATTR_AREA_ID,
ATTR_DEVICE_CLASS,
ATTR_ENTITY_ID,
ATTR_ICON,
ATTR_NAME,
)
import homeassistant.core as ha
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import NoEntitySpecifiedError, Unauthorized, UnknownUser
from homeassistant.helpers import (
config_validation as cv,
device_registry as dr,
entity_registry as er,
)

DOMAIN = "config"

ATTR_ALIASES = "aliases"
ATTR_AREA = "area"
ATTR_DISABLED = "disabled"
ATTR_DISABLED_BY = "disabled_by"
ATTR_HIDDEN = "hidden"
ATTR_HIDDEN_BY = "hidden_by"
ATTR_OPTIONS = "options"
ATTR_OPTIONS_DOMAIN = "options_domain"
ATTR_NEW_ENTITY_ID = "new_entity_id"
SERVICE_UPDATE_ENTITY = "update_entity"
SERVICE_REMOVE_ENTITY = "remove_entity"

SCHEMA_UPDATE_ENTITY_COMMON = {
vol.Required(ATTR_ENTITY_ID): cv.entity_id,
# If passed in, we update value. Passing None will remove old value.
vol.Optional(ATTR_ALIASES): vol.All(cv.ensure_list, [str]),
vol.Optional(ATTR_AREA_ID): vol.Any(str, None),
vol.Optional(ATTR_DEVICE_CLASS): vol.Any(str, None),
vol.Optional(ATTR_ICON): vol.Any(str, None),
vol.Optional(ATTR_NAME): vol.Any(str, None),
vol.Optional(ATTR_NEW_ENTITY_ID): str,
vol.Inclusive(ATTR_OPTIONS_DOMAIN, "entity_option"): str,
vol.Inclusive(ATTR_OPTIONS, "entity_option"): vol.Any(None, dict),
}
SCHEMA_UPDATE_ENTITY = vol.Schema(
{
**SCHEMA_UPDATE_ENTITY_COMMON,
vol.Optional(ATTR_DISABLED): vol.Any(bool, None),
vol.Optional(ATTR_HIDDEN): vol.Any(bool, None),
}
)

SCHEMA_REMOVE_ENTITY = vol.Schema(
{
vol.Required(ATTR_ENTITY_ID): cv.entity_ids,
}
)


async def async_setup(hass: HomeAssistant) -> bool:
"""Enable the Entity Registry views."""
Expand All @@ -25,6 +75,82 @@ async def async_setup(hass: HomeAssistant) -> bool:
websocket_api.async_register_command(hass, websocket_get_entities)
websocket_api.async_register_command(hass, websocket_update_entity)
websocket_api.async_register_command(hass, websocket_remove_entity)

async def async_handle_update_entity_service(call: ha.ServiceCall) -> None:
"""Service handler for updating an entity."""
if call.context.user_id:
user = await hass.auth.async_get_user(call.context.user_id)

if user is None:
raise UnknownUser(
context=call.context,
permission=POLICY_EDIT,
user_id=call.context.user_id,
)

if not user.permissions.check_entity(
call.data[ATTR_ENTITY_ID], POLICY_EDIT
):
raise Unauthorized(
context=call.context,
permission=POLICY_EDIT,
user_id=call.context.user_id,
perm_category=CAT_ENTITIES,
)

data = dict(call.data)

disabled = data.get(ATTR_DISABLED)
if disabled is not None:
data[ATTR_DISABLED_BY] = er.RegistryEntryDisabler.USER if disabled else None
del data[ATTR_DISABLED]

hidden = data.get(ATTR_HIDDEN)
if hidden is not None:
data[ATTR_HIDDEN_BY] = er.RegistryEntryHider.USER if hidden else None
del data[ATTR_HIDDEN]

update_entity(hass, data)

hass.services.async_register(
DOMAIN,
SERVICE_UPDATE_ENTITY,
async_handle_update_entity_service,
schema=SCHEMA_UPDATE_ENTITY,
)

async def async_handle_remove_entity_service(call: ha.ServiceCall) -> None:
"""Service handler for removing an entity."""
entity_ids = call.data[ATTR_ENTITY_ID]
if call.context.user_id:
user = await hass.auth.async_get_user(call.context.user_id)

if user is None:
raise UnknownUser(
context=call.context,
permission=POLICY_EDIT,
user_id=call.context.user_id,
)

for entity_id in entity_ids:
if not user.permissions.check_entity(entity_id, POLICY_EDIT):
raise Unauthorized(
context=call.context,
permission=POLICY_EDIT,
user_id=call.context.user_id,
perm_category=CAT_ENTITIES,
)

for entity_id in entity_ids:
remove_entity(hass, entity_id)

hass.services.async_register(
DOMAIN,
SERVICE_REMOVE_ENTITY,
async_handle_remove_entity_service,
schema=SCHEMA_REMOVE_ENTITY,
)

return True


Expand Down Expand Up @@ -114,33 +240,24 @@ def websocket_get_entities(
@require_admin
@websocket_api.websocket_command(
{
**SCHEMA_UPDATE_ENTITY_COMMON,
vol.Required("type"): "config/entity_registry/update",
vol.Required("entity_id"): cv.entity_id,
# If passed in, we update value. Passing None will remove old value.
vol.Optional("aliases"): list,
vol.Optional("area_id"): vol.Any(str, None),
vol.Optional("device_class"): vol.Any(str, None),
vol.Optional("icon"): vol.Any(str, None),
vol.Optional("name"): vol.Any(str, None),
vol.Optional("new_entity_id"): str,
# We only allow setting disabled_by user via API.
vol.Optional("disabled_by"): vol.Any(
vol.Optional(ATTR_DISABLED_BY): vol.Any(
None,
vol.All(
vol.Coerce(er.RegistryEntryDisabler),
er.RegistryEntryDisabler.USER.value,
),
),
# We only allow setting hidden_by user via API.
vol.Optional("hidden_by"): vol.Any(
vol.Optional(ATTR_HIDDEN_BY): vol.Any(
None,
vol.All(
vol.Coerce(er.RegistryEntryHider),
er.RegistryEntryHider.USER.value,
),
),
vol.Inclusive("options_domain", "entity_option"): str,
vol.Inclusive("options", "entity_option"): vol.Any(None, dict),
}
)
@callback
Expand All @@ -153,25 +270,40 @@ def websocket_update_entity(

Async friendly.
"""
try:
result = update_entity(hass, msg)
connection.send_result(msg["id"], result)
except NoEntitySpecifiedError as err:
connection.send_message(
websocket_api.error_message(msg["id"], ERR_NOT_FOUND, str(err))
)
except ValueError as err:
connection.send_message(
websocket_api.error_message(msg["id"], "invalid_info", str(err))
)


def update_entity(
hass: HomeAssistant,
msg: dict[str, Any],
) -> dict[str, Any]:
"""Handle update entity."""
registry = er.async_get(hass)

entity_id = msg["entity_id"]
if not (entity_entry := registry.async_get(entity_id)):
connection.send_message(
websocket_api.error_message(msg["id"], ERR_NOT_FOUND, "Entity not found")
)
return
raise NoEntitySpecifiedError(f"Entity {entity_id} not found")

changes = {}

for key in (
"area_id",
"device_class",
"disabled_by",
"hidden_by",
"icon",
"name",
"new_entity_id",
ATTR_AREA_ID,
ATTR_DEVICE_CLASS,
ATTR_DISABLED_BY,
ATTR_HIDDEN_BY,
ATTR_ICON,
ATTR_NAME,
ATTR_NEW_ENTITY_ID,
):
if key in msg:
changes[key] = msg[key]
Expand All @@ -186,35 +318,18 @@ def websocket_update_entity(
device_registry = dr.async_get(hass)
device = device_registry.async_get(entity_entry.device_id)
if device and device.disabled:
connection.send_message(
websocket_api.error_message(
msg["id"], "invalid_info", "Device is disabled"
)
)
return
raise ValueError("Device is disabled")

try:
if changes:
entity_entry = registry.async_update_entity(entity_id, **changes)
except ValueError as err:
connection.send_message(
websocket_api.error_message(msg["id"], "invalid_info", str(err))
)
return
if changes:
entity_entry = registry.async_update_entity(entity_id, **changes)

if "new_entity_id" in msg:
entity_id = msg["new_entity_id"]

try:
if "options_domain" in msg:
entity_entry = registry.async_update_entity_options(
entity_id, msg["options_domain"], msg["options"]
)
except ValueError as err:
connection.send_message(
websocket_api.error_message(msg["id"], "invalid_info", str(err))
if ATTR_OPTIONS_DOMAIN in msg:
entity_entry = registry.async_update_entity_options(
entity_id, msg[ATTR_OPTIONS_DOMAIN], msg[ATTR_OPTIONS]
)
return

result: dict[str, Any] = {"entity_entry": _entry_ext_dict(entity_entry)}
if "disabled_by" in changes and changes["disabled_by"] is None:
Expand All @@ -227,7 +342,7 @@ def websocket_update_entity(
result["require_restart"] = True
else:
result["reload_delay"] = config_entries.RELOAD_AFTER_UPDATE_DELAY
connection.send_result(msg["id"], result)
return result


@require_admin
Expand All @@ -247,16 +362,26 @@ def websocket_remove_entity(

Async friendly.
"""
registry = er.async_get(hass)

if msg["entity_id"] not in registry.entities:
try:
remove_entity(hass, msg["entity_id"])
connection.send_message(websocket_api.result_message(msg["id"]))
except NoEntitySpecifiedError as err:
connection.send_message(
websocket_api.error_message(msg["id"], ERR_NOT_FOUND, "Entity not found")
websocket_api.error_message(msg["id"], ERR_NOT_FOUND, str(err))
)
return

registry.async_remove(msg["entity_id"])
connection.send_message(websocket_api.result_message(msg["id"]))

def remove_entity(
hass: HomeAssistant,
entity_id: str,
) -> None:
"""Handle remove entity."""
registry = er.async_get(hass)

if entity_id not in registry.entities:
raise NoEntitySpecifiedError(f"Entity {entity_id} not found")

registry.async_remove(entity_id)


@callback
Expand Down
Loading