def test_server_info_public(self):
client = PublicEmbyClient(HOST)
response = client.get_server_info_public()
assert response.status_code == 200
server_info = response.json()
TestEmbyClient._assert_server_info(server_info)
class EmbyCroft(object):
def __init__(self,
host,
username,
password,
client_id='12345',
diagnostic=False):
self.host = EmbyCroft.normalize_host(host)
self.log = logging.getLogger(__name__)
self.version = "UNKNOWN"
self.set_version()
if not diagnostic:
self.client = EmbyClient(self.host,
username,
password,
device="Mycroft",
client="Emby Skill",
client_id=client_id,
version=self.version)
else:
self.client = PublicEmbyClient(self.host, client_id=client_id)
@staticmethod
def determine_intent(intent: dict):
"""
Determine the intent!
:param self:
:param intent:
:return:
"""
if 'media' in intent:
return intent['media'], IntentType.from_string('media')
elif 'artist' in intent:
return intent['artist'], IntentType.from_string('artist')
elif 'album' in intent:
return intent['album'], IntentType.from_string('album')
elif 'playlist' in intent:
return intent['playlist'], IntentType.from_string('playlist')
elif 'song' in intent:
return intent['song'], IntentType.from_string('song')
else:
return None
def handle_intent(self, intent: str, intent_type: IntentType):
"""
Returns songs for given intent if songs are found; none if not
:param intent_type:
:param intent:
:return:
"""
songs = []
if intent_type == IntentType.MEDIA:
# default to instant mix
songs = self.find_songs(intent)
elif intent_type == IntentType.ARTIST:
# return songs by artist
artist_items = self.search_artist(intent)
if len(artist_items) > 0:
songs = self.get_songs_by_artist(artist_items[0].id)
# shuffle by default for songs by artist
shuffle(songs)
elif intent_type == IntentType.ALBUM:
# return songs by album
album_items = self.search_album(intent)
if len(album_items) > 0:
songs = self.get_songs_by_album(album_items[0].id)
elif intent_type == IntentType.PLAYLIST:
# return songs in playlist
playlist_items = self.search_playlist(intent)
songs = self.get_songs_by_playlist(playlist_items[0].id)
elif intent_type == IntentType.SONG:
# find Song
song_items = self.search_song(intent)
if len(song_items) > 0:
songs = self.convert_to_playable_songs([song_items[0]])
return songs
def find_songs(self, media_name, media_type=None) -> []:
"""
This is the expected entry point for determining what songs to play
:param media_name:
:param media_type:
:return:
"""
songs = []
songs = self.instant_mix_for_media(media_name)
return songs
def search_artist(self, artist):
"""
Helper method to just search Emby for an artist
:param artist:
:return:
"""
return self.search(artist, [MediaItemType.ARTIST.value])
def search_album(self, artist):
"""
Helper method to just search Emby for an album
:param album:
:return:
"""
return self.search(artist, [MediaItemType.ALBUM.value])
def search_song(self, song):
"""
Helper method to just search Emby for songs
:param song:
:return:
"""
return self.search(song, [MediaItemType.SONG.value])
def search_playlist(self, playlist):
"""
Helper method to search Emby for a named playlist
:param playlist:
:return:
"""
return self.search(playlist, [MediaItemType.PLAYLIST.value])
def search(self, query, include_media_types=[]):
"""
Searches Emby from a given query
:param query:
:param include_media_types:
:return:
"""
response = self.client.search(query, include_media_types)
search_items = EmbyCroft.parse_search_hints_from_response(response)
return EmbyMediaItem.from_list(search_items)
def get_instant_mix_songs(self, item_id):
"""
Requests an instant mix from an Emby item id
and returns song uris to be played by the Audio Service
:param item_id:
:return:
"""
response = self.client.instant_mix(item_id)
queue_items = EmbyMediaItem.from_list(
EmbyCroft.parse_response(response))
song_uris = []
for item in queue_items:
song_uris.append(self.client.get_song_file(item.id))
return song_uris
def instant_mix_for_media(self, media_name):
"""
Method that takes in a media name (artist/song/album) and
returns an instant mix of song uris to be played
:param media_name:
:return:
"""
items = self.search(media_name)
if items is None:
items = []
songs = []
for item in items:
self.log.log(20, 'Instant Mix potential match: ' + item.name)
if len(songs) == 0:
songs = self.get_instant_mix_songs(item.id)
else:
break
return songs
def get_albums_by_artist(self, artist_id):
return self.client.get_albums_by_artist(artist_id)
def get_songs_by_album(self, album_id):
response = self.client.get_songs_by_album(album_id)
return self.convert_response_to_playable_songs(response)
def get_songs_by_artist(self, artist_id):
response = self.client.get_songs_by_artist(artist_id)
return self.convert_response_to_playable_songs(response)
def get_all_artists(self):
return self.client.get_all_artists()
def get_songs_by_playlist(self, playlist_id):
response = self.client.get_songs_by_playlist(playlist_id)
return self.convert_response_to_playable_songs(response)
def get_server_info_public(self):
return self.client.get_server_info_public()
def get_server_info(self):
return self.client.get_server_info()
def convert_response_to_playable_songs(self, item_query_response):
queue_items = EmbyMediaItem.from_list(
EmbyCroft.parse_response(item_query_response))
return self.convert_to_playable_songs(queue_items)
def convert_to_playable_songs(self, songs):
song_uris = []
for item in songs:
song_uris.append(self.client.get_song_file(item.id))
return song_uris
@staticmethod
def parse_search_hints_from_response(response):
if response.text:
response_json = response.json()
return response_json["SearchHints"]
@staticmethod
def parse_response(response):
if response.text:
response_json = response.json()
return response_json["Items"]
def smart_parse_common_phrase(self, phrase: str):
"""
Attempt to get keywords in phrase such as
{artist/album/song} and determine a users
intent
:param phrase:
:return:
"""
removals = ['emby', 'mb']
media_types = {
'artist': MediaItemType.ARTIST,
'album': MediaItemType.ALBUM,
'song': MediaItemType.SONG
}
phrase = phrase.lower()
for removal in removals:
phrase = phrase.replace(removal, "")
# determine intent if exists
# does not handle play album by artist
intent = None
for media_type in media_types.keys():
if media_type in phrase:
intent = media_types.get(media_type)
logging.log(20, "Found intent in common phrase: " + media_type)
phrase = phrase.replace(media_type, "")
break
return phrase, intent
def parse_common_phrase(self, phrase: str):
"""
Attempts to match emby items with phrase
:param phrase:
:return:
"""
logging.log(20, "phrase: " + phrase)
phrase, intent = self.smart_parse_common_phrase(phrase)
include_media_types = []
if intent is not None:
include_media_types.append(intent.value)
results = self.search(phrase, include_media_types)
if results is None or len(results) is 0:
return None, None
else:
logging.log(20, "Found: " + str(len(results)) + " to parse")
# the idea here is
# if an artist is found, return songs from this artist
# elif an album is found, return songs from this album
# elif a song is found, return song
artists = []
albums = []
songs = []
for result in results:
if result.type == MediaItemType.ARTIST:
artists.append(result)
elif result.type == MediaItemType.ALBUM:
albums.append(result)
elif result.type == MediaItemType.SONG:
songs.append(result)
else:
logging.log(
20, "Item is not an Artist/Album/Song: " +
result.type.value)
if artists:
artist_songs = self.get_songs_by_artist(artists[0].id)
return 'artist', artist_songs
elif albums:
album_songs = self.get_songs_by_album(albums[0].id)
return 'album', album_songs
elif songs:
# if a song(s) matches pick the 1st
song_songs = self.convert_to_playable_songs(songs)
return 'song', song_songs
else:
return None, None
def set_version(self):
"""
Attempts to get version based on the git hash
:return:
"""
try:
self.version = subprocess.check_output(
["git", "describe", "--always"]).strip().decode()
except Exception as e:
self.log.log(
20,
"Failed to determine version with error: {}".format(str(e)))
@staticmethod
def normalize_host(host: str):
"""
Attempts to add http if http is not present in the host name
:param host:
:return:
"""
if host is not None and 'http' not in host.lower():
host = "http://" + host
return host
def diag_public_server_info(self):
# test the public server info endpoint
connection_success = False
server_info = {}
response = None
try:
response = self.get_server_info_public()
except Exception as e:
details = 'Error occurred when attempting to connect to the Emby server. Error: ' + str(
e)
self.log.log(20, details)
server_info['Error'] = details
return connection_success, server_info
if response.status_code != 200:
logging.log(
20,
'Non 200 status code returned when fetching public server info: '
+ str(response.status_code))
else:
connection_success = True
try:
server_info = json.loads(response.text)
except Exception as e:
details = 'Failed to parse server details, error: ' + str(e)
logging.log(20, details)
server_info['Error'] = details
return connection_success, server_info