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
  26 # third parties components
  27 from musicpd import CommandError
  28
  29 # local import
  30 from ...lib.plugin import AdvancedPlugin
  31 from ...lib.meta import Artist, MetaContainer
  32 from ...utils.utils import PluginException
  33
  34
  35 def forge_filter(cfg):
  36     tags = set(cfg.keys()) & Tags.supported_tags
  37     cfg_filter = cfg.get('filter', None)
  38     mpd_filter = []
  39     if cfg_filter:
  40         mpd_filter.append(cfg_filter)
  41     for tag in tags:
  42         if not cfg[tag]:  # avoid empty tags entries in config
  43             continue
  44         if ',' in cfg[tag]:
  45             patt = '|'.join(map(str.strip, cfg[tag].split(',')))
  46             mpd_filter.append(f"({tag} =~ '({patt})')")
  47         else:
  48             mpd_filter.append(f"({tag} == '{cfg[tag].strip()}')")
  49     mpd_filter = ' AND '.join(mpd_filter)
  50     # Ensure there is at least an artist name
  51     mpd_filter = f"({mpd_filter} AND (artist != ''))"
  52     return mpd_filter
  53
  54
  55 class Tags(AdvancedPlugin):
  56     """Add track based on tags content
  57     """
  58     supported_tags = {'comment', 'date', 'genre', 'label', 'originaldate'}
  59     options = {'queue_mode', 'priority', 'filter', 'track_to_add', 'album_to_add'}
  60
  61     def __init__(self, daemon):
  62         super().__init__(daemon)
  63         self._control_conf()
  64         self.mpd_filter = forge_filter(self.plugin_conf)
  65         self._setup_tagsneeded()
  66         self.log.debug('mpd filter: %s', self.mpd_filter)
  67
  68     def _control_conf(self):
  69         sup_tags = Tags.supported_tags
  70         config_tags = {k for k, v in self.plugin_conf.items()
  71                        if (v and k not in Tags.options)}
  72         if not self.plugin_conf.get('filter', None) and \
  73                 config_tags.isdisjoint(sup_tags):
  74             self.log.error('Found no config for %s plugin! '
  75                            'Need at least "filter" or a supported tag', self)
  76             self.log.info('Supported Tags are : %s', ', '.join(sup_tags))
  77             raise PluginException('plugin misconfiguration')
  78         if config_tags.difference(sup_tags):
  79             self.log.error('Found unsupported tag in config: %s',
  80                            config_tags.difference(sup_tags))
  81             raise PluginException('plugin misconfiguration')
  82
  83     def _setup_tagsneeded(self):
  84         """Ensure needed tags are exposed by MPD"""
  85         # At this point mpd_filter concatenetes {tags}+filter
  86         config_tags = set()
  87         for mpd_supp_tags in self.player.MPD_supported_tags:
  88             if mpd_supp_tags.lower() in self.mpd_filter.lower():
  89                 config_tags.add(mpd_supp_tags.lower())
  90         self.log.debug('%s plugin needs the following metadata: %s',
  91                        self, config_tags)
  92         tags = config_tags & Tags.supported_tags
  93         self.player.needed_tags |= tags
  94
  95     def start(self):
  96         if (0, 21, 0) > tuple(map(int, self.player.mpd_version.split('.'))):
  97             self.log.warning('MPD protocol version: %s < 0.21.0',
  98                              self.player.mpd_version)
  99             self.log.error(
 100                 'Need at least MPD 0.21 to use Tags plugin (filters required)')
 101             self.player.disconnect()
 102             raise PluginException('MPD >= 0.21 required')
 103         # Check filter is valid
 104         try:
 105             if self.plugin_conf['filter']:
 106                 # Use window to limit response size
 107                 self.player.find(self.plugin_conf['filter'], "window", (0, 1))
 108         except CommandError:
 109             raise PluginException('Badly formated filter in tags plugin configuration: "%s"'
 110                                   % self.plugin_conf['filter'])
 111
 112     def callback_need_track(self):
 113         candidates = []
 114         queue_mode = self.plugin_conf.get('queue_mode', 'track')
 115         target = self.plugin_conf.getint(f'{queue_mode}_to_add')
 116         # look for artists acording to filter
 117         artists = MetaContainer([Artist(name=a) for a in self.player.list('artist', self.mpd_filter)])
 118         if not artists:
 119             self.log.info('Tags plugin found nothing to queue')
 120             return candidates
 121         artists = self.get_reorg_artists_list(artists)
 122         self.log.debug('Tags plugin found: %s', ' / '.join(map(str, artists)))
 123         for artist in artists:
 124             self.log.debug('looking for %s', artist)
 125             tracks = self.player.find_tracks(artist)
 126             trk = self.filter_track(tracks)
 127             if not trk:
 128                 continue
 129             if queue_mode == 'track':
 130                 self.log.info('Tags plugin chose: {}'.format(trk))
 131                 candidates.append(trk)
 132                 if len(candidates) == target:
 133                     break
 134             else:
 135                 album = self.album_candidate(trk.Artist, unplayed=True)
 136                 if not album:
 137                     continue
 138                 candidates.extend(self.player.find_tracks(album))
 139                 if len({t.album for t in candidates}) == target:
 140                     break
 141         return candidates
 142
 143 # VIM MODLINE
 144 # vim: ai ts=4 sw=4 sts=4 expandtab