sima/plugins/internal/tags.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2020 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 Add titles based on tags
  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.track import Track
  32 from ...utils.utils import PluginConfException, PluginException
  33
  34 def forge_filter(cfg):
  35     tags = set(cfg.keys()) & Tags.supported_tags
  36     cfg_filter = cfg.get('filter', None)
  37     mpd_filter = []
  38     if cfg_filter:
  39         mpd_filter.append(cfg_filter)
  40     for tag in tags:
  41         if not cfg[tag]:  # avoid empty tags entries in config
  42             continue
  43         if ',' in cfg[tag]:
  44             patt = '|'.join(map(str.strip, cfg[tag].split(',')))
  45             mpd_filter.append(f"({tag} =~ '({patt})')")
  46         else:
  47             mpd_filter.append(f"({tag} == '{cfg[tag].strip()}')")
  48     mpd_filter = ' AND '.join(mpd_filter)
  49     if 'AND' in mpd_filter:
  50         mpd_filter = f'({mpd_filter})'
  51     return mpd_filter
  52
  53
  54 class Tags(Plugin):
  55     """Add track based on tags content
  56     """
  57     supported_tags = {'comment', 'date', 'genre', 'label', 'originaldate'}
  58
  59     def __init__(self, daemon):
  60         super().__init__(daemon)
  61         self.daemon = daemon
  62         self._control_conf()
  63         self._setup_tagsneeded()
  64         self.mpd_filter = forge_filter(self.plugin_conf)
  65         self.log.debug('mpd filter: %s', self.mpd_filter)
  66
  67     def _control_conf(self):
  68         sup_tags = Tags.supported_tags
  69         if not self.plugin_conf.get('filter', None) and \
  70                 self.plugin_conf.keys().isdisjoint(sup_tags):
  71             self.log.error(
  72                 'Found no config for %s plugin! Need at least "filter" or a supported tag' % self)
  73             self.log.info('Supported Tags are : %s', ', '.join(sup_tags))
  74             raise PluginConfException('plugin misconfiguration')
  75
  76     def _setup_tagsneeded(self):
  77         self.log.debug('%s plugin needs the followinng metadata: %s',
  78                 self, set(self.plugin_conf.keys()) & Tags.supported_tags)
  79         tags = set(self.plugin_conf.keys()) & Tags.supported_tags
  80         self.player.needed_tags |= tags
  81
  82     def _get_history(self):
  83         """Constructs list of already played artists.
  84         """
  85         duration = self.daemon.config.getint('sima', 'history_duration')
  86         tracks_from_db = self.daemon.sdb.get_history(duration=duration)
  87         hist = [Track(file=tr[3], artist=tr[0]) for tr in tracks_from_db]
  88         return hist
  89
  90     def start(self):
  91         if (0, 21, 0) > tuple(map(int, self.player.mpd_version.split('.'))):
  92             self.log.warning('MPD protocol version: %s < 0.21.0',
  93                     self.player.mpd_version)
  94             self.log.error('Need at least MPD 0.21 to use Tags plugin (filters required)')
  95             self.player.disconnect()
  96             raise PluginException('MPD >= 0.21 required')
  97
  98     def callback_need_track(self):
  99         candidates = []
 100         target = self.plugin_conf.getint('track_to_add')
 101         tracks = self.player.find(self.mpd_filter)
 102         random.shuffle(tracks)
 103         history = self._get_history()
 104         while tracks:
 105             trk = tracks.pop()
 106             if trk in self.player.queue or \
 107                trk in candidates:
 108                 self.log.debug('%s already queued', trk)
 109                 continue
 110             if trk in history:
 111                 self.log.debug('%s in history', trk)
 112                 continue
 113             candidates.append(trk)
 114             self.log.info('Tags candidate: {}'.format(trk))
 115             if len(candidates) >= target:
 116                 break
 117         if not candidates:
 118             self.log.info('Tags plugin failed to find some tracks')
 119         return candidates
 120
 121 # VIM MODLINE
 122 # vim: ai ts=4 sw=4 sts=4 expandtab