1 # -*- coding: utf-8 -*-
3 Fetching similar artists from last.fm web services
6 # standard library import
9 from collections import deque
10 from hashlib import md5
12 # third parties components
15 from ...lib.plugin import Plugin
16 from ...lib.simafm import SimaFM, XmlFMHTTPError, XmlFMNotFound, XmlFMError
17 from ...lib.track import Track
21 """Caching decorator"""
22 def wrapper(*args, **kwargs):
23 #pylint: disable=W0212,C0111
25 similarities = [art + str(match) for art, match in args[1]]
26 hashedlst = md5(''.join(similarities).encode('utf-8')).hexdigest()
27 if hashedlst in cls._cache.get('asearch'):
28 cls.log.debug('cached request')
29 results = cls._cache.get('asearch').get(hashedlst)
31 results = func(*args, **kwargs)
32 cls.log.debug('caching request')
33 cls._cache.get('asearch').update({hashedlst:list(results)})
34 random.shuffle(results)
40 """last.fm similar artists
43 def __init__(self, daemon):
44 Plugin.__init__(self, daemon)
45 self.daemon_conf = daemon.config
47 self.history = daemon.short_history
57 self.queue_mode = wrapper.get(self.plugin_conf.get('queue_mode'))
59 def _flush_cache(self):
61 Both flushes and instanciates _cache
63 if isinstance(self._cache, dict):
64 self.log.info('Lastfm: Flushing cache!')
66 self.log.info('Lastfm: Initialising cache!')
72 def _cleanup_cache(self):
73 """Avoid bloated cache
75 for _ , val in self._cache.items():
76 if isinstance(val, dict):
80 def get_history(self, artist):
81 """Constructs list of Track for already played titles for an artist.
83 duration = self.daemon_conf.getint('sima', 'history_duration')
84 tracks_from_db = self.sdb.get_history(duration=duration, artist=artist)
85 # Construct Track() objects list from database history
86 played_tracks = [Track(artist=tr[-1], album=tr[1], title=tr[2],
87 file=tr[3]) for tr in tracks_from_db]
90 def filter_track(self, tracks):
92 Extract one unplayed track from a Track object list.
94 * not already in the queue
97 artist = tracks[0].artist
98 black_list = self.player.queue + self.to_add
99 not_in_hist = list(set(tracks) - set(self.get_history(artist=artist)))
101 self.log.debug('All tracks already played for "{}"'.format(artist))
102 random.shuffle(not_in_hist)
103 #candidate = [ trk for trk in not_in_hist if trk not in black_list
104 #if not self.sdb.get_bl_track(trk, add_not=True)]
106 for trk in [_ for _ in not_in_hist if _ not in black_list]:
107 if self.sdb.get_bl_track(trk, add_not=True):
108 self.log.info('Blacklisted: {0}: '.format(trk))
110 if self.sdb.get_bl_album(trk, add_not=True):
111 self.log.info('Blacklisted album: {0}: '.format(trk))
113 # Should use albumartist heuristic as well
114 if self.plugin_conf.getboolean('single_album'):
115 if (trk.album == self.player.current.album or
116 trk.album in [tr.album for tr in self.to_add]):
117 self.log.debug('Found unplayed track ' +
118 'but from an album already queued: %s' % (trk))
120 candidate.append(trk)
122 self.log.debug('Unable to find title to add' +
123 ' for "%s".' % artist)
125 self.to_add.append(random.choice(candidate))
127 def _get_artists_list_reorg(self, alist):
129 Move around items in artists_list in order to play first not recently
132 # TODO: move to utils as a decorator
133 duration = self.daemon_conf.getint('sima', 'history_duration')
135 for trk in self.sdb.get_history(duration=duration,
137 if trk[0] not in art_in_hist:
138 art_in_hist.append(trk[0])
139 art_in_hist.reverse()
140 art_not_in_hist = [ ar for ar in alist if ar not in art_in_hist ]
141 random.shuffle(art_not_in_hist)
142 art_not_in_hist.extend(art_in_hist)
143 self.log.debug('history ordered: {}'.format(
144 ' / '.join(art_not_in_hist)))
145 return art_not_in_hist
148 def get_artists_from_player(self, similarities):
150 Look in player library for availability of similar artists in
153 dynamic = self.plugin_conf.getint('dynamic')
156 similarity = self.plugin_conf.getint('similarity')
158 similarities.reverse()
159 while (len(results) < dynamic
160 and len(similarities) > 0):
161 art_pop, match = similarities.pop()
162 if match < similarity:
164 results.extend(self.player.fuzzy_find_artist(art_pop))
165 results and self.log.debug('Similarity: %d%%' % match) # pylint: disable=w0106
168 def lfm_similar_artists(self, artist=None):
170 Retrieve similar artists on last.fm server.
173 current = self.player.current
177 # initialize artists deque list to construct from DB
179 as_artists = simafm.get_similar(artist=current.artist)
180 self.log.debug('Requesting last.fm for "{0.artist}"'.format(current))
182 [as_art.append((a, m)) for a, m in as_artists]
183 except XmlFMHTTPError as err:
184 self.log.warning('last.fm http error: %s' % err)
185 except XmlFMNotFound as err:
186 self.log.warning("last.fm: %s" % err)
187 except XmlFMError as err:
188 self.log.warning('last.fm module error: %s' % err)
190 self.log.debug('Fetched %d artist(s) from last.fm' % len(as_art))
193 def get_recursive_similar_artist(self):
195 history = deque(self.history)
198 current = self.player.current
200 while depth < self.plugin_conf.getint('depth'):
201 if len(history) == 0:
203 trk = history.popleft()
204 if (trk.artist in [trk.artist for trk in extra_arts]
205 or trk.artist == current.artist):
207 extra_arts.append(trk)
209 self.log.info('EXTRA ARTS: {}'.format(
210 '/'.join([trk.artist for trk in extra_arts])))
211 for artist in extra_arts:
212 self.log.debug('Looking for artist similar to "{0.artist}" as well'.format(artist))
213 similar = self.lfm_similar_artists(artist=artist)
216 similar = sorted(similar, key=lambda sim: sim[1], reverse=True)
217 ret_extra.extend(self.get_artists_from_player(similar))
218 if current.artist in ret_extra:
219 ret_extra.remove(current.artist)
222 def get_local_similar_artists(self):
223 """Check against local player for similar artists fetched from last.fm
225 current = self.player.current
226 self.log.info('Looking for artist similar to "{0.artist}"'.format(current))
227 similar = self.lfm_similar_artists()
229 self.log.info('Got nothing from last.fm!')
231 similar = sorted(similar, key=lambda sim: sim[1], reverse=True)
232 self.log.info('First five similar artist(s): {}...'.format(
233 ' / '.join([a for a, m in similar[0:5]])))
234 self.log.info('Looking availability in music library')
235 ret = self.get_artists_from_player(similar)
237 if len(self.history) >= 2:
238 ret_extra = self.get_recursive_similar_artist()
240 self.log.warning('Got nothing from music library.')
241 self.log.warning('Try running in debug mode to guess why...')
244 ret = list(set(ret) | set(ret_extra))
245 self.log.info('Got {} artists in library'.format(len(ret)))
246 self.log.info(' / '.join(ret))
247 # Move around similars items to get in unplayed|not recently played
249 return self._get_artists_list_reorg(ret)
251 def _get_album_history(self, artist=None):
252 """Retrieve album history"""
253 duration = self.daemon_conf.getint('sima', 'history_duration')
255 for trk in self.sdb.get_history(artist=artist, duration=duration):
256 albums_list.add(trk[1])
259 def find_album(self, artists):
260 """Find albums to queue.
264 target_album_to_add = self.plugin_conf.getint('album_to_add')
265 for artist in artists:
266 self.log.info('Looking for an album to add for "%s"...' % artist)
267 albums = self.player.find_albums(artist)
268 # albums yet in history for this artist
269 albums_yet_in_hist = albums & self._get_album_history(artist=artist)
270 albums_not_in_hist = list(albums - albums_yet_in_hist)
271 # Get to next artist if there are no unplayed albums
272 if not albums_not_in_hist:
273 self.log.info('No album found for "%s"' % artist)
275 album_to_queue = str()
276 random.shuffle(albums_not_in_hist)
277 for album in albums_not_in_hist:
278 tracks = self.player.find_album(artist, album)
279 if tracks and self.sdb.get_bl_album(tracks[0], add_not=True):
280 self.log.info('Blacklisted album: "%s"' % album)
281 self.log.debug('using track: "%s"' % tracks[0])
283 # Look if one track of the album is already queued
284 # Good heuristic, at least enough to guess if the whole album is
286 if tracks[0] in self.player.queue:
287 self.log.debug('"%s" already queued, skipping!' %
290 album_to_queue = album
291 if not album_to_queue:
292 self.log.info('No album found for "%s"' % artist)
294 self.log.info('last.fm album candidate: {0} - {1}'.format(
295 artist, album_to_queue))
297 self.to_add.extend(self.player.find_album(artist, album_to_queue))
298 if nb_album_add == target_album_to_add:
302 """Get some tracks for track queue mode
304 artists = self.get_local_similar_artists()
305 nbtracks_target = self.plugin_conf.getint('track_to_add')
306 for artist in artists:
307 self.log.debug('Trying to find titles to add for "{}"'.format(
309 found = self.player.find_track(artist)
310 # find tracks not in history for artist
311 self.filter_track(found)
312 if len(self.to_add) == nbtracks_target:
315 self.log.debug('Found no tracks to queue, is your ' +
316 'history getting too large?')
318 for track in self.to_add:
319 self.log.info('last.fm candidate: {0!s}'.format(track))
322 """Get albums for album queue mode
324 artists = self.get_local_similar_artists()
325 self.find_album(artists)
328 """Get some tracks for top track queue mode
330 #artists = self.get_local_similar_artists()
333 def callback_need_track(self):
334 self._cleanup_cache()
335 if not self.player.current:
336 self.log.info('Not currently playing track, cannot queue')
339 candidates = self.to_add
341 if self.plugin_conf.get('queue_mode') != 'album':
342 random.shuffle(candidates)
345 def callback_player_database(self):
349 # vim: ai ts=4 sw=4 sts=4 expandtab