# -*- coding: utf-8 -*-
-# Copyright (c) 2009-2014 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
+# Copyright (c) 2019 sacha <sachahony@gmail.com>
#
# This file is part of sima
#
# third parties components
# local import
-from .plugin import Plugin
-from .track import Track
-from .meta import Artist
-from ..utils.utils import WSError
+from .plugin import AdvancedPlugin
+from .meta import Artist, MetaContainer
+from ..utils.utils import WSError, WSNotFound, WSTimeout
+
def cache(func):
"""Caching decorator"""
def wrapper(*args, **kwargs):
#pylint: disable=W0212,C0111
cls = args[0]
- similarities = [art for art in args[1]]
+ similarities = [art.name for art in args[1]]
hashedlst = md5(''.join(similarities).encode('utf-8')).hexdigest()
if hashedlst in cls._cache.get('asearch'):
cls.log.debug('cached request')
else:
results = func(*args, **kwargs)
cls.log.debug('caching request')
- cls._cache.get('asearch').update({hashedlst:list(results)})
+ cls._cache.get('asearch').update({hashedlst: list(results)})
random.shuffle(results)
return results
return wrapper
-class WebService(Plugin):
+class WebService(AdvancedPlugin):
"""similar artists webservice
"""
def __init__(self, daemon):
- Plugin.__init__(self, daemon)
- self.daemon_conf = daemon.config
- self.sdb = daemon.sdb
+ super().__init__(daemon)
self.history = daemon.short_history
##
- self.to_add = list()
self._cache = None
self._flush_cache()
- wrapper = {
- 'track': self._track,
- 'top': self._top,
- 'album': self._album,
- }
+ wrapper = {'track': self._track,
+ 'top': self._top,
+ 'album': self._album}
self.queue_mode = wrapper.get(self.plugin_conf.get('queue_mode'))
self.ws = None
+ self.ws_retry = 0
def _flush_cache(self):
"""
"""
name = self.__class__.__name__
if isinstance(self._cache, dict):
- self.log.info('{0}: Flushing cache!'.format(name))
+ self.log.info('%s: Flushing cache!', name)
else:
- self.log.info('{0}: Initialising cache!'.format(name))
- self._cache = {
- 'asearch': dict(),
- 'tsearch': dict(),
- }
+ self.log.info('%s: Initialising cache!', name)
+ self._cache = {'asearch': {},
+ 'tsearch': {}}
def _cleanup_cache(self):
"""Avoid bloated cache
while len(val) > 150:
val.popitem()
- def get_history(self, artist):
- """Constructs list of Track for already played titles for an artist.
- """
- duration = self.daemon_conf.getint('sima', 'history_duration')
- tracks_from_db = self.sdb.get_history(duration=duration, artist=artist)
- # Construct Track() objects list from database history
- played_tracks = [Track(artist=tr[-1], album=tr[1], title=tr[2],
- file=tr[3]) for tr in tracks_from_db]
- return played_tracks
-
- def filter_track(self, tracks):
- """
- Extract one unplayed track from a Track object list.
- * not in history
- * not already in the queue
- * not blacklisted
- """
- artist = tracks[0].artist
- black_list = self.player.queue + self.to_add
- not_in_hist = list(set(tracks) - set(self.get_history(artist=artist)))
- if self.plugin_conf.get('queue_mode') != 'top' and not not_in_hist:
- self.log.debug('All tracks already played for "{}"'.format(artist))
- random.shuffle(not_in_hist)
- candidate = []
- for trk in [_ for _ in not_in_hist if _ not in black_list]:
- # Should use albumartist heuristic as well
- if self.plugin_conf.getboolean('single_album'):
- if (trk.album == self.player.current.album or
- trk.album in [tr.album for tr in self.to_add]):
- self.log.debug('Found unplayed track ' +
- 'but from an album already queued: %s' % (trk))
- continue
- candidate.append(trk)
- if not candidate:
- return False
- self.to_add.append(random.choice(candidate))
- return True
-
- def _get_artists_list_reorg(self, alist):
- """
- Move around items in artists_list in order to play first not recently
- played artists
- """
- # TODO: move to utils as a decorator
- duration = self.daemon_conf.getint('sima', 'history_duration')
- art_in_hist = list()
- for trk in self.sdb.get_history(duration=duration, artists=alist):
- if trk[0] not in art_in_hist:
- art_in_hist.append(trk[0])
- art_in_hist.reverse()
- art_not_in_hist = [ar for ar in alist if ar not in art_in_hist]
- random.shuffle(art_not_in_hist)
- art_not_in_hist.extend(art_in_hist)
- self.log.info('{}'.format(
- ' / '.join(art_not_in_hist)))
- return art_not_in_hist
-
@cache
def get_artists_from_player(self, similarities):
"""
dynamic = self.plugin_conf.getint('max_art')
if dynamic <= 0:
dynamic = 100
- results = list()
+ results = []
similarities.reverse()
- while (len(results) < dynamic
- and len(similarities) > 0):
+ while (len(results) < dynamic and similarities):
art_pop = similarities.pop()
- results.extend(self.player.fuzzy_find_artist(art_pop))
+ res = self.player.search_artist(art_pop)
+ if res:
+ results.append(res)
return results
- def ws_similar_artists(self, artist=None):
+ def ws_similar_artists(self, artist):
"""
Retrieve similar artists from WebServive.
"""
# initialize artists deque list to construct from DB
as_art = deque()
- as_artists = self.ws().get_similar(artist=artist)
- self.log.debug('Requesting {} for {!r}'.format(self.ws.name,artist))
+ as_artists = self.ws.get_similar(artist=artist)
+ self.log.debug('Requesting %s for %r', self.ws.name, artist)
try:
- # TODO: let's propagate Artist type
- [as_art.append(str(art)) for art in as_artists]
+ [as_art.append(art) for art in as_artists]
+ except WSNotFound as err:
+ self.log.warning('%s: %s', self.ws.name, err)
+ if artist.mbid:
+ self.log.debug('Trying without MusicBrainzID')
+ try:
+ return self.ws_similar_artists(Artist(name=artist.name))
+ except WSNotFound as err:
+ self.log.debug('%s: %s', self.ws.name, err)
+ except WSTimeout as err:
+ self.log.warning('%s: %s', self.ws.name, err)
+ if self.ws_retry < 3:
+ self.ws_retry += 1
+ self.log.warning('%s: retrying', self.ws.name)
+ as_art = self.ws_similar_artists(artist)
+ else:
+ self.log.warning('%s: stop retrying', self.ws.name)
+ self.ws_retry = 0
except WSError as err:
- self.log.warning('{0}: {1}'.format(self.ws.name, err))
+ self.log.warning('%s: %s', self.ws.name, err)
if as_art:
- self.log.debug('Fetched {0} artist(s)'.format(len(as_art)))
+ self.log.debug('Fetched %d artist(s)', len(as_art))
return as_art
def get_recursive_similar_artist(self):
- ret_extra = list()
- history = deque(self.history)
- history.popleft()
- depth = 0
+ """Check against local player for similar artists (recursive w/ history)
+ """
if not self.player.playlist:
- return ret_extra
- last_trk = self.player.playlist[-1]
- extra_arts = list()
+ return []
+ history = list(self.history)
+ # In random play mode use complete playlist to filter
+ if self.player.playmode.get('random'):
+ history = self.player.playlist + history
+ else:
+ history = self.player.queue + history
+ history = deque(history)
+ last_trk = history.popleft() # remove
+ extra_arts = []
+ ret_extra = []
+ depth = 0
while depth < self.plugin_conf.getint('depth'):
- if len(history) == 0:
+ if not history:
break
trk = history.popleft()
if (trk.Artist in extra_arts
- or trk.Artist == last_trk.Artist):
+ or trk.Artist == last_trk.Artist):
continue
extra_arts.append(trk.Artist)
depth += 1
- self.log.info('EXTRA ARTS: {}'.format(
- '/'.join([art.name for art in extra_arts])))
+ self.log.debug('EXTRA ARTS: %s', '/'.join(map(str, extra_arts)))
for artist in extra_arts:
self.log.debug('Looking for artist similar '
- 'to "{}" as well'.format(artist))
+ 'to "%s" as well', artist)
similar = self.ws_similar_artists(artist=artist)
if not similar:
- return ret_extra
+ continue
ret_extra.extend(self.get_artists_from_player(similar))
- if last_trk.artist in ret_extra:
- ret_extra.remove(last_trk.artist)
+
+ if last_trk.Artist in ret_extra:
+ ret_extra.remove(last_trk.Artist)
+ if ret_extra:
+ self.log.debug('similar artist(s) found: %s',
+ ' / '.join(map(str, MetaContainer(ret_extra))))
return ret_extra
def get_local_similar_artists(self):
if not self.player.playlist:
return []
tolookfor = self.player.playlist[-1].Artist
- self.log.info('Looking for artist similar to "{}"'.format(tolookfor))
+ self.log.info('Looking for artist similar to "%s"', tolookfor)
+ self.log.debug('%r', tolookfor)
similar = self.ws_similar_artists(tolookfor)
if not similar:
- self.log.info('Got nothing from {0}!'.format(self.ws.name))
+ self.log.info('Got nothing from %s!', self.ws.name)
return []
- self.log.info('First five similar artist(s): {}...'.format(
- ' / '.join([a for a in list(similar)[0:5]])))
+ self.log.info('First five similar artist(s): %s...',
+ ' / '.join(map(str, list(similar)[:5])))
self.log.info('Looking availability in music library')
- ret = set(self.get_artists_from_player(similar))
+ ret = MetaContainer(self.get_artists_from_player(similar))
+ if ret:
+ self.log.debug('regular found in library: %s',
+ ' / '.join(map(str, ret)))
+ else:
+ self.log.debug('Got nothing similar from library!')
ret_extra = None
if len(self.history) >= 2:
if self.plugin_conf.getint('depth') > 1:
ret_extra = self.get_recursive_similar_artist()
if ret_extra:
- ret = set(ret) | set(ret_extra)
+ # get them reorg to pick up best element
+ ret_extra = self.get_reorg_artists_list(ret_extra)
+ # tries to pickup less artist from extra art
+ if len(ret) > 4:
+ ret_extra = MetaContainer(ret_extra[:max(4, len(ret))//2])
+ if ret_extra:
+ self.log.debug('extra found in library: %s',
+ ' / '.join(map(str, ret_extra)))
+ ret = ret | ret_extra
if not ret:
self.log.warning('Got nothing from music library.')
- self.log.warning('Try running in debug mode to guess why...')
return []
- queued_artists = { trk.artist for trk in self.player.queue }
+ # In random play mode use complete playlist to filter
+ if self.player.playmode.get('random'):
+ queued_artists = MetaContainer([trk.Artist for trk
+ in self.player.playlist])
+ else:
+ queued_artists = MetaContainer([trk.Artist for trk
+ in self.player.queue])
+ self.log.trace('Already queued: %s', queued_artists)
+ self.log.trace('Candidate: %s', ret)
if ret & queued_artists:
- self.log.debug('Removing already queued artist: {0}'.format(ret & queued_artists))
+ self.log.debug('Removing already queued artists: '
+ '%s', '/'.join(map(str, ret & queued_artists)))
ret = ret - queued_artists
- if self.player.current.artist in ret:
- self.log.debug('Removing current artist: {0}'.format(self.player.current.artist))
- ret = ret - {self.player.current.artist}
+ current = self.player.current
+ if current and current.Artist in ret:
+ self.log.debug('Removing current artist: %s', current.Artist)
+ ret = ret - MetaContainer([current.Artist])
# Move around similars items to get in unplayed|not recently played
# artist first.
- self.log.info('Got {} artists in library'.format(len(ret)))
- return self._get_artists_list_reorg(list(ret))
-
- def _get_album_history(self, artist=None):
- """Retrieve album history"""
- duration = self.daemon_conf.getint('sima', 'history_duration')
- albums_list = set()
- for trk in self.sdb.get_history(artist=artist, duration=duration):
- albums_list.add(trk[1])
- return albums_list
+ self.log.info('Got %d artists in library', len(ret))
+ candidates = self.get_reorg_artists_list(ret)
+ if candidates:
+ self.log.info(' / '.join(map(str, candidates)))
+ return candidates
def find_album(self, artists):
"""Find albums to queue.
"""
- self.to_add = list()
+ to_add = []
nb_album_add = 0
target_album_to_add = self.plugin_conf.getint('album_to_add')
for artist in artists:
- self.log.info('Looking for an album to add for "%s"...' % artist)
- albums = self.player.find_albums(artist)
- # str conversion while Album type is not propagated
- albums = [str(album) for album in albums]
- if albums:
- self.log.debug('Albums candidate: {0:s}'.format(
- ' / '.join(albums)))
- else: continue
- # albums yet in history for this artist
- albums = set(albums)
- albums_yet_in_hist = albums & self._get_album_history(artist=artist)
- albums_not_in_hist = list(albums - albums_yet_in_hist)
- # Get to next artist if there are no unplayed albums
- if not albums_not_in_hist:
- self.log.info('No album found for "%s"' % artist)
- continue
- album_to_queue = str()
- random.shuffle(albums_not_in_hist)
- for album in albums_not_in_hist:
- tracks = self.player.find_album(artist, album)
- # Look if one track of the album is already queued
- # Good heuristic, at least enough to guess if the whole album is
- # already queued.
- if tracks[0] in self.player.queue:
- self.log.debug('"%s" already queued, skipping!' %
- tracks[0].album)
- continue
- album_to_queue = album
- if not album_to_queue:
- self.log.info('No album found for "%s"' % artist)
+ album = self.album_candidate(artist, unplayed=True)
+ if not album:
continue
- self.log.info('{2} album candidate: {0} - {1}'.format(
- artist, album_to_queue, self.ws.name))
nb_album_add += 1
- self.to_add.extend(self.player.find_album(artist, album_to_queue))
+ candidates = self.player.find_tracks(album)
+ if not candidates:
+ continue
+ if self.plugin_conf.getboolean('shuffle_album'):
+ random.shuffle(candidates)
+ # this allows to select a maximum number of track from the album
+ # a value of 0 (default) means keep all
+ nbtracks = self.plugin_conf.getint('track_to_add_from_album')
+ if nbtracks > 0:
+ candidates = candidates[0:nbtracks]
+ to_add.extend(candidates)
if nb_album_add == target_album_to_add:
- return True
+ return to_add
+ return to_add
def find_top(self, artists):
"""
find top tracks for artists in artists list.
"""
- self.to_add = list()
+ to_add = []
nbtracks_target = self.plugin_conf.getint('track_to_add')
- webserv = self.ws()
for artist in artists:
- artist = Artist(name=artist)
- if len(self.to_add) == nbtracks_target:
- return True
- self.log.info('Looking for a top track for {0}'.format(artist))
+ if len(to_add) == nbtracks_target:
+ break
+ self.log.info('Looking for a top track for %s', artist)
titles = deque()
try:
- titles = [t for t in webserv.get_toptrack(artist)]
+ titles = list(self.ws.get_toptrack(artist))
except WSError as err:
- self.log.warning('{0}: {1}'.format(self.ws.name, err))
- if self.ws.ratelimit:
- self.log.info('{0.name} ratelimit: {0.ratelimit}'.format(self.ws))
+ self.log.warning('%s: %s', self.ws.name, err)
+ continue
for trk in titles:
- found = self.player.fuzzy_find_track(artist.name, trk.title)
- random.shuffle(found)
+ found = self.player.search_track(artist, trk.title)
if found:
- self.log.debug('{0}'.format(found[0]))
- if self.filter_track(found):
+ random.shuffle(found)
+ top_trk = self.filter_track(found, to_add)
+ if top_trk:
+ to_add.append(top_trk)
break
+ return to_add
def _track(self):
"""Get some tracks for track queue mode
+
+ :return: list of Tracks
"""
+ to_add = []
artists = self.get_local_similar_artists()
nbtracks_target = self.plugin_conf.getint('track_to_add')
for artist in artists:
- self.log.debug('Trying to find titles to add for "{}"'.format(
- artist))
- found = self.player.find_track(artist)
- random.shuffle(found)
+ self.log.debug('Trying to find titles to add for "%r"', artist)
+ found = self.player.find_tracks(artist)
if not found:
- self.log.debug('Found nothing to queue for {0}'.format(artist))
+ self.log.debug('Found nothing to queue for %s', artist)
continue
+ random.shuffle(found)
# find tracks not in history for artist
- self.filter_track(found)
- if len(self.to_add) == nbtracks_target:
+ track_candidate = self.filter_track(found, to_add)
+ if track_candidate:
+ to_add.append(track_candidate)
+ self.log.info('%s plugin chose: %s',
+ self.ws.name, track_candidate)
+ if len(to_add) == nbtracks_target:
break
- if not self.to_add:
- self.log.debug('Found no tracks to queue, is your ' +
- 'history getting too large?')
- return None
- for track in self.to_add:
- self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
+ return to_add
def _album(self):
"""Get albums for album queue mode
+
+ :return: list of Tracks
"""
artists = self.get_local_similar_artists()
- self.find_album(artists)
+ return self.find_album(artists)
def _top(self):
"""Get some tracks for top track queue mode
+
+ :return: list of Tracks
"""
artists = self.get_local_similar_artists()
- self.find_top(artists)
- for track in self.to_add:
- self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
+ chosen = self.find_top(artists)
+ for track in chosen:
+ self.log.info('%s candidates: %s', self.ws.name, track)
+ return chosen
def callback_need_track(self):
self._cleanup_cache()
- if len(self.player.playlist) == 0:
+ if not self.player.playlist:
self.log.info('No last track, cannot queue')
return None
if not self.player.playlist[-1].artist:
self.log.warning('No artist set for the last track in queue')
self.log.debug(repr(self.player.current))
return None
- self.queue_mode()
- msg = ' '.join(['{0}: {1:>3d}'.format(k, v) for
+ candidates = self.queue_mode()
+ msg = ' '.join([f'{k}: {v:>3d}' for
k, v in sorted(self.ws.stats.items())])
- self.log.debug(msg)
- candidates = self.to_add
- self.to_add = list()
+ self.log.debug('http stats: ' + msg)
+ if not candidates:
+ self.log.info('%s plugin found nothing to queue', self.ws.name)
if self.plugin_conf.get('queue_mode') != 'album':
random.shuffle(candidates)
return candidates
home / dev / repositories / mpd-sima.git / blobdiff