File: webserv.py

package info (click to toggle)
mpd-sima 0.18.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 716 kB
  • sloc: python: 4,364; sh: 222; makefile: 166
file content (369 lines) | stat: -rw-r--r-- 13,790 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# -*- coding: utf-8 -*-
# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
# Copyright (c) 2019 sacha <sachahony@gmail.com>
#
#  This file is part of sima
#
#  sima is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  sima is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with sima.  If not, see <http://www.gnu.org/licenses/>.
#
#
"""
Fetching similar artists from last.fm web services
"""

# standard library import
import random

from collections import deque
from hashlib import md5

# third parties components

# local import
from .plugin import AdvancedPlugin
from .meta import Artist, MetaContainer
from ..utils.utils import WSError, WSNotFound, WSTimeout


def cache(func):
    """Caching decorator"""
    def wrapper(*args, **kwargs):
        #pylint: disable=W0212,C0111
        cls = args[0]
        similarities = [art.name for art in args[1]]
        hashedlst = md5(''.join(similarities).encode('utf-8')).hexdigest()
        if hashedlst in cls._cache.get('asearch'):
            cls.log.debug('cached request')
            results = cls._cache.get('asearch').get(hashedlst)
        else:
            results = func(*args, **kwargs)
            cls.log.debug('caching request')
            cls._cache.get('asearch').update({hashedlst: list(results)})
        random.shuffle(results)
        return results
    return wrapper


class WebService(AdvancedPlugin):
    """similar artists webservice
    """

    def __init__(self, daemon):
        super().__init__(daemon)
        self.history = daemon.short_history
        ##
        self._cache = None
        self._flush_cache()
        wrapper = {'track': self._track,
                   'top': self._top,
                   '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):
        """
        Both flushes and instanciates _cache
        """
        name = self.__class__.__name__
        if isinstance(self._cache, dict):
            self.log.info('%s: Flushing cache!', name)
        else:
            self.log.info('%s: Initialising cache!', name)
        self._cache = {'asearch': {},
                       'tsearch': {}}

    def _cleanup_cache(self):
        """Avoid bloated cache
        """
        for _, val in self._cache.items():
            if isinstance(val, dict):
                while len(val) > 150:
                    val.popitem()

    @cache
    def get_artists_from_player(self, similarities):
        """
        Look in player library for availability of similar artists in
        similarities
        """
        dynamic = self.plugin_conf.getint('max_art')
        if dynamic <= 0:
            dynamic = 100
        results = []
        similarities.reverse()
        while (len(results) < dynamic+1 and similarities):
            art_pop = similarities.pop()
            res = self.player.search_artist(art_pop)
            if res:
                results.append(res)
        return results

    def ws_similar_artists(self, artist):
        """
        Retrieve similar artists from WebServive.
        """
        # initialize artists deque list to construct from DB
        as_art = deque()
        as_artists = self.ws.get_similar(artist=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('%s: %s', self.ws.name, err)
            if artist.mbid:
                self.log.info('Trying without MusicBrainzID')
                try:
                    return self.ws_similar_artists(Artist(name=artist.name))
                except WSNotFound as 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('%s: %s', self.ws.name, err)
        if 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 []
        history = list(self.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 = []
        ret_extra = []
        depth = 0
        while depth < self.plugin_conf.getint('depth'):
            if not history:
                break
            trk = history.popleft()
            if (trk.Artist in extra_arts
                    or trk.Artist == last_trk.Artist):
                continue
            extra_arts.append(trk.Artist)
            depth += 1
        self.log.debug('EXTRA ARTS: %s', '/'.join(map(str, extra_arts)))
        for artist in extra_arts:
            self.log.debug('Looking for artist similar '
                           'to "%s" as well', artist)
            similar = self.ws_similar_artists(artist=artist)
            if not similar:
                continue
            ret_extra.extend(self.get_artists_from_player(similar))

        if last_trk.Artist in ret_extra:
            ret_extra.remove(last_trk.Artist)
        if ret_extra:
            self.log.debug('similar artist(s) found: %s',
                           ' / '.join(map(str, MetaContainer(ret_extra))))
        return ret_extra

    def get_local_similar_artists(self):
        """Check against local player for similar artists
        """
        if not self.player.playlist:
            return []
        tolookfor = self.player.playlist[-1].Artist
        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 %s!', self.ws.name)
            return []
        self.log.info('First five similar artist(s): %s...',
                      ' / '.join(map(str, list(similar)[:5])))
        self.log.info('Looking availability in music library')
        ret = MetaContainer(self.get_artists_from_player(similar))
        if ret:
            self.log.debug('regular found in library: %s',
                           ' / '.join(map(str, ret)))
        else:
            self.log.debug('Got nothing similar from library!')
        ret_extra = None
        if len(self.history) >= 2:
            if self.plugin_conf.getint('depth') > 1:
                ret_extra = self.get_recursive_similar_artist()
        if ret_extra:
            # get them reorg to pick up best element
            ret_extra = self.get_reorg_artists_list(ret_extra)
            # tries to pickup less artist from extra art
            if len(ret) > 4:
                ret_extra = MetaContainer(ret_extra[:max(4, len(ret))//2])
            if ret_extra:
                self.log.debug('extra found in library: %s',
                               ' / '.join(map(str, ret_extra)))
            ret = ret | ret_extra
        if not ret:
            self.log.warning('Got nothing from music library.')
            return []
        # 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: '
                           '%s', '/'.join(map(str, ret & queued_artists)))
            ret = ret - queued_artists
        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 %d artists in library', len(ret))
        candidates = self.get_reorg_artists_list(ret)
        if candidates:
            self.log.info(' / '.join(map(str, candidates)))
        return candidates

    def find_album(self, artists):
        """Find albums to queue.
        """
        to_add = []
        nb_album_add = 0
        target_album_to_add = self.plugin_conf.getint('album_to_add')
        for artist in artists:
            album = self.album_candidate(artist, unplayed=True)
            if not album:
                continue
            nb_album_add += 1
            candidates = self.player.find_tracks(album)
            if not candidates:
                continue
            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]
            to_add.extend(candidates)
            if nb_album_add == target_album_to_add:
                return to_add
        return to_add

    def find_top(self, artists):
        """
        find top tracks for artists in artists list.
        """
        to_add = []
        nbtracks_target = self.plugin_conf.getint('track_to_add')
        for artist in artists:
            if len(to_add) == nbtracks_target:
                break
            self.log.info('Looking for a top track for %s', artist)
            titles = deque()
            try:
                titles = list(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.search_track(artist, trk.title)
                if found:
                    random.shuffle(found)
                    top_trk = self.filter_track(found, to_add)
                    if top_trk:
                        to_add.append(top_trk)
                        break
        return to_add

    def _track(self):
        """Get some tracks for track queue mode

        :return: list of Tracks
        """
        to_add = []
        artists = self.get_local_similar_artists()
        nbtracks_target = self.plugin_conf.getint('track_to_add')
        for artist in artists:
            self.log.debug('Trying to find titles to add for "%r"', artist)
            found = self.player.find_tracks(artist)
            if not found:
                self.log.debug('Found nothing to queue for %s', artist)
                continue
            random.shuffle(found)
            # find tracks not in history for artist
            track_candidate = self.filter_track(found, to_add)
            if track_candidate:
                to_add.append(track_candidate)
                self.log.info('%s plugin chose: %s',
                              self.ws.name, track_candidate)
            if len(to_add) == nbtracks_target:
                break
        return to_add

    def _album(self):
        """Get albums for album queue mode

        :return: list of Tracks
        """
        artists = self.get_local_similar_artists()
        return self.find_album(artists)

    def _top(self):
        """Get some tracks for top track queue mode

        :return: list of Tracks
        """
        artists = self.get_local_similar_artists()
        chosen = self.find_top(artists)
        for track in chosen:
            self.log.info('%s candidates: %s', self.ws.name, track)
        return chosen

    def callback_need_track(self):
        self._cleanup_cache()
        if not self.player.playlist:
            self.log.info('No last track, cannot queue')
            return None
        if not self.player.playlist[-1].artist:
            self.log.warning('No artist set for the last track in queue')
            self.log.debug(repr(self.player.current))
            return None
        candidates = self.queue_mode()
        msg = ' '.join([f'{k}: {v:>3d}' for
                        k, v in sorted(self.ws.stats.items())])
        self.log.debug('http stats: ' + msg)
        if not candidates:
            self.log.info('%s plugin found nothing to queue', self.ws.name)
        if self.plugin_conf.get('queue_mode') != 'album':
            random.shuffle(candidates)
        return candidates

    def callback_player_database(self):
        self._flush_cache()

# VIM MODLINE
# vim: ai ts=4 sw=4 sts=4 expandtab