Add unfavorite item action

Author: droans

custom_components/mass_queue/actions.py

@@ -14,6 +14,10 @@
 )
 from homeassistant.exceptions import ServiceValidationError
 from homeassistant.helpers import entity_registry as er
+from music_assistant_models.errors import (
+    InvalidCommand,
+    MediaNotFoundError,
+)
 
 from .const import (
     ATTR_COMMAND,
@@ -59,7 +63,6 @@
 
     from . import MassQueueEntryData
 
-
 class MassQueueActions:
     """Class to manage Music Assistant actions without passing `hass` and `mass_client` each time."""
 
@@ -253,7 +256,24 @@ async def move_queue_item_next(self, call: ServiceCall) -> ServiceResponse:
             queue_id,
             queue_item_id,
         )
-
+    async def unfavorite_item(self, call: ServiceCall) -> ServiceResponse:
+        """Unfavorites currently playing item in queue."""
+        entity_id = call.data[ATTR_PLAYER_ENTITY]
+        attrs = self._hass.states.get(entity_id).attributes
+        content_id = attrs.get(ATTR_MEDIA_CONTENT_ID)
+        if not content_id:
+            msg = f"Cannot find media with content id {content_id}"
+            raise MediaNotFoundError(msg)
+        provider = content_id.split("://")[0]
+        if provider != "library":
+            msg = f"Unfavorite can only apply to library media items, not from provider {provider}"
+            raise InvalidCommand(msg)
+        item_id = str(content_id.split("/")[-1])
+        await self._client.send_command(
+            "music/favorites/remove_item",
+            media_type="track",
+            library_item_id=item_id,
+        )
 
 @callback
 def get_music_assistant_client(

custom_components/mass_queue/const.py

@@ -11,7 +11,7 @@
 SERVICE_MOVE_QUEUE_ITEM_DOWN = "move_queue_item_down"
 SERVICE_MOVE_QUEUE_ITEM_NEXT = "move_queue_item_next"
 SERVICE_SEND_COMMAND = "send_command"
-
+SERVICE_UNFAVORITE_CURRENT_ITEM = "unfavorite_current_item"
 ATTR_QUEUE_ID = "active_queue"
 ATTR_CONFIG_ENTRY_ID = "config_entry_id"
 ATTR_LIMIT = "limit"

custom_components/mass_queue/schemas.py

@@ -92,3 +92,9 @@
         vol.Required(ATTR_CONFIG_ENTRY_ID): str,
     },
 )
+
+UNFAVORITE_CURRENT_ITEM_SERVICE_SCHEMA = vol.Schema(
+    {
+        vol.Required(ATTR_PLAYER_ENTITY): str,
+    },
+)

custom_components/mass_queue/services.py

@@ -25,6 +25,7 @@
     SERVICE_PLAY_QUEUE_ITEM,
     SERVICE_REMOVE_QUEUE_ITEM,
     SERVICE_SEND_COMMAND,
+    SERVICE_UNFAVORITE_CURRENT_ITEM,
 )
 from .schemas import (
     MOVE_QUEUE_ITEM_DOWN_SERVICE_SCHEMA,
@@ -34,6 +35,7 @@
     QUEUE_ITEMS_SERVICE_SCHEMA,
     REMOVE_QUEUE_ITEM_SERVICE_SCHEMA,
     SEND_COMMAND_SERVICE_SCHEMA,
+    UNFAVORITE_CURRENT_ITEM_SERVICE_SCHEMA,
 )
 
 if TYPE_CHECKING:
@@ -94,6 +96,13 @@ def register_actions(hass) -> None:
         schema=SEND_COMMAND_SERVICE_SCHEMA,
         supports_response=SupportsResponse.OPTIONAL,
     )
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_UNFAVORITE_CURRENT_ITEM,
+        unfavorite_current_item,
+        schema=UNFAVORITE_CURRENT_ITEM_SERVICE_SCHEMA,
+        supports_response=SupportsResponse.NONE,
+    )
 
 
 def _get_mass_entity_config_entry_id(hass, entity_id):
@@ -204,3 +213,10 @@ async def send_command(call: ServiceCall):
     entry = hass.config_entries.async_get_entry(entry_id)
     actions = entry.runtime_data.actions
     return await actions.send_command(call)
+
+async def unfavorite_current_item(call: ServiceCall):
+    """Service wrapper to unfavorite currently playing item."""
+    entity_id = call.data[ATTR_PLAYER_ENTITY]
+    hass = call.hass
+    actions = get_entity_actions_controller(hass, entity_id)
+    await actions.unfavorite_item(call)

custom_components/mass_queue/services.yaml

@@ -147,3 +147,14 @@ send_command:
       selector:
         config_entry:
           integration: mass_queue
+
+unfavorite_current_item:
+  fields:
+    entity:
+      name: Entity
+      description: Music Assistant Media Player Entity
+      required: true
+      selector:
+        entity:
+          domain: media_player
+          integration: music_assistant