Decouple media lookup from Plex play_media service (#35663)
* Decouple media lookup from play_media service * More explicit input/search validation, cleanup, more tests * Minor cleanup * Normalize media_type string in lookup call * Move key lookup, add tests via service calls * Always allow play_media service calls * No need to pass arguments to nested functions
This commit is contained in:
1 parent
6507951bb1
commit
59c112a3f2
4 files changed
+495
-104
No files matched your search
@@ -7,12 +7,9 @@ import requests.exceptions
|
||||
|
||||
from homeassistant.components.media_player import DOMAIN as MP_DOMAIN, MediaPlayerEntity
|
||||
from homeassistant.components.media_player.const import (
|
||||
MEDIA_TYPE_EPISODE,
|
||||
MEDIA_TYPE_MOVIE,
|
||||
MEDIA_TYPE_MUSIC,
|
||||
MEDIA_TYPE_PLAYLIST,
|
||||
MEDIA_TYPE_TVSHOW,
|
||||
MEDIA_TYPE_VIDEO,
|
||||
SUPPORT_NEXT_TRACK,
|
||||
SUPPORT_PAUSE,
|
||||
SUPPORT_PLAY,
|
||||
@@ -487,7 +484,7 @@ class PlexMediaPlayer(MediaPlayerEntity):
|
||||
| SUPPORT_VOLUME_MUTE
|
||||
)
|
||||
|
||||
return 0
|
||||
return SUPPORT_PLAY_MEDIA
|
||||
|
||||
def set_volume_level(self, volume):
|
||||
"""Set volume level, range 0..1."""
|
||||
@@ -561,32 +558,12 @@ class PlexMediaPlayer(MediaPlayerEntity):
|
||||
)
|
||||
return
|
||||
|
||||
media_type = media_type.lower()
|
||||
src = json.loads(media_id)
|
||||
if media_type == PLEX_DOMAIN and isinstance(src, int):
|
||||
try:
|
||||
media = self.plex_server.fetch_item(src)
|
||||
except plexapi.exceptions.NotFound:
|
||||
_LOGGER.error("Media for key %s not found", src)
|
||||
return
|
||||
shuffle = 0
|
||||
else:
|
||||
library = src.get("library_name")
|
||||
shuffle = src.get("shuffle", 0)
|
||||
media = None
|
||||
if isinstance(src, int):
|
||||
src = {"plex_key": src}
|
||||
|
||||
try:
|
||||
if media_type == MEDIA_TYPE_MUSIC:
|
||||
media = self._get_music_media(library, src)
|
||||
elif media_type == MEDIA_TYPE_EPISODE:
|
||||
media = self._get_tv_media(library, src)
|
||||
elif media_type == MEDIA_TYPE_PLAYLIST:
|
||||
media = self.plex_server.playlist(src["playlist_name"])
|
||||
elif media_type == MEDIA_TYPE_VIDEO:
|
||||
media = self.plex_server.library.section(library).get(src["video_name"])
|
||||
except plexapi.exceptions.NotFound:
|
||||
_LOGGER.error("Media could not be found: %s", media_id)
|
||||
return
|
||||
shuffle = src.pop("shuffle", 0)
|
||||
media = self.plex_server.lookup_media(media_type, **src)
|
||||
|
||||
if media is None:
|
||||
_LOGGER.error("Media could not be found: %s", media_id)
|
||||
@@ -600,79 +577,6 @@ class PlexMediaPlayer(MediaPlayerEntity):
|
||||
except requests.exceptions.ConnectTimeout:
|
||||
_LOGGER.error("Timed out playing on %s", self.name)
|
||||
|
||||
def _get_music_media(self, library_name, src):
|
||||
"""Find music media and return a Plex media object."""
|
||||
artist_name = src["artist_name"]
|
||||
album_name = src.get("album_name")
|
||||
track_name = src.get("track_name")
|
||||
track_number = src.get("track_number")
|
||||
|
||||
artist = self.plex_server.library.section(library_name).get(artist_name)
|
||||
|
||||
if album_name:
|
||||
album = artist.album(album_name)
|
||||
|
||||
if track_name:
|
||||
return album.track(track_name)
|
||||
|
||||
if track_number:
|
||||
for track in album.tracks():
|
||||
if int(track.index) == int(track_number):
|
||||
return track
|
||||
return None
|
||||
|
||||
return album
|
||||
|
||||
if track_name:
|
||||
return artist.searchTracks(track_name, maxresults=1)
|
||||
return artist
|
||||
|
||||
def _get_tv_media(self, library_name, src):
|
||||
"""Find TV media and return a Plex media object."""
|
||||
show_name = src["show_name"]
|
||||
season_number = src.get("season_number")
|
||||
episode_number = src.get("episode_number")
|
||||
target_season = None
|
||||
target_episode = None
|
||||
|
||||
show = self.plex_server.library.section(library_name).get(show_name)
|
||||
|
||||
if not season_number:
|
||||
return show
|
||||
|
||||
for season in show.seasons():
|
||||
if int(season.seasonNumber) == int(season_number):
|
||||
target_season = season
|
||||
break
|
||||
|
||||
if target_season is None:
|
||||
_LOGGER.error(
|
||||
"Season not found: %s\\%s - S%sE%s",
|
||||
library_name,
|
||||
show_name,
|
||||
str(season_number).zfill(2),
|
||||
str(episode_number).zfill(2),
|
||||
)
|
||||
else:
|
||||
if not episode_number:
|
||||
return target_season
|
||||
|
||||
for episode in target_season.episodes():
|
||||
if int(episode.index) == int(episode_number):
|
||||
target_episode = episode
|
||||
break
|
||||
|
||||
if target_episode is None:
|
||||
_LOGGER.error(
|
||||
"Episode not found: %s\\%s - S%sE%s",
|
||||
library_name,
|
||||
show_name,
|
||||
str(season_number).zfill(2),
|
||||
str(episode_number).zfill(2),
|
||||
)
|
||||
|
||||
return target_episode
|
||||
|
||||
@property
|
||||
def device_state_attributes(self):
|
||||
"""Return the scene state attributes."""
|
||||
|
||||
@@ -3,7 +3,7 @@ import logging
|
||||
import ssl
|
||||
from urllib.parse import urlparse
|
||||
|
||||
from plexapi.exceptions import Unauthorized
|
||||
from plexapi.exceptions import NotFound, Unauthorized
|
||||
import plexapi.myplex
|
||||
import plexapi.playqueue
|
||||
import plexapi.server
|
||||
@@ -11,6 +11,12 @@ from requests import Session
|
||||
import requests.exceptions
|
||||
|
||||
from homeassistant.components.media_player import DOMAIN as MP_DOMAIN
|
||||
from homeassistant.components.media_player.const import (
|
||||
MEDIA_TYPE_EPISODE,
|
||||
MEDIA_TYPE_MUSIC,
|
||||
MEDIA_TYPE_PLAYLIST,
|
||||
MEDIA_TYPE_VIDEO,
|
||||
)
|
||||
from homeassistant.const import CONF_TOKEN, CONF_URL, CONF_VERIFY_SSL
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.helpers.debounce import Debouncer
|
||||
@@ -25,6 +31,7 @@ from .const import (
|
||||
CONF_USE_EPISODE_ART,
|
||||
DEBOUNCE_TIMEOUT,
|
||||
DEFAULT_VERIFY_SSL,
|
||||
DOMAIN,
|
||||
PLEX_NEW_MP_SIGNAL,
|
||||
PLEX_UPDATE_MEDIA_PLAYER_SIGNAL,
|
||||
PLEX_UPDATE_SENSOR_SIGNAL,
|
||||
@@ -367,3 +374,157 @@ class PlexServer:
|
||||
def fetch_item(self, item):
|
||||
"""Fetch item from Plex server."""
|
||||
return self._plex_server.fetchItem(item)
|
||||
|
||||
def lookup_media(self, media_type, **kwargs):
|
||||
"""Lookup a piece of media."""
|
||||
media_type = media_type.lower()
|
||||
|
||||
if media_type == DOMAIN:
|
||||
key = kwargs["plex_key"]
|
||||
try:
|
||||
return self.fetch_item(key)
|
||||
except plexapi.exceptions.NotFound:
|
||||
_LOGGER.error("Media for key %s not found", key)
|
||||
return None
|
||||
|
||||
if media_type == MEDIA_TYPE_PLAYLIST:
|
||||
try:
|
||||
playlist_name = kwargs["playlist_name"]
|
||||
return self.playlist(playlist_name)
|
||||
except KeyError:
|
||||
_LOGGER.error("Must specify 'playlist_name' for this search")
|
||||
return None
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Playlist '%s' not found", playlist_name,
|
||||
)
|
||||
return None
|
||||
|
||||
try:
|
||||
library_name = kwargs["library_name"]
|
||||
library_section = self.library.section(library_name)
|
||||
except KeyError:
|
||||
_LOGGER.error("Must specify 'library_name' for this search")
|
||||
return None
|
||||
except NotFound:
|
||||
_LOGGER.error("Library '%s' not found", library_name)
|
||||
return None
|
||||
|
||||
def lookup_music():
|
||||
"""Search for music and return a Plex media object."""
|
||||
album_name = kwargs.get("album_name")
|
||||
track_name = kwargs.get("track_name")
|
||||
track_number = kwargs.get("track_number")
|
||||
|
||||
try:
|
||||
artist_name = kwargs["artist_name"]
|
||||
artist = library_section.get(artist_name)
|
||||
except KeyError:
|
||||
_LOGGER.error("Must specify 'artist_name' for this search")
|
||||
return None
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Artist '%s' not found in '%s'", artist_name, library_name
|
||||
)
|
||||
return None
|
||||
|
||||
if album_name:
|
||||
try:
|
||||
album = artist.album(album_name)
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Album '%s' by '%s' not found", album_name, artist_name
|
||||
)
|
||||
return None
|
||||
|
||||
if track_name:
|
||||
try:
|
||||
return album.track(track_name)
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Track '%s' on '%s' by '%s' not found",
|
||||
track_name,
|
||||
album_name,
|
||||
artist_name,
|
||||
)
|
||||
return None
|
||||
|
||||
if track_number:
|
||||
for track in album.tracks():
|
||||
if int(track.index) == int(track_number):
|
||||
return track
|
||||
|
||||
_LOGGER.error(
|
||||
"Track %d on '%s' by '%s' not found",
|
||||
track_number,
|
||||
album_name,
|
||||
artist_name,
|
||||
)
|
||||
return None
|
||||
return album
|
||||
|
||||
if track_name:
|
||||
try:
|
||||
return artist.get(track_name)
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Track '%s' by '%s' not found", track_name, artist_name
|
||||
)
|
||||
return None
|
||||
|
||||
return artist
|
||||
|
||||
def lookup_tv():
|
||||
"""Find TV media and return a Plex media object."""
|
||||
season_number = kwargs.get("season_number")
|
||||
episode_number = kwargs.get("episode_number")
|
||||
|
||||
try:
|
||||
show_name = kwargs["show_name"]
|
||||
show = library_section.get(show_name)
|
||||
except KeyError:
|
||||
_LOGGER.error("Must specify 'show_name' for this search")
|
||||
return None
|
||||
except NotFound:
|
||||
_LOGGER.error("Show '%s' not found in '%s'", show_name, library_name)
|
||||
return None
|
||||
|
||||
if not season_number:
|
||||
return show
|
||||
|
||||
try:
|
||||
season = show.season(int(season_number))
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Season %d of '%s' not found", season_number, show_name,
|
||||
)
|
||||
return None
|
||||
|
||||
if not episode_number:
|
||||
return season
|
||||
|
||||
try:
|
||||
return season.episode(episode=int(episode_number))
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Episode not found: %s - S%sE%s",
|
||||
show_name,
|
||||
str(season_number).zfill(2),
|
||||
str(episode_number).zfill(2),
|
||||
)
|
||||
return None
|
||||
|
||||
if media_type == MEDIA_TYPE_MUSIC:
|
||||
return lookup_music()
|
||||
if media_type == MEDIA_TYPE_EPISODE:
|
||||
return lookup_tv()
|
||||
if media_type == MEDIA_TYPE_VIDEO:
|
||||
try:
|
||||
video_name = kwargs["video_name"]
|
||||
return library_section.get(video_name)
|
||||
except KeyError:
|
||||
_LOGGER.error("Must specify 'video_name' for this search")
|
||||
except NotFound:
|
||||
_LOGGER.error(
|
||||
"Movie '%s' not found in '%s'", video_name, library_name,
|
||||
)
|
||||
Reference in new issue
Block a user