Merge pull request #46 from droans/improve-image-search

Check all possible image attributes

Author: droans

custom_components/mass_queue/actions.py

@@ -57,6 +57,7 @@
     REMOVE_QUEUE_ITEM_SERVICE_SCHEMA,
     SEND_COMMAND_SERVICE_SCHEMA,
 )
+from .util import find_image
 
 if TYPE_CHECKING:
     from music_assistant_client import MusicAssistantClient
@@ -160,8 +161,7 @@ def _format_queue_item(self, queue_item: dict) -> dict:
         media_album = media.get("album")
         media_album_name = "" if media_album is None else media_album.get("name", "")
         media_content_id = media["uri"]
-        img = queue_item.get("image")
-        media_image = "" if img is None else img.get("path", "")
+        media_image = find_image(queue_item)
         favorite = media["favorite"]
 
         artists = media["artists"]

custom_components/mass_queue/utils.py

@@ -32,3 +32,68 @@ def get_queue_id_from_player_data(player_data):
     if current_media is None:
         return None
     return current_media.get("queue_id")
+
+
+def return_image_or_none(img_data: dict):
+    """Returns None if image is not present or not remotely accessible."""
+    if type(img_data) is dict:
+        img = img_data.get("path")
+        remote = img_data.get("remotely_accessible")
+        if remote:
+            return img
+    return None
+
+
+def search_image_list(images: list):
+    """Checks through a list of image data and attempts to find an image."""
+    result = None
+    for item in images:
+        image = return_image_or_none(item)
+        if image is not None:
+            result = image
+            break
+    return result
+
+
+def find_image_from_image(data: dict):
+    """Attempts to find the image via the image key."""
+    img_data = data.get("image")
+    return return_image_or_none(img_data)
+
+
+def find_image_from_metadata(data: dict):
+    """Attempts to find the image via the metadata key."""
+    media_item = data.get("media_item", {})
+    metadata = media_item.get("metadata", {})
+    img_data = metadata.get("images")
+    if img_data is None:
+        return None
+    return search_image_list(img_data)
+
+
+def find_image_from_album(data: dict):
+    """Attempts to find the image via the album key."""
+    album = data.get("album", {})
+    metadata = album.get("metadata", {})
+    img_data = metadata.get("images")
+    if img_data is None:
+        return None
+    return search_image_list(img_data)
+
+
+def find_image_from_artists(data: dict):
+    """Attempts to find the image via the artists key."""
+    artist = data.get("artist", {})
+    img_data = artist.get("image")
+    if img_data is list:
+        return search_image_list(img_data)
+    return return_image_or_none(img_data)
+
+
+def find_image(data: dict):
+    """Returns None if image is not present or not remotely accessible."""
+    from_image = find_image_from_image(data)
+    from_metadata = find_image_from_metadata(data)
+    from_album = find_image_from_album(data)
+    from_artists = find_image_from_artists(data)
+    return from_image or from_metadata or from_album or from_artists