]> kaliko git repositories - mpd-sima.git/blobdiff - sima/lib/webserv.py
Fixed some code style and comment
[mpd-sima.git] / sima / lib / webserv.py
index 4996622c028c24da238b06032bb39c79d51d0b03..c6a906fce7f5a92091f426a18f266856e6d04d42 100644 (file)
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2009-2015 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2020 kaliko <kaliko@azylum.org>
+# Copyright (c) 2019 sacha <sachahony@gmail.com>
 #
 #  This file is part of sima
 #
@@ -33,7 +34,7 @@ from hashlib import md5
 from .plugin import Plugin
 from .track import Track
 from .meta import Artist, MetaContainer
-from ..utils.utils import WSError, WSNotFound
+from ..utils.utils import WSError, WSNotFound, WSTimeout
 
 def cache(func):
     """Caching decorator"""
@@ -57,6 +58,7 @@ def cache(func):
 class WebService(Plugin):
     """similar artists webservice
     """
+    # pylint: disable=bad-builtin
 
     def __init__(self, daemon):
         Plugin.__init__(self, daemon)
@@ -69,9 +71,10 @@ class WebService(Plugin):
         self._flush_cache()
         wrapper = {'track': self._track,
                    'top': self._top,
-                   'album': self._album,}
+                   '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):
         """
@@ -79,11 +82,11 @@ class WebService(Plugin):
         """
         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.log.info('%s: Initialising cache!', name)
         self._cache = {'asearch': dict(),
-                       'tsearch': dict(),}
+                       'tsearch': dict()}
 
     def _cleanup_cache(self):
         """Avoid bloated cache
@@ -109,19 +112,24 @@ class WebService(Plugin):
             * not in history
             * not already in the queue
             * not blacklisted
+        Then add to candidates in self.to_add
         """
         artist = tracks[0].artist
-        black_list = self.player.queue + self.to_add
+        # In random play mode use complete playlist to filter
+        if self.player.playmode.get('random'):
+            black_list = self.player.playlist + self.to_add
+        else:
+            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))
+            self.log.debug('All tracks already played for "%s"', 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'): # pylint: disable=no-member
+            if self.plugin_conf.getboolean('single_album'):  # pylint: disable=no-member
                 if (trk.album == self.player.current.album or
-                        trk.album in [tr.album for tr in self.to_add]):
+                        trk.album in [tr.album for tr in black_list]):
                     self.log.debug('Found unplayed track ' +
                                    'but from an album already queued: %s', trk)
                     continue
@@ -171,28 +179,43 @@ class WebService(Plugin):
         # 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))
+        self.log.debug('Requesting %s for %r', self.ws.name, artist)
         try:
             [as_art.append(art) for art in as_artists]
         except WSNotFound as err:
-            self.log.warning('{}: {}'.format(self.ws.name, 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('{}: {}'.format(self.ws.name, 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('{}: {}'.format(self.ws.name, err))
+            self.log.warning('%s: %s', self.ws.name, err)
         if as_art:
-            self.log.debug('Fetched {} 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):
+        """Check against local player for similar artists (recursive w/ history)
+        """
         if not self.player.playlist:
-            return
+            return []
         history = list(self.history)
-        history = self.player.queue + 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 = list()
@@ -210,7 +233,7 @@ class WebService(Plugin):
         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:
                 continue
@@ -229,11 +252,11 @@ class WebService(Plugin):
         if not self.player.playlist:
             return []
         tolookfor = self.player.playlist[-1].Artist
-        self.log.info('Looking for artist similar to "{}"'.format(tolookfor))
-        self.log.debug(repr(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): %s...',
                       ' / '.join(map(str, list(similar)[:5])))
@@ -263,30 +286,36 @@ class WebService(Plugin):
         if not ret:
             self.log.warning('Got nothing from music library.')
             return []
-        queued_artists = MetaContainer([trk.Artist for trk in self.player.queue])
-        self.log.trace('Already queued: {}'.format(queued_artists))
-        self.log.trace('Candidate: {}'.format(ret))
+        # 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 artists: '
-                           '{0}'.format('/'.join(map(str, ret & queued_artists))))
+                           '%s', '/'.join(map(str, ret & queued_artists)))
             ret = ret - queued_artists
-        if self.player.current and self.player.current.Artist in ret:
-            self.log.debug('Removing current artist: {0}'.format(self.player.current.Artist))
-            ret = ret -  MetaContainer([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)))
+        self.log.info('Got %d artists in library', len(ret))
         candidates = self._get_artists_list_reorg(list(ret))
         if candidates:
             self.log.info(' / '.join(map(str, candidates)))
         return candidates
 
-    def _get_album_history(self, artist=None):
+    def _get_album_history(self, artist):
         """Retrieve album history"""
-        duration = self.daemon_conf.getint('sima', 'history_duration')
         albums_list = set()
-        for trk in self.sdb.get_history(artist=artist.name, duration=duration):
-            albums_list.add(trk[1])
+        for trk in self.get_history(artist=artist.name):
+            if not trk.album:
+                continue
+            albums_list.add(trk.album)
         return albums_list
 
     def find_album(self, artists):
@@ -294,40 +323,47 @@ class WebService(Plugin):
         """
         self.to_add = list()
         nb_album_add = 0
-        target_album_to_add = self.plugin_conf.getint('album_to_add') # pylint: disable=no-member
+        target_album_to_add = self.plugin_conf.getint('album_to_add')  # pylint: disable=no-member
         for artist in artists:
             self.log.info('Looking for an album to add for "%s"...' % artist)
             albums = self.player.search_albums(artist)
-            # str conversion while Album type is not propagated
-            albums = [str(album) for album in albums]
-            if albums:
-                self.log.debug('Albums candidate: %s', ' / '.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)
+            if not albums:
+                continue
+            self.log.debug('Albums candidate: %s', albums)
+            albums_hist = self._get_album_history(artist)
+            albums_not_in_hist = [a for a in albums if a.name not in albums_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)
+                self.log.info('No unplayed album found for "%s"' % artist)
                 continue
-            album_to_queue = str()
+            album_to_queue = []
             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)
+                # Controls the album found is not already queued
+                if album in {t.album for t in self.player.queue}:
+                    self.log.debug('"%s" already queued, skipping!', album)
                     continue
+                # In random play mode use complete playlist to filter
+                if self.player.playmode.get('random'):
+                    if album in {t.album for t in self.player.playlist}:
+                        self.log.debug('"%s" already in playlist, skipping!', album)
+                        continue
                 album_to_queue = album
             if not album_to_queue:
                 self.log.info('No album found for "%s"', artist)
                 continue
-            self.log.info('%s album candidate: %s - %s', self.ws.name, artist, album_to_queue)
+            self.log.info('%s album candidate: %s - %s', self.ws.name,
+                          artist, album_to_queue)
             nb_album_add += 1
-            self.to_add.extend(self.player.find_album(artist, album_to_queue))
+            candidates = self.player.find_tracks(album)
+            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]
+            self.to_add.extend(candidates)
             if nb_album_add == target_album_to_add:
                 return True
 
@@ -339,18 +375,18 @@ class WebService(Plugin):
         nbtracks_target = self.plugin_conf.getint('track_to_add') # pylint: disable=no-member
         for artist in artists:
             if len(self.to_add) == nbtracks_target:
-                return True
-            self.log.info('Looking for a top track for {0}'.format(artist))
+                return
+            self.log.info('Looking for a top track for %s', artist)
             titles = deque()
             try:
                 titles = [t for t in self.ws.get_toptrack(artist)]
             except WSError as err:
                 self.log.warning('%s: %s', self.ws.name, err)
+                continue
             for trk in titles:
-                found = self.player.fuzzy_find_track(artist, trk.title)
-                random.shuffle(found)
+                found = self.player.search_track(artist, trk.title)
                 if found:
-                    self.log.debug('%s', found[0])
+                    random.shuffle(found)
                     if self.filter_track(found):
                         break
 
@@ -358,13 +394,13 @@ class WebService(Plugin):
         """Get some tracks for track queue mode
         """
         artists = self.get_local_similar_artists()
-        nbtracks_target = self.plugin_conf.getint('track_to_add') # pylint: disable=no-member
+        nbtracks_target = self.plugin_conf.getint('track_to_add')  # pylint: disable=no-member
         for artist in artists:
             self.log.debug('Trying to find titles to add for "%r"', artist)
-            found = self.player.find_track(artist)
+            found = self.player.find_tracks(artist)
             random.shuffle(found)
             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
             # find tracks not in history for artist
             self.filter_track(found)
@@ -374,7 +410,7 @@ class WebService(Plugin):
             self.log.debug('Found no tracks to queue!')
             return None
         for track in self.to_add:
-            self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
+            self.log.info('%s candidates: %s', track, self.ws.name)
 
     def _album(self):
         """Get albums for album queue mode
@@ -388,7 +424,7 @@ class WebService(Plugin):
         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))
+            self.log.info('%s candidates: %s', self.ws.name, track)
 
     def callback_need_track(self):
         self._cleanup_cache()