1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2009-2014 Jack Kaliko <kaliko@azylum.org>
4 # This file is part of sima
6 # sima is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # sima is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with sima. If not, see <http://www.gnu.org/licenses/>.
21 Fetching similar artists from last.fm web services
24 # standard library import
27 from collections import deque
28 from hashlib import md5
30 # third parties components
33 from .plugin import Plugin
34 from .track import Track
35 from .meta import Artist
36 from ..utils.utils import WSError
39 """Caching decorator"""
40 def wrapper(*args, **kwargs):
41 #pylint: disable=W0212,C0111
43 similarities = [art for art in args[1]]
44 hashedlst = md5(''.join(similarities).encode('utf-8')).hexdigest()
45 if hashedlst in cls._cache.get('asearch'):
46 cls.log.debug('cached request')
47 results = cls._cache.get('asearch').get(hashedlst)
49 results = func(*args, **kwargs)
50 cls.log.debug('caching request')
51 cls._cache.get('asearch').update({hashedlst:list(results)})
52 random.shuffle(results)
57 class WebService(Plugin):
58 """similar artists webservice
61 def __init__(self, daemon):
62 Plugin.__init__(self, daemon)
63 self.daemon_conf = daemon.config
65 self.history = daemon.short_history
75 self.queue_mode = wrapper.get(self.plugin_conf.get('queue_mode'))
78 def _flush_cache(self):
80 Both flushes and instanciates _cache
82 name = self.__class__.__name__
83 if isinstance(self._cache, dict):
84 self.log.info('{0}: Flushing cache!'.format(name))
86 self.log.info('{0}: Initialising cache!'.format(name))
92 def _cleanup_cache(self):
93 """Avoid bloated cache
95 for _ , val in self._cache.items():
96 if isinstance(val, dict):
100 def get_history(self, artist):
101 """Constructs list of Track for already played titles for an artist.
103 duration = self.daemon_conf.getint('sima', 'history_duration')
104 tracks_from_db = self.sdb.get_history(duration=duration, artist=artist)
105 # Construct Track() objects list from database history
106 played_tracks = [Track(artist=tr[-1], album=tr[1], title=tr[2],
107 file=tr[3]) for tr in tracks_from_db]
110 def filter_track(self, tracks):
112 Extract one unplayed track from a Track object list.
114 * not already in the queue
117 artist = tracks[0].artist
118 black_list = self.player.queue + self.to_add
119 not_in_hist = list(set(tracks) - set(self.get_history(artist=artist)))
121 self.log.debug('All tracks already played for "{}"'.format(artist))
122 random.shuffle(not_in_hist)
123 #candidate = [ trk for trk in not_in_hist if trk not in black_list
124 #if not self.sdb.get_bl_track(trk, add_not=True)]
126 for trk in [_ for _ in not_in_hist if _ not in black_list]:
127 if self.sdb.get_bl_track(trk, add_not=True):
128 self.log.info('Blacklisted: {0}: '.format(trk))
130 if self.sdb.get_bl_album(trk, add_not=True):
131 self.log.info('Blacklisted album: {0}: '.format(trk))
133 # Should use albumartist heuristic as well
134 if self.plugin_conf.getboolean('single_album'):
135 if (trk.album == self.player.current.album or
136 trk.album in [tr.album for tr in self.to_add]):
137 self.log.debug('Found unplayed track ' +
138 'but from an album already queued: %s' % (trk))
140 candidate.append(trk)
142 self.log.debug('Unable to find title to add' +
143 ' for "%s".' % artist)
145 self.to_add.append(random.choice(candidate))
147 def _get_artists_list_reorg(self, alist):
149 Move around items in artists_list in order to play first not recently
152 # TODO: move to utils as a decorator
153 duration = self.daemon_conf.getint('sima', 'history_duration')
155 for trk in self.sdb.get_history(duration=duration,
157 if trk[0] not in art_in_hist:
158 art_in_hist.append(trk[0])
159 art_in_hist.reverse()
160 art_not_in_hist = [ ar for ar in alist if ar not in art_in_hist ]
161 random.shuffle(art_not_in_hist)
162 art_not_in_hist.extend(art_in_hist)
163 self.log.debug('history ordered: {}'.format(
164 ' / '.join(art_not_in_hist)))
165 return art_not_in_hist
168 def get_artists_from_player(self, similarities):
170 Look in player library for availability of similar artists in
173 dynamic = self.plugin_conf.getint('max_art')
177 similarities.reverse()
178 while (len(results) < dynamic
179 and len(similarities) > 0):
180 art_pop = similarities.pop()
181 results.extend(self.player.fuzzy_find_artist(art_pop))
184 def lfm_similar_artists(self, artist=None):
186 Retrieve similar artists from WebServive.
189 curr = self.player.current.__dict__
190 name = curr.get('artist')
191 mbid = curr.get('musicbrainz_artistid', None)
192 current = Artist(name=name, mbid=mbid)
195 # initialize artists deque list to construct from DB
197 as_artists = self.ws().get_similar(artist=current)
198 self.log.debug('Requesting {1} for "{0}"'.format(current,
201 # TODO: let's propagate Artist type
202 [as_art.append(str(art)) for art in as_artists]
203 except WSError as err:
204 self.log.warning('{0}: {1}'.format(self.ws.name, err))
206 self.log.debug('Fetched {0} artist(s)'.format(len(as_art)))
207 if self.ws.ratelimit:
208 self.log.info('{0.name} ratelimit: {0.ratelimit}'.format(self.ws))
211 def get_recursive_similar_artist(self):
213 history = deque(self.history)
216 current = self.player.current
218 while depth < self.plugin_conf.getint('depth'):
219 if len(history) == 0:
221 trk = history.popleft()
222 if (trk.artist in [trk.artist for trk in extra_arts]
223 or trk.artist == current.artist):
225 extra_arts.append(trk)
227 self.log.info('EXTRA ARTS: {}'.format(
228 '/'.join([trk.artist for trk in extra_arts])))
229 for artist in extra_arts:
231 'Looking for artist similar to "{0.artist}" as well'.format(
233 similar = self.lfm_similar_artists(artist=artist)
236 ret_extra.extend(self.get_artists_from_player(similar))
237 if current.artist in ret_extra:
238 ret_extra.remove(current.artist)
241 def get_local_similar_artists(self):
242 """Check against local player for similar artists
244 current = self.player.current
245 self.log.info('Looking for artist similar to "{0.artist}"'.format(current))
246 similar = self.lfm_similar_artists()
248 self.log.info('Got nothing from {0}!'.format(self.ws.name))
250 self.log.info('First five similar artist(s): {}...'.format(
251 ' / '.join([a for a in list(similar)[0:5]])))
252 self.log.info('Looking availability in music library')
253 ret = self.get_artists_from_player(similar)
255 if len(self.history) >= 2:
256 if self.plugin_conf.getint('depth') > 1:
257 ret_extra = self.get_recursive_similar_artist()
259 ret = list(set(ret) | set(ret_extra))
261 self.log.warning('Got nothing from music library.')
262 self.log.warning('Try running in debug mode to guess why...')
264 self.log.info('Got {} artists in library'.format(len(ret)))
265 self.log.info(' / '.join(ret))
266 # Move around similars items to get in unplayed|not recently played
268 return self._get_artists_list_reorg(ret)
270 def _get_album_history(self, artist=None):
271 """Retrieve album history"""
272 duration = self.daemon_conf.getint('sima', 'history_duration')
274 for trk in self.sdb.get_history(artist=artist, duration=duration):
275 albums_list.add(trk[1])
278 def find_album(self, artists):
279 """Find albums to queue.
283 target_album_to_add = self.plugin_conf.getint('album_to_add')
284 for artist in artists:
285 self.log.info('Looking for an album to add for "%s"...' % artist)
286 albums = self.player.find_albums(artist)
287 # str conversion while Album type is not propagated
288 albums = [ str(album) for album in albums]
290 self.log.debug('Albums candidate: {0:s}'.format(
293 # albums yet in history for this artist
295 albums_yet_in_hist = albums & self._get_album_history(artist=artist)
296 albums_not_in_hist = list(albums - albums_yet_in_hist)
297 # Get to next artist if there are no unplayed albums
298 if not albums_not_in_hist:
299 self.log.info('No album found for "%s"' % artist)
301 album_to_queue = str()
302 random.shuffle(albums_not_in_hist)
303 for album in albums_not_in_hist:
304 tracks = self.player.find_album(artist, album)
305 # Look if one track of the album is already queued
306 # Good heuristic, at least enough to guess if the whole album is
308 if tracks[0] in self.player.queue:
309 self.log.debug('"%s" already queued, skipping!' %
312 album_to_queue = album
313 if not album_to_queue:
314 self.log.info('No album found for "%s"' % artist)
316 self.log.info('{2} album candidate: {0} - {1}'.format(
317 artist, album_to_queue, self.ws.name))
319 self.to_add.extend(self.player.find_album(artist, album_to_queue))
320 if nb_album_add == target_album_to_add:
324 """Get some tracks for track queue mode
326 artists = self.get_local_similar_artists()
327 nbtracks_target = self.plugin_conf.getint('track_to_add')
328 for artist in artists:
329 self.log.debug('Trying to find titles to add for "{}"'.format(
331 found = self.player.find_track(artist)
332 # find tracks not in history for artist
333 self.filter_track(found)
334 if len(self.to_add) == nbtracks_target:
337 self.log.debug('Found no tracks to queue, is your ' +
338 'history getting too large?')
340 for track in self.to_add:
341 self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
344 """Get albums for album queue mode
346 artists = self.get_local_similar_artists()
347 self.find_album(artists)
350 """Get some tracks for top track queue mode
352 #artists = self.get_local_similar_artists()
355 def callback_need_track(self):
356 self._cleanup_cache()
357 if not self.player.current:
358 self.log.info('No current track, cannot queue')
360 if not self.player.current.artist:
361 self.log.warning('No artist set for the current track')
362 self.log.debug(repr(self.player.current))
365 candidates = self.to_add
367 if self.plugin_conf.get('queue_mode') != 'album':
368 random.shuffle(candidates)
371 def callback_player_database(self):
375 # vim: ai ts=4 sw=4 sts=4 expandtab