Merge pull request #52 from droans/download-local-images

Add support to download local images

Author: droans

README.md

@@ -112,3 +112,23 @@ media_player.music_assistant_speaker:
 ## Configuration
 
 The integration should automatically detect the active Music Assistant instance and integration. If it does not, add as you normally would from the "Devices & Services" section in the Home Assistant Settings.
+
+
+# FAQs
+
+## I use a local provider (eg, Filesystem, Plex, Jellyfin, etc) and my images aren't showing up! What gives?!
+
+Local music providers are a bit different than cloud. When you are using Plex or Jellyfin, the image returned is an HTTP URL for their local IP address. This is problematic - most users access Home Assistant via HTTP**S** and modern browsers prohibit mixed content (insecure content on secure sites). For filesystem providers, it's even more difficult as Music Assistant returns their path on the filesystem instead of a URL.
+
+However, there is a workaround!
+
+You may enable the `download_local` option by navigating to the integration's listing in Home Assistant and selecting the cog next to the entry. When this is enabled, the integration will attempt to download and encode the image for any item which does not have any images marked as `remotely_accessible`.
+
+This option will then return a new attribute for these queue items labeled `local_image_encoded`. Custom cards can then utilize this in their code in place of the image URL.
+
+### WARNINGS
+
+* This is not a cure-all and should not be enabled unless you need it.
+* This will not have any effect unless any frontend card supports it.
+* Loading the integration and updating the queue WILL take much longer. Each item must be downloaded and converted. This is NOT a quick process. Depending on your server, this may take between 2-20 seconds per item.
+* This requires that Home Assistant can directly access the Music Assistant server along with the local provider.

custom_components/mass_queue/__init__.py

@@ -29,7 +29,7 @@
 )
 from .const import DOMAIN, LOGGER
 from .services import register_actions
-from .utils import download_images
+from .utils import api_download_and_encode_image, download_images
 
 if TYPE_CHECKING:
     from homeassistant.core import HomeAssistant
@@ -118,10 +118,11 @@ async def on_hass_stop(event: Event) -> None:  # noqa: ARG001
         raise ConfigEntryNotReady(exc) from err
 
     # store the listen task and mass client in the entry data
-    actions = await setup_controller_and_actions(hass, mass)
+    actions = await setup_controller_and_actions(hass, mass, entry)
     register_actions(hass)
     entry.runtime_data = MusicAssistantQueueEntryData(mass, actions, listen_task)
     websocket_api.async_register_command(hass, download_images)
+    websocket_api.async_register_command(hass, api_download_and_encode_image)
 
     # If the listen task is already failed, we need to raise ConfigEntryNotReady
     if listen_task.done() and (listen_error := listen_task.exception()) is not None:

custom_components/mass_queue/actions.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING
 
-from homeassistant.config_entries import ConfigEntryState
+from homeassistant.config_entries import ConfigEntry, ConfigEntryState
 from homeassistant.core import (
     HomeAssistant,
     ServiceCall,
@@ -26,6 +26,7 @@
     ATTR_LIMIT,
     ATTR_LIMIT_AFTER,
     ATTR_LIMIT_BEFORE,
+    ATTR_LOCAL_IMAGE_ENCODED,
     ATTR_MEDIA_ALBUM_NAME,
     ATTR_MEDIA_ARTIST,
     ATTR_MEDIA_CONTENT_ID,
@@ -36,9 +37,11 @@
     ATTR_PROVIDERS,
     ATTR_QUEUE_ID,
     ATTR_QUEUE_ITEM_ID,
+    CONF_DOWNLOAD_LOCAL,
     DEFAULT_QUEUE_ITEMS_LIMIT,
     DEFAULT_QUEUE_ITEMS_OFFSET,
     DOMAIN,
+    LOGGER,
     SERVICE_GET_QUEUE_ITEMS,
     SERVICE_GET_RECOMMENDATIONS,
     SERVICE_MOVE_QUEUE_ITEM_DOWN,
@@ -60,7 +63,9 @@
     REMOVE_QUEUE_ITEM_SERVICE_SCHEMA,
     SEND_COMMAND_SERVICE_SCHEMA,
 )
-from .utils import find_image
+from .utils import (
+    find_image,
+)
 
 if TYPE_CHECKING:
     from music_assistant_client import MusicAssistantClient
@@ -71,11 +76,18 @@
 class MassQueueActions:
     """Class to manage Music Assistant actions without passing `hass` and `mass_client` each time."""
 
-    def __init__(self, hass: HomeAssistant, mass_client: MusicAssistantClient):
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        mass_client: MusicAssistantClient,
+        config_entry: ConfigEntry,
+    ):
         """Initialize class."""
         self._hass: HomeAssistant = hass
         self._client: MusicAssistantClient = mass_client
-        self._controller = MassQueueController(self._hass, self._client)
+        self._controller = MassQueueController(self._hass, self._client, config_entry)
+        self._config_entry = config_entry
+        self._download_local = config_entry.options.get(CONF_DOWNLOAD_LOCAL)
 
     def setup_controller(self):
         """Setup Music Assistant controller."""
@@ -161,9 +173,9 @@ async def get_active_queue(self, entity_id: str):
         queue_id = self.get_queue_id(entity_id)
         return await self._client.player_queues.get_active_queue(queue_id)
 
-    def _format_queue_item(self, queue_item: dict) -> dict:
+    async def _format_queue_item(self, queue_item: dict) -> dict:
         """Format list of queue items for response."""
-        queue_item = queue_item.to_dict()
+        LOGGER.debug(f"Got queue item with keys {queue_item.keys()}")
         media = queue_item["media_item"]
 
         queue_item_id = queue_item["queue_item_id"]
@@ -172,6 +184,7 @@ def _format_queue_item(self, queue_item: dict) -> dict:
         media_album_name = "" if media_album is None else media_album.get("name", "")
         media_content_id = media["uri"]
         media_image = find_image(queue_item) or ""
+        local_image_encoded = queue_item.get(ATTR_LOCAL_IMAGE_ENCODED)
         favorite = media["favorite"]
 
         artists = media["artists"]
@@ -188,6 +201,9 @@ def _format_queue_item(self, queue_item: dict) -> dict:
                 ATTR_FAVORITE: favorite,
             },
         )
+        if local_image_encoded:
+            response[ATTR_LOCAL_IMAGE_ENCODED] = local_image_encoded
+        LOGGER.debug(f"Sending back response with keys {response.keys()}")
         return response
 
     async def send_command(self, call: ServiceCall) -> ServiceResponse:
@@ -224,7 +240,7 @@ async def get_queue_items(self, call: ServiceCall) -> ServiceResponse:
         offset = max(offset, 0)
         queue_items = await self._controller.player_queue(queue_id, limit, offset)
         response: ServiceResponse = {
-            entity_id: [self._format_queue_item(item) for item in queue_items],
+            entity_id: [await self._format_queue_item(item) for item in queue_items],
         }
         return response
 
@@ -325,8 +341,9 @@ def _get_music_assistant_client(
 async def setup_controller_and_actions(
     hass: HomeAssistant,
     mass_client: MusicAssistantClient,
+    entry: ConfigEntry,
 ) -> MassQueueActions:
     """Initialize client and actions class, add actions to Home Assistant."""
-    actions = MassQueueActions(hass, mass_client)
+    actions = MassQueueActions(hass, mass_client, entry)
     actions.setup_controller()
     return actions

custom_components/mass_queue/config_flow.py

@@ -5,8 +5,15 @@
 from typing import TYPE_CHECKING, Any
 
 import voluptuous as vol
-from homeassistant.config_entries import SOURCE_IGNORE, ConfigFlow, ConfigFlowResult
+from homeassistant.config_entries import (
+    SOURCE_IGNORE,
+    ConfigEntry,
+    ConfigFlow,
+    ConfigFlowResult,
+    OptionsFlowWithReload,
+)
 from homeassistant.const import CONF_URL
+from homeassistant.core import callback
 from homeassistant.helpers import aiohttp_client
 from music_assistant_client import MusicAssistantClient
 from music_assistant_client.exceptions import (
@@ -16,7 +23,11 @@
 )
 from music_assistant_models.api import ServerInfoMessage
 
-from .const import DOMAIN, LOGGER
+from .const import (
+    CONF_DOWNLOAD_LOCAL,
+    DOMAIN,
+    LOGGER,
+)
 
 if TYPE_CHECKING:
     from homeassistant.core import HomeAssistant
@@ -25,6 +36,7 @@
 
 DEFAULT_URL = "http://mass.local:8095"
 DEFAULT_TITLE = "Music Assistant Queue Items"
+DEFAULT_DOWNLOAD_LOCAL = False
 
 
 def get_manual_schema(user_input: dict[str, Any]) -> vol.Schema:
@@ -90,6 +102,7 @@ async def async_step_user(
                     data={
                         CONF_URL: user_input[CONF_URL],
                     },
+                    options={CONF_DOWNLOAD_LOCAL: DEFAULT_DOWNLOAD_LOCAL},
                 )
 
             return self.async_show_form(
@@ -164,9 +177,50 @@ async def async_step_discovery_confirm(
                 data={
                     CONF_URL: self.server_info.base_url,
                 },
+                options={CONF_DOWNLOAD_LOCAL: DEFAULT_DOWNLOAD_LOCAL},
             )
         self._set_confirm_only()
         return self.async_show_form(
             step_id="discovery_confirm",
             description_placeholders={"url": self.server_info.base_url},
         )
+
+    @staticmethod
+    @callback
+    def async_get_options_flow(
+        config_entry: ConfigEntry,
+    ) -> OptionsFlowHandler:
+        """Gets the options flow for this handler."""
+        LOGGER.debug("Starting options flow.")
+        return OptionsFlowHandler(config_entry)
+
+
+class OptionsFlowHandler(OptionsFlowWithReload):
+    """Options config flow for Music Assistant Queue Actions."""
+
+    def __init__(self, config_entry: ConfigEntry) -> None:
+        """Initialize options handler."""
+        self._config_entry = config_entry
+        self._download_local = config_entry.options.get(
+            CONF_DOWNLOAD_LOCAL,
+            DEFAULT_DOWNLOAD_LOCAL,
+        )
+
+    async def async_step_init(self, user_input=None) -> ConfigFlowResult:
+        """Manage options."""
+        if user_input is not None:
+            LOGGER.debug("User input is not none, submitting data")
+            entry = self.async_create_entry(data=self.config_entry.options | user_input)
+            LOGGER.debug(f"Created entry {entry} ({dir(entry)})")
+            return entry
+        LOGGER.debug("User input is none, showing form...")
+        default_download = self._download_local
+        data_schema = vol.Schema(
+            {
+                vol.Required(CONF_DOWNLOAD_LOCAL, default=default_download): bool,
+            },
+        )
+        return self.async_show_form(
+            step_id="init",
+            data_schema=data_schema,
+        )

custom_components/mass_queue/const.py

@@ -15,6 +15,7 @@
 SERVICE_UNFAVORITE_CURRENT_ITEM = "unfavorite_current_item"
 ATTR_QUEUE_ID = "active_queue"
 ATTR_CONFIG_ENTRY_ID = "config_entry_id"
+ATTR_LOCAL_IMAGE_ENCODED = "local_image_encoded"
 ATTR_LIMIT = "limit"
 ATTR_LIMIT_AFTER = "limit_after"
 ATTR_LIMIT_BEFORE = "limit_before"
@@ -31,6 +32,9 @@
 ATTR_DATA = "data"
 ATTR_FAVORITE = "favorite"
 ATTR_PROVIDERS = "providers"
+
+CONF_DOWNLOAD_LOCAL = "download_local"
+
 LOGGER = logging.getLogger(__package__)
 
 DEFAULT_QUEUE_ITEMS_LIMIT = 500