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.name 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)))
120 if self.plugin_conf.get('queue_mode') != 'top' and not not_in_hist:
121 self.log.debug('All tracks already played for "{}"'.format(artist))
122 random.shuffle(not_in_hist)
124 for trk in [_ for _ in not_in_hist if _ not in black_list]:
125 # Should use albumartist heuristic as well
126 if self.plugin_conf.getboolean('single_album'):
127 if (trk.album == self.player.current.album or
128 trk.album in [tr.album for tr in self.to_add]):
129 self.log.debug('Found unplayed track ' +
130 'but from an album already queued: %s' % (trk))
132 candidate.append(trk)
135 self.to_add.append(random.choice(candidate))
138 def _get_artists_list_reorg(self, alist):
140 Move around items in artists_list in order to play first not recently
144 duration = self.daemon_conf.getint('sima', 'history_duration')
145 for art in self.sdb.get_artists_history(alist, duration=duration):
148 reorg = [art for art in alist if art not in hist]
150 self.log.info('{}'.format(' / '.join([a.name for a in reorg])))
154 def get_artists_from_player(self, similarities):
156 Look in player library for availability of similar artists in
159 dynamic = self.plugin_conf.getint('max_art')
163 similarities.reverse()
164 while (len(results) < dynamic
165 and len(similarities) > 0):
166 art_pop = similarities.pop()
167 res = self.player.search_artist(art_pop)
172 def ws_similar_artists(self, artist=None):
174 Retrieve similar artists from WebServive.
176 # initialize artists deque list to construct from DB
178 as_artists = self.ws.get_similar(artist=artist)
179 self.log.debug('Requesting {} for {!r}'.format(self.ws.name, artist))
181 [as_art.append(art) for art in as_artists]
182 except WSError as err:
183 self.log.warning('{}: {}'.format(self.ws.name, err))
185 self.log.debug('Fetched {} artist(s)'.format(len(as_art)))
188 def get_recursive_similar_artist(self):
189 history = deque(self.history)
192 if not self.player.playlist:
194 last_trk = self.player.playlist[-1]
196 while depth < self.plugin_conf.getint('depth'):
197 if len(history) == 0:
199 trk = history.popleft()
200 if (trk.Artist in extra_arts
201 or trk.Artist == last_trk.Artist):
203 extra_arts.append(trk.Artist)
205 self.log.info('EXTRA ARTS: {}'.format(
206 '/'.join([art.name for art in extra_arts])))
207 for artist in extra_arts:
208 self.log.debug('Looking for artist similar '
209 'to "{}" as well'.format(artist))
210 similar = self.ws_similar_artists(artist=artist)
213 ret_extra = set(self.get_artists_from_player(similar))
214 if last_trk.Artist in ret_extra:
215 ret_extra.remove(last_trk.Artist)
218 def get_local_similar_artists(self):
219 """Check against local player for similar artists
221 if not self.player.playlist:
223 tolookfor = self.player.playlist[-1].Artist
224 self.log.info('Looking for artist similar to "{}"'.format(tolookfor))
225 similar = self.ws_similar_artists(tolookfor)
227 self.log.info('Got nothing from {0}!'.format(self.ws.name))
229 self.log.info('First five similar artist(s): {}...'.format(
230 ' / '.join([a.name for a in list(similar)[0:5]])))
231 self.log.info('Looking availability in music library')
232 ret = set(self.get_artists_from_player(similar))
234 if len(self.history) >= 2:
235 if self.plugin_conf.getint('depth') > 1:
236 ret_extra = self.get_recursive_similar_artist()
238 ret = set(ret) | set(ret_extra)
240 self.log.warning('Got nothing from music library.')
241 self.log.warning('Try running in debug mode to guess why...')
243 queued_artists = { trk.Artist for trk in self.player.queue }
244 for art in queued_artists:
246 self.log.debug('Removing already queued artist: {0}'.format(art))
247 ret = ret - queued_artists
248 if ret & queued_artists:
249 self.log.debug('Removing already queued artist: {0}'.format(ret & queued_artists))
250 ret = ret - queued_artists
251 if self.player.current.Artist in ret:
252 self.log.debug('Removing current artist: {0}'.format(self.player.current.Artist))
253 ret = ret - {self.player.current.Artist}
254 # Move around similars items to get in unplayed|not recently played
256 self.log.info('Got {} artists in library'.format(len(ret)))
257 return self._get_artists_list_reorg(list(ret))
259 def _get_album_history(self, artist=None):
260 """Retrieve album history"""
261 duration = self.daemon_conf.getint('sima', 'history_duration')
263 for trk in self.sdb.get_history(artist=artist.name, duration=duration):
264 albums_list.add(trk[1])
267 def find_album(self, artists):
268 """Find albums to queue.
272 target_album_to_add = self.plugin_conf.getint('album_to_add')
273 for artist in artists:
274 self.log.info('Looking for an album to add for "%s"...' % artist)
275 albums = self.player.search_albums(artist)
276 # str conversion while Album type is not propagated
277 albums = [str(album) for album in albums]
279 self.log.debug('Albums candidate: {0:s}'.format(
282 # albums yet in history for this artist
284 albums_yet_in_hist = albums & self._get_album_history(artist=artist)
285 albums_not_in_hist = list(albums - albums_yet_in_hist)
286 # Get to next artist if there are no unplayed albums
287 if not albums_not_in_hist:
288 self.log.info('No album found for "%s"' % artist)
290 album_to_queue = str()
291 random.shuffle(albums_not_in_hist)
292 for album in albums_not_in_hist:
293 tracks = self.player.find_album(artist, album)
294 # Look if one track of the album is already queued
295 # Good heuristic, at least enough to guess if the whole album is
297 if tracks[0] in self.player.queue:
298 self.log.debug('"%s" already queued, skipping!' %
301 album_to_queue = album
302 if not album_to_queue:
303 self.log.info('No album found for "%s"' % artist)
305 self.log.info('{2} album candidate: {0} - {1}'.format(
306 artist, album_to_queue, self.ws.name))
308 self.to_add.extend(self.player.find_album(artist, album_to_queue))
309 if nb_album_add == target_album_to_add:
312 def find_top(self, artists):
314 find top tracks for artists in artists list.
317 nbtracks_target = self.plugin_conf.getint('track_to_add')
318 for artist in artists:
319 artist = Artist(name=artist)
320 if len(self.to_add) == nbtracks_target:
322 self.log.info('Looking for a top track for {0}'.format(artist))
325 titles = [t for t in self.ws.get_toptrack(artist)]
326 except WSError as err:
327 self.log.warning('{0}: {1}'.format(self.ws.name, err))
328 if self.ws.ratelimit:
329 self.log.info('{0.name} ratelimit: {0.ratelimit}'.format(self.ws))
331 found = self.player.fuzzy_find_track(artist.name, trk.title)
332 random.shuffle(found)
334 self.log.debug('{0}'.format(found[0]))
335 if self.filter_track(found):
339 """Get some tracks for track queue mode
341 artists = self.get_local_similar_artists()
342 nbtracks_target = self.plugin_conf.getint('track_to_add')
343 for artist in artists:
344 self.log.debug('Trying to find titles to add for "{}"'.format(
346 found = self.player.find_track(artist)
347 random.shuffle(found)
349 self.log.debug('Found nothing to queue for {0}'.format(artist))
351 # find tracks not in history for artist
352 self.filter_track(found)
353 if len(self.to_add) == nbtracks_target:
356 self.log.debug('Found no tracks to queue!')
358 for track in self.to_add:
359 self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
362 """Get albums for album queue mode
364 artists = self.get_local_similar_artists()
365 self.find_album(artists)
368 """Get some tracks for top track queue mode
370 artists = self.get_local_similar_artists()
371 self.find_top(artists)
372 for track in self.to_add:
373 self.log.info('{1} candidates: {0!s}'.format(track, self.ws.name))
375 def callback_need_track(self):
376 self._cleanup_cache()
377 if len(self.player.playlist) == 0:
378 self.log.info('No last track, cannot queue')
380 if not self.player.playlist[-1].artist:
381 self.log.warning('No artist set for the last track in queue')
382 self.log.debug(repr(self.player.current))
385 msg = ' '.join(['{0}: {1:>3d}'.format(k, v) for
386 k, v in sorted(self.ws.stats.items())])
388 candidates = self.to_add
390 if self.plugin_conf.get('queue_mode') != 'album':
391 random.shuffle(candidates)
394 def callback_player_database(self):
398 # vim: ai ts=4 sw=4 sts=4 expandtab