sima/plugins/internal/randomfallback.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
   3 #
   4 #  This file is part of sima
   5 #
   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.
  10 #
  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.
  15 #
  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/>.
  18 #
  19 #
  20 """
  21 Fetching similar artists from last.fm web services
  22 """
  23
  24 # standard library import
  25 import random
  26
  27 # third parties components
  28
  29 # local import
  30 from ...lib.plugin import Plugin
  31 from ...lib.meta import Artist
  32
  33
  34 class RandomFallBack(Plugin):
  35     """Add random track as fallback
  36     TODO: refactor, this plugin does not look good to me.
  37           callback_need_track_fb/get_trk articulation is not elegant at all
  38     """
  39
  40     def __init__(self, daemon):
  41         super().__init__(daemon)
  42         self.daemon = daemon
  43         if not self.plugin_conf:
  44             return
  45         self.mode = self.plugin_conf.get('flavour', None)
  46         if self.mode not in ['pure', 'sensible']:
  47             self.log.warning('Bad value for flavour, '
  48                     '"{}" not in ["pure", "sensible"]'.format(self.mode))
  49             self.mode = 'pure'
  50
  51     def get_played_artist(self,):
  52         """Constructs list of already played artists.
  53         """
  54         duration = self.daemon.config.getint('sima', 'history_duration')
  55         tracks_from_db = self.daemon.sdb.get_history(duration=duration)
  56         # Construct Track() objects list from database history
  57         artists = [tr[-1] for tr in tracks_from_db]
  58         return set(artists)
  59
  60     def callback_need_track_fb(self):
  61         trks = list()
  62         target = self.plugin_conf.getint('track_to_add')
  63         limit = 0
  64         while len(trks) < target:
  65             trk = self.get_trk()
  66             if trk:
  67                 trks.append(trk)
  68             else:
  69                 limit += 1
  70                 if limit > 3:
  71                     return trks
  72         return trks
  73
  74     def get_trk(self):
  75         """Get a single track according to random flavour
  76         """
  77         trk = None
  78         art = None
  79         artists = list(self.player.artists)
  80         if self.mode == 'sensible':
  81             played_art = self.get_played_artist()
  82             while artists:
  83                 art = random.choice(artists)
  84                 if art not in played_art:
  85                     break
  86                 artists.pop(art)
  87         elif self.mode == 'pure':
  88             art = random.choice(artists)
  89         if art is None:
  90             return None
  91         self.log.debug('Random art: {}'.format(art))
  92         trks = self.player.find_track(Artist(art))
  93         if trks:
  94             trk = random.choice(trks)
  95             self.log.info('random fallback ({}): {}'.format(self.mode, trk))
  96         return trk
  97
  98
  99
 100 # VIM MODLINE
 101 # vim: ai ts=4 sw=4 sts=4 expandtab