]> kaliko git repositories - mpd-sima.git/blobdiff - sima/plugins/internal/tags.py
Extract Tags control_config method from plugin
[mpd-sima.git] / sima / plugins / internal / tags.py
index 1536c5ce2c87a91ba464861aa9a9d4b3ebef094a..70d1a03e06609aaa774e94ade588ab98717d8cca 100644 (file)
@@ -22,17 +22,38 @@ Add titles based on tags
 """
 
 # standard library import
+import logging
 import random
 
 # third parties components
 from musicpd import CommandError
 
 # local import
-from ...lib.plugin import Plugin, AdvancedLookUp
-from ...lib.meta import Artist, Album
+from ...lib.plugin import AdvancedPlugin
+from ...lib.meta import Artist, MetaContainer
 from ...utils.utils import PluginException
 
 
+def control_config(tags_config):
+    log = logging.getLogger('sima')
+    sup_tags = Tags.supported_tags
+    config_tags = {k for k, v in tags_config.items()
+                   if (v and k in Tags.supported_tags)}
+    if not tags_config.get('filter', None) and \
+            config_tags.isdisjoint(sup_tags):
+        log.warning('Found no config for Tags plugin! '
+                  'Need at least "filter" or a supported tag')
+        log.info('Supported Tags are : %s', ', '.join(sup_tags))
+        # raise PluginException('plugin misconfiguration')
+        return False
+    if config_tags.difference(sup_tags):
+        log.error('Found unsupported tag in config: %s',
+                   config_tags.difference(sup_tags))
+        # raise PluginException('plugin misconfiguration')
+        return False
+    return True
+
+
 def forge_filter(cfg):
     tags = set(cfg.keys()) & Tags.supported_tags
     cfg_filter = cfg.get('filter', None)
@@ -48,38 +69,27 @@ def forge_filter(cfg):
         else:
             mpd_filter.append(f"({tag} == '{cfg[tag].strip()}')")
     mpd_filter = ' AND '.join(mpd_filter)
-    if 'AND' in mpd_filter:
-        mpd_filter = f'({mpd_filter})'
+    # Ensure there is at least an artist name
+    mpd_filter = f"({mpd_filter} AND (artist != ''))"
     return mpd_filter
 
 
-class Tags(Plugin, AdvancedLookUp):
+class Tags(AdvancedPlugin):
     """Add track based on tags content
     """
     supported_tags = {'comment', 'date', 'genre', 'label', 'originaldate'}
-    options = {'queue_mode', 'priority', 'filter', 'track_to_add', 'album_to_add'}
+    # options = {'queue_mode', 'priority', 'filter', 'track_to_add',
+    #            'album_to_add'}
 
     def __init__(self, daemon):
         super().__init__(daemon)
-        self.daemon = daemon
         self._control_conf()
         self.mpd_filter = forge_filter(self.plugin_conf)
         self._setup_tagsneeded()
         self.log.debug('mpd filter: %s', self.mpd_filter)
 
     def _control_conf(self):
-        sup_tags = Tags.supported_tags
-        config_tags = {k for k, v in self.plugin_conf.items()
-                       if (v and k not in Tags.options)}
-        if not self.plugin_conf.get('filter', None) and \
-                config_tags.isdisjoint(sup_tags):
-            self.log.error('Found no config for %s plugin! '
-                           'Need at least "filter" or a supported tag', self)
-            self.log.info('Supported Tags are : %s', ', '.join(sup_tags))
-            raise PluginException('plugin misconfiguration')
-        if config_tags.difference(sup_tags):
-            self.log.error('Found unsupported tag in config: %s',
-                           config_tags.difference(sup_tags))
+        if not control_config(self.plugin_conf):
             raise PluginException('plugin misconfiguration')
 
     def _setup_tagsneeded(self):
@@ -111,54 +121,27 @@ class Tags(Plugin, AdvancedLookUp):
             raise PluginException('Badly formated filter in tags plugin configuration: "%s"'
                                   % self.plugin_conf['filter'])
 
-    def callback_need_track_(self):
-        candidates = []
-        queue_mode = self.plugin_conf.get('queue_mode', 'track')
-        target = self.plugin_conf.getint(f'{queue_mode}_to_add')
-        tracks = self.player.find(self.mpd_filter)
-        random.shuffle(tracks)
-        history = self.get_history()
-        while tracks:
-            trk = tracks.pop()
-            if trk in self.player.queue or \
-               trk in candidates:
-                self.log.debug('%s already queued', trk)
-                continue
-            if trk in history:
-                self.log.debug('%s in history', trk)
-                continue
-            candidates.append(trk)
-            self.log.info('Tags candidate: {}'.format(trk))
-            if len(candidates) >= target:
-                break
-        if queue_mode == 'track':
-            return candidates
-        if queue_mode == 'album':
-            for trk in candidates:
-                self.log.info(trk.Artist)
-                _ = self.album_candidate(trk.Artist)
-        if not candidates:
-            self.log.info('Tags plugin failed to find some tracks')
-        return candidates
-
     def callback_need_track(self):
         candidates = []
         queue_mode = self.plugin_conf.get('queue_mode', 'track')
         target = self.plugin_conf.getint(f'{queue_mode}_to_add')
         # look for artists acording to filter
-        artists = self.player.list('artist', self.mpd_filter)
+        artists = [Artist(name=a) for a in self.player.list('artist', self.mpd_filter)]
         random.shuffle(artists)
+        artists = MetaContainer(artists)
+        if not artists:
+            self.log.info('Tags plugin found nothing to queue')
+            return candidates
         artists = self.get_reorg_artists_list(artists)
-        self.log.debug('Tags candidates: %s', ' / '.join(artists))
+        self.log.debug('Tags plugin found: %s', ' / '.join(map(str, artists)))
         for artist in artists:
-            if artist in {t.Artist for t in self.player.queue}:
-                continue
             self.log.debug('looking for %s', artist)
-            trk = self.filter_track(self.player.find_tracks(Artist(name=artist)))
+            tracks = self.player.find_tracks(artist)
+            trk = self.filter_track(tracks)
             if not trk:
                 continue
             if queue_mode == 'track':
-                self.log.info('Tags candidate: {}'.format(trk))
+                self.log.info('Tags plugin chose: {}'.format(trk))
                 candidates.append(trk)
                 if len(candidates) == target:
                     break