sima/plugins/lastfm.py

   1 # -*- coding: utf-8 -*-
   2 """
   3 Fetching similar artists from last.fm web services
   4 """
   5
   6 # standart library import
   7 import random
   8
   9 from collections import deque
  10 from itertools import dropwhile
  11 from hashlib import md5
  12
  13 # third parties componants
  14
  15 # local import
  16 from ..lib.plugin import Plugin
  17 from ..lib.simafm import SimaFM, XmlFMHTTPError, XmlFMNotFound, XmlFMError
  18 from ..lib.track import Track
  19
  20
  21 def cache(func):
  22     """Caching decorator"""
  23     def wrapper(*args, **kwargs):
  24         #pylint: disable=W0212,C0111
  25         cls = args[0]
  26         similarities = [art + str(match) for art, match in args[1]]
  27         hashedlst = md5(''.join(similarities).encode('utf-8')).hexdigest()
  28         if hashedlst in cls._cache.get('asearch'):
  29             cls.log.debug('cached request')
  30             results = cls._cache.get('asearch').get(hashedlst)
  31         else:
  32             results = func(*args, **kwargs)
  33             cls._cache.get('asearch').update({hashedlst:list(results)})
  34         random.shuffle(results)
  35         return results
  36     return wrapper
  37
  38
  39 def blacklist(artist=False, album=False, track=False):
  40     #pylint: disable=C0111,W0212
  41     field = (artist, album, track)
  42     def decorated(func):
  43         def wrapper(*args, **kwargs):
  44             cls = args[0]
  45             boolgen = (bl for bl in field)
  46             bl_fun = (cls._Plugin__daemon.sdb.get_bl_artist,
  47                       cls._Plugin__daemon.sdb.get_bl_album,
  48                       cls._Plugin__daemon.sdb.get_bl_track,)
  49             #bl_getter = next(fn for fn, bl in zip(bl_fun, boolgen) if bl is True)
  50             bl_getter = next(dropwhile(lambda _: not next(boolgen), bl_fun))
  51             cls.log.debug('using {0} as bl filter'.format(bl_getter.__name__))
  52             if artist:
  53                 results = func(*args, **kwargs)
  54                 for elem in results:
  55                     if bl_getter(elem, add_not=True):
  56                         cls.log.info('Blacklisted: {0}'.format(elem))
  57                         results.remove(elem)
  58                 return results
  59             if track:
  60                 for elem in args[1]:
  61                     if bl_getter(elem, add_not=True):
  62                         cls.log.info('Blacklisted: {0}'.format(elem))
  63                         args[1].remove(elem)
  64                 return func(*args, **kwargs)
  65         return wrapper
  66     return decorated
  67
  68
  69 class Lastfm(Plugin):
  70     """last.fm similar artists
  71     """
  72
  73     def __init__(self, daemon):
  74         Plugin.__init__(self, daemon)
  75         self.daemon_conf = daemon.config
  76         self.sdb = daemon.sdb
  77         self.history = daemon.short_history
  78         ##
  79         self.to_add = list()
  80         self._cache = None
  81         self._flush_cache()
  82         wrapper = {
  83                 'track': self._track,
  84                 'top': self._top,
  85                 'album': self._album,
  86                 }
  87         self.queue_mode = wrapper.get(self.plugin_conf.get('queue_mode'))
  88
  89     def _flush_cache(self):
  90         """
  91         Both flushes and instanciates _cache
  92         """
  93         if isinstance(self._cache, dict):
  94             self.log.info('Lastfm: Flushing cache!')
  95         else:
  96             self.log.info('Lastfm: Initialising cache!')
  97         self._cache = {
  98                 'artists': None,
  99                 'asearch': dict(),
 100                 'tsearch': dict(),
 101                 }
 102         self._cache['artists'] = frozenset(self.player.list('artist'))
 103
 104     def _cleanup_cache(self):
 105         """Avoid bloated cache
 106         """
 107         for _ , val in self._cache.items():
 108             if isinstance(val, dict):
 109                 while len(val) > 150:
 110                     val.popitem()
 111
 112     def get_history(self, artist):
 113         """Constructs list of Track for already played titles for an artist.
 114         """
 115         duration = self.daemon_conf.getint('sima', 'history_duration')
 116         tracks_from_db = self.sdb.get_history(duration=duration, artist=artist)
 117         # Construct Track() objects list from database history
 118         played_tracks = [Track(artist=tr[-1], album=tr[1], title=tr[2],
 119                                file=tr[3]) for tr in tracks_from_db]
 120         return played_tracks
 121
 122     def filter_track(self, tracks):
 123         """
 124         Extract one unplayed track from a Track object list.
 125             * not in history
 126             * not already in the queue
 127             * not blacklisted
 128         """
 129         artist = tracks[0].artist
 130         black_list = self.player.queue + self.to_add
 131         not_in_hist = list(set(tracks) - set(self.get_history(artist=artist)))
 132         if not not_in_hist:
 133             self.log.debug('All tracks already played for "{}"'.format(artist))
 134         random.shuffle(not_in_hist)
 135         #candidate = [ trk for trk in not_in_hist if trk not in black_list
 136                       #if not self.sdb.get_bl_track(trk, add_not=True)]
 137         candidate = []
 138         for trk in [_ for _ in not_in_hist if _ not in black_list]:
 139             if self.sdb.get_bl_track(trk, add_not=True):
 140                 self.log.info('Blacklisted: {0}: '.format(trk))
 141                 continue
 142             if self.sdb.get_bl_album(trk, add_not=True):
 143                 self.log.info('Blacklisted album: {0}: '.format(trk))
 144                 continue
 145             candidate.append(trk)
 146         if not candidate:
 147             self.log.debug('Unable to find title to add' +
 148                            ' for "%s".' % artist)
 149             return None
 150         self.to_add.append(random.choice(candidate))
 151
 152     def _get_artists_list_reorg(self, alist):
 153         """
 154         Move around items in artists_list in order to play first not recently
 155         played artists
 156         """
 157         # TODO: move to utils as a decorator
 158         duration = self.daemon_conf.getint('sima', 'history_duration')
 159         art_in_hist = list()
 160         for trk in self.sdb.get_history(duration=duration,
 161                                         artists=alist):
 162             if trk[0] not in art_in_hist:
 163                 art_in_hist.append(trk[0])
 164         art_in_hist.reverse()
 165         art_not_in_hist = [ ar for ar in alist if ar not in art_in_hist ]
 166         random.shuffle(art_not_in_hist)
 167         art_not_in_hist.extend(art_in_hist)
 168         self.log.debug('history ordered: {}'.format(
 169                        ' / '.join(art_not_in_hist)))
 170         return art_not_in_hist
 171
 172     @blacklist(artist=True)
 173     @cache
 174     def get_artists_from_player(self, similarities):
 175         """
 176         Look in player library for availability of similar artists in
 177         similarities
 178         """
 179         dynamic = int(self.plugin_conf.get('dynamic'))
 180         if dynamic <= 0:
 181             dynamic = 100
 182         similarity = int(self.plugin_conf.get('similarity'))
 183         results = list()
 184         similarities.reverse()
 185         while (len(results) < dynamic
 186             and len(similarities) > 0):
 187             art_pop, match = similarities.pop()
 188             if match < similarity:
 189                 break
 190             results.extend(self.player.fuzzy_find(art_pop))
 191         results and self.log.debug('Similarity: %d%%' % match) # pylint: disable=w0106
 192         return results
 193
 194     def lfm_similar_artists(self, artist=None):
 195         """
 196         Retrieve similar artists on last.fm server.
 197         """
 198         if artist is None:
 199             current = self.player.current
 200         else:
 201             current = artist
 202         simafm = SimaFM()
 203         # initialize artists deque list to construct from DB
 204         as_art = deque()
 205         as_artists = simafm.get_similar(artist=current.artist)
 206         self.log.debug('Requesting last.fm for "{0.artist}"'.format(current))
 207         try:
 208             [as_art.append((a, m)) for a, m in as_artists]
 209         except XmlFMHTTPError as err:
 210             self.log.warning('last.fm http error: %s' % err)
 211         except XmlFMNotFound as err:
 212             self.log.warning("last.fm: %s" % err)
 213         except XmlFMError as err:
 214             self.log.warning('last.fm module error: %s' % err)
 215         if as_art:
 216             self.log.debug('Fetched %d artist(s) from last.fm' % len(as_art))
 217         return as_art
 218
 219     def get_recursive_similar_artist(self):
 220         ret_extra = list()
 221         history = deque(self.history)
 222         history.popleft()
 223         depth = 0
 224         current = self.player.current
 225         extra_arts = list()
 226         while depth < int(self.plugin_conf.get('depth')):
 227             if len(history) == 0:
 228                 break
 229             trk = history.popleft()
 230             if (trk.artist in [trk.artist for trk in extra_arts]
 231                 or trk.artist == current.artist):
 232                 continue
 233             extra_arts.append(trk)
 234             depth += 1
 235         self.log.info('EXTRA ARTS: {}'.format(
 236             '/'.join([trk.artist for trk in extra_arts])))
 237         for artist in extra_arts:
 238             self.log.debug('Looking for artist similar to "{0.artist}" as well'.format(artist))
 239             similar = self.lfm_similar_artists(artist=artist)
 240             similar = sorted(similar, key=lambda sim: sim[1], reverse=True)
 241             ret_extra.extend(self.get_artists_from_player(similar))
 242             if current.artist in ret_extra:
 243                 ret_extra.remove(current.artist)
 244         return ret_extra
 245
 246     def get_local_similar_artists(self):
 247         """Check against local player for similar artists fetched from last.fm
 248         """
 249         current = self.player.current
 250         self.log.info('Looking for artist similar to "{0.artist}"'.format(current))
 251         similar = self.lfm_similar_artists()
 252         if not similar:
 253             self.log.info('Got nothing from last.fm!')
 254             return []
 255         similar = sorted(similar, key=lambda sim: sim[1], reverse=True)
 256         self.log.info('First five similar artist(s): {}...'.format(
 257                       ' / '.join([a for a, m in similar[0:5]])))
 258         self.log.info('Looking availability in music library')
 259         ret = self.get_artists_from_player(similar)
 260         ret_extra = None
 261         if len(self.history) >= 2:
 262             ret_extra = self.get_recursive_similar_artist()
 263         if not ret:
 264             self.log.warning('Got nothing from music library.')
 265             self.log.warning('Try running in debug mode to guess why...')
 266             return []
 267         if ret_extra:
 268             ret = list(set(ret) | set(ret_extra))
 269         self.log.info('Got {} artists in library'.format(len(ret)))
 270         self.log.info(' / '.join(ret))
 271         # Move around similars items to get in unplayed|not recently played
 272         # artist first.
 273         return self._get_artists_list_reorg(ret)
 274
 275     def _detects_var_artists_album(self, album, artist):
 276         """Detects either an album is a "Various Artists" or a
 277         single artist release."""
 278         art_first_track = None
 279         for track in self.player.find_album(artist, album):
 280             if not art_first_track:  # set artist for the first track
 281                 art_first_track = track.artist
 282             alb_art = track.albumartist
 283             #  Special heuristic used when AlbumArtist is available
 284             if (alb_art):
 285                 if artist == alb_art:
 286                     # When album artist field is similar to the artist we're
 287                     # looking an album for, the album is considered good to
 288                     # queue
 289                     return False
 290                 else:
 291                     self.log.debug(track)
 292                     self.log.debug('album art says "%s", looking for "%s",'
 293                                    ' not queueing this album' %
 294                                    (alb_art, artist))
 295                     return True
 296         return False
 297
 298     def _get_album_history(self, artist=None):
 299         """Retrieve album history"""
 300         duration = self.daemon_conf.getint('sima', 'history_duration')
 301         albums_list = set()
 302         for trk in self.sdb.get_history(artist=artist, duration=duration):
 303             albums_list.add(trk[1])
 304         return albums_list
 305
 306     def find_album(self, artists):
 307         """Find albums to queue.
 308         """
 309         self.to_add = list()
 310         nb_album_add = 0
 311         target_album_to_add = int(self.plugin_conf.get('album_to_add'))
 312         for artist in artists:
 313             self.log.info('Looking for an album to add for "%s"...' % artist)
 314             albums = set(self.player.find_albums(artist))
 315             # albums yet in history for this artist
 316             albums_yet_in_hist = albums & self._get_album_history(artist=artist)
 317             albums_not_in_hist = list(albums - albums_yet_in_hist)
 318             # Get to next artist if there are no unplayed albums
 319             if not albums_not_in_hist:
 320                 self.log.info('No album found for "%s"' % artist)
 321                 continue
 322             album_to_queue = str()
 323             random.shuffle(albums_not_in_hist)
 324             for album in albums_not_in_hist:
 325                 tracks = self.player.find('album', album)
 326                 if self._detects_var_artists_album(album, artist):
 327                     continue
 328                 if tracks and self.sdb.get_bl_album(tracks[0], add_not=True):
 329                     self.log.info('Blacklisted album: "%s"' % album)
 330                     self.log.debug('using track: "%s"' % tracks[0])
 331                     continue
 332                 # Look if one track of the album is already queued
 333                 # Good heuristic, at least enough to guess if the whole album is
 334                 # already queued.
 335                 if tracks[0] in self.player.queue:
 336                     self.log.debug('"%s" already queued, skipping!' %
 337                             tracks[0].album)
 338                     continue
 339                 album_to_queue = album
 340             if not album_to_queue:
 341                 self.log.info('No album found for "%s"' % artist)
 342                 continue
 343             self.log.info('last.fm album candidate: {0} - {1}'.format(
 344                            artist, album_to_queue))
 345             nb_album_add += 1
 346             self.to_add.extend(self.player.find_album(artist, album_to_queue))
 347             if nb_album_add == target_album_to_add:
 348                 return True
 349
 350     def _track(self):
 351         """Get some tracks for track queue mode
 352         """
 353         artists = self.get_local_similar_artists()
 354         nbtracks_target = int(self.plugin_conf.get('track_to_add'))
 355         for artist in artists:
 356             self.log.debug('Trying to find titles to add for "{}"'.format(
 357                            artist))
 358             found = self.player.find_track(artist)
 359             # find tracks not in history for artist
 360             self.filter_track(found)
 361             if len(self.to_add) == nbtracks_target:
 362                 break
 363         if not self.to_add:
 364             self.log.debug('Found no tracks to queue, is your ' +
 365                             'history getting too large?')
 366             return None
 367         for track in self.to_add:
 368             self.log.info('last.fm candidate: {0!s}'.format(track))
 369
 370     def _album(self):
 371         """Get albums for album queue mode
 372         """
 373         artists = self.get_local_similar_artists()
 374         self.find_album(artists)
 375
 376     def _top(self):
 377         """Get some tracks for top track queue mode
 378         """
 379         #artists = self.get_local_similar_artists()
 380         pass
 381
 382     def callback_need_track(self):
 383         self._cleanup_cache()
 384         if not self.player.current:
 385             self.log.info('Not currently playing track, cannot queue')
 386             return None
 387         self.queue_mode()
 388         candidates = self.to_add
 389         self.to_add = list()
 390         return candidates
 391
 392     def callback_player_database(self):
 393         self._flush_cache()
 394
 395 # VIM MODLINE
 396 # vim: ai ts=4 sw=4 sts=4 expandtab