X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Fplugins%2Finternal%2Ftags.py;h=7566e39b0ec68832660be6c4baaeec0642288826;hb=2b3bf3f5cef4ed9ff9e418b27194d89ca7e66b67;hp=9000c37cf6fa3af52a09222b5b776354efa247c7;hpb=abd0ec90f9ae6ea8eae2bc1515fcc8358bb6d4c9;p=mpd-sima.git diff --git a/sima/plugins/internal/tags.py b/sima/plugins/internal/tags.py index 9000c37..7566e39 100644 --- a/sima/plugins/internal/tags.py +++ b/sima/plugins/internal/tags.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2020 kaliko +# Copyright (c) 2020, 2021 kaliko # # This file is part of sima # @@ -22,18 +22,52 @@ 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 -from ...lib.track import Track -from ...utils.utils import PluginConfException, PluginException +from ...lib.plugin import AdvancedPlugin +from ...lib.meta import Artist, MetaContainer +from ...utils.utils import PluginException -def forge_filter(cfg): + +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)) + return False + if config_tags.difference(sup_tags): + log.error('Found unsupported tag in config: %s', + config_tags.difference(sup_tags)) + return False + return True + + +def forge_filter(cfg, logger): + """forge_filter merges tags config and user defined MPD filter into a single + MPD filter""" tags = set(cfg.keys()) & Tags.supported_tags cfg_filter = cfg.get('filter', None) + # Remove external enclosing parentheses in user defined MPD filter, for + # instance when there is more than one expression: + # ((genre == 'rock' ) AND (date =~ '198.')) + # Even though it's a valid MPD filter, forge_filter will enclose it + # properly. We do not want to through a syntax error at users since it's a + # valid MPD filter, hence trying to transparently reformat the filter + if cfg_filter.startswith('((') and cfg_filter.endswith('))'): + logger.debug('Drop external enclosing parentheses in user filter: %s', + cfg_filter[1:-1]) + cfg['filter'] = cfg_filter[1:-1] + cfg_filter = cfg['filter'] mpd_filter = [] if cfg_filter: mpd_filter.append(cfg_filter) @@ -46,76 +80,93 @@ 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): +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'} def __init__(self, daemon): super().__init__(daemon) - self.daemon = daemon self._control_conf() + self.mpd_filter = forge_filter(self.plugin_conf, self.log) self._setup_tagsneeded() - self.mpd_filter = forge_filter(self.plugin_conf) self.log.debug('mpd filter: %s', self.mpd_filter) def _control_conf(self): - sup_tags = Tags.supported_tags - if not self.plugin_conf.get('filter', None) and \ - self.plugin_conf.keys().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 PluginConfException('plugin misconfiguration') + if not control_config(self.plugin_conf): + raise PluginException('plugin misconfiguration') def _setup_tagsneeded(self): - self.log.debug('%s plugin needs the followinng metadata: %s', - self, set(self.plugin_conf.keys()) & Tags.supported_tags) - tags = set(self.plugin_conf.keys()) & Tags.supported_tags + """Ensure needed tags are exposed by MPD""" + # At this point mpd_filter concatenetes {tags}+filter + config_tags = set() + for mpd_supp_tags in self.player.MPD_supported_tags: + if mpd_supp_tags.lower() in self.mpd_filter.lower(): + config_tags.add(mpd_supp_tags.lower()) + self.log.debug('%s plugin needs the following metadata: %s', + self, config_tags) + tags = config_tags & Tags.supported_tags self.player.needed_tags |= tags - def _get_history(self): - """Constructs list of already played artists. - """ - duration = self.daemon.config.getint('sima', 'history_duration') - tracks_from_db = self.daemon.sdb.get_history(duration=duration) - hist = [Track(file=tr[3], artist=tr[0]) for tr in tracks_from_db] - return hist - def start(self): if (0, 21, 0) > tuple(map(int, self.player.mpd_version.split('.'))): self.log.warning('MPD protocol version: %s < 0.21.0', - self.player.mpd_version) - self.log.error('Need at least MPD 0.21 to use Tags plugin (filters required)') + self.player.mpd_version) + self.log.error( + 'Need at least MPD 0.21 to use Tags plugin (filters required)') self.player.disconnect() raise PluginException('MPD >= 0.21 required') + if not self.plugin_conf['filter']: + return + # Check filter is valid + try: + # Use window to limit response size + self.player.find(self.mpd_filter, "window", (0, 1)) + except CommandError as err: + self.log.warning(err) + raise PluginException('Badly formated filter in tags plugin configuration: "%s"' + % self.plugin_conf['filter']) from err def callback_need_track(self): candidates = [] - target = self.plugin_conf.getint('track_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) + 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 = [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 plugin found: %s', ' / '.join(map(str, artists))) + for artist in artists: + self.log.debug('looking for %s', artist) + tracks = self.player.find_tracks(artist) + if not tracks: continue - if trk in history: - self.log.debug('%s in history', trk) + trk = self.filter_track(tracks, candidates) + if not trk: continue - candidates.append(trk) - self.log.info('Tags candidate: {}'.format(trk)) - if len(candidates) >= target: - break - if not candidates: - self.log.info('Tags plugin failed to find some tracks') + if queue_mode == 'track': + self.log.info('Tags plugin chose: %s', trk) + candidates.append(trk) + if len(candidates) == target: + break + else: + album = self.album_candidate(trk.Artist, unplayed=True) + if not album: + continue + candidates.extend(self.player.find_tracks(album)) + if len({t.album for t in candidates}) == target: + break return candidates # VIM MODLINE