]> kaliko git repositories - mpd-sima.git/blobdiff - sima/mpdclient.py
Add blocklist commands, remove simadb_cli
[mpd-sima.git] / sima / mpdclient.py
index bf3ce5dbfb08d2f99b07c33813f17d8817c0e1e7..1ad5100e9ea7ce8a6bdb7fe961d02c5b2cd5dc31 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2009-2020 kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
@@ -20,6 +20,7 @@
 from difflib import get_close_matches
 from functools import wraps
 from itertools import dropwhile
+from logging import getLogger
 
 # external module
 from musicpd import MPDClient, MPDError
@@ -33,7 +34,7 @@ from .utils.leven import levenshtein_ratio
 
 
 class PlayerError(Exception):
-    """Fatal error in poller."""
+    """Fatal error in the player."""
 
 
 # Some decorators
@@ -47,8 +48,9 @@ def bl_artist(func):
             return None
         names = list()
         for art in result.names:
-            if cls.database.get_bl_artist(art, add_not=True):
-                cls.log.debug('Blacklisted "%s"', art)
+            artist = Artist(name=art, mbid=result.mbid)
+            if cls.database.get_bl_artist(artist, add=False):
+                cls.log.debug('Artist "%s" in blocklist!', artist)
                 continue
             names.append(art)
         if not names:
@@ -74,7 +76,7 @@ def tracks_wrapper(func):
 # / decorators
 
 
-def blacklist(artist=False, album=False, track=False):
+def blocklist(album=False, track=False):
     # pylint: disable=C0111,W0212
     field = (album, track)
 
@@ -91,13 +93,13 @@ def blacklist(artist=False, album=False, track=False):
             #cls.log.debug('using {0} as bl filter'.format(bl_getter.__name__))
             results = list()
             for elem in func(*args, **kwargs):
-                if bl_getter(elem, add_not=True):
+                if bl_getter(elem, add=False):
                     #cls.log.debug('Blacklisted "{0}"'.format(elem))
                     continue
-                if track and cls.database.get_bl_album(elem, add_not=True):
+                if track and cls.database.get_bl_album(elem, add=False):
                     # filter album as well in track mode
                     # (artist have already been)
-                    cls.log.debug('Blacklisted alb. "%s"', elem)
+                    cls.log.debug('Album "%s" in blocklist', elem)
                     continue
                 results.append(elem)
             return results
@@ -121,18 +123,23 @@ class MPD(MPDClient):
     """
     needed_cmds = ['status', 'stats', 'add', 'find',
                    'search', 'currentsong', 'ping']
-    needed_mbid_tags = {'Artist', 'Album', 'AlbumArtist',
-                        'Title', 'Track', 'Genre',
-                        'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+    needed_tags = {'Artist', 'Album', 'AlbumArtist', 'Title', 'Track'}
+    needed_mbid_tags = {'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
                         'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
+    MPD_supported_tags = {'Artist', 'ArtistSort', 'Album', 'AlbumSort', 'AlbumArtist',
+                          'AlbumArtistSort', 'Title', 'Track', 'Name', 'Genre',
+                          'Date', 'OriginalDate', 'Composer', 'Performer',
+                          'Conductor', 'Work', 'Grouping', 'Disc', 'Label',
+                          'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+                          'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID',
+                          'MUSICBRAINZ_RELEASETRACKID', 'MUSICBRAINZ_WORKID'}
     database = None
 
-    def __init__(self, daemon):
+    def __init__(self, config):
         super().__init__()
         self.use_mbid = True
-        self.daemon = daemon
-        self.log = daemon.log
-        self.config = self.daemon.config['MPD']
+        self.log = getLogger('sima')
+        self.config = config
         self._cache = None
 
     # ######### Overriding MPDClient ###########
@@ -150,10 +157,11 @@ class MPD(MPDClient):
 
     def connect(self):
         """Overriding explicitly MPDClient.connect()"""
+        mpd_config = self.config['MPD']
         # host, port, password
-        host = self.config.get('host')
-        port = self.config.get('port')
-        password = self.config.get('password', fallback=None)
+        host = mpd_config.get('host')
+        port = mpd_config.get('port')
+        password = mpd_config.get('password', fallback=None)
         self.disconnect()
         try:
             super().connect(host, port)
@@ -181,11 +189,19 @@ class MPD(MPDClient):
                 raise PlayerError('Could connect to "%s", '
                                   'but command "%s" not available' %
                                   (host, cmd))
-        # Controls use of MusicBrainzIdentifier
         self.tagtypes('clear')
+        for tag in MPD.needed_tags:
+            self.tagtypes('enable', tag)
+        tt = set(map(str.lower, self.tagtypes()))
+        needed_tags = set(map(str.lower, MPD.needed_tags))
+        if len(needed_tags & tt) != len(MPD.needed_tags):
+            self.log.warning('MPD exposes: %s', tt)
+            self.log.warning('Tags needed: %s', needed_tags)
+            raise PlayerError('Missing mandatory metadata!')
         for tag in MPD.needed_mbid_tags:
             self.tagtypes('enable', tag)
-        if self.daemon.config.get('sima', 'musicbrainzid'):
+        # Controls use of MusicBrainzIdentifier
+        if self.config.getboolean('sima', 'musicbrainzid'):
             tt = set(self.tagtypes())
             if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
@@ -206,19 +222,22 @@ class MPD(MPDClient):
     def _reset_cache(self):
         """
         Both flushes and instantiates _cache
+
+        * artists: all artists
+        * nombid_artists: artists with no mbid (set only when self.use_mbid is True)
+        * artist_tracks: caching last artist tracks, used in search_track
         """
         if isinstance(self._cache, dict):
             self.log.info('Player: Flushing cache!')
         else:
             self.log.info('Player: Initialising cache!')
         self._cache = {'artists': frozenset(),
-                       'nombid_artists': frozenset()}
-        self._cache['artist_tracks'] = {}
+                       'nombid_artists': frozenset(),
+                       'artist_tracks': {}}
+        self._cache['artists'] = frozenset(filter(None, self.list('artist')))
         if self.use_mbid:
             artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
             self._cache['nombid_artists'] = frozenset(filter(None, artists))
-        else:
-            self._cache['artists'] = frozenset(filter(None, self.list('artist')))
 
     def _skipped_track(self, previous):
         if (self.state == 'stop'
@@ -326,7 +345,7 @@ class MPD(MPDClient):
         tracks = set()
         if artist.mbid:
             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
-        for name in artist.names_sz:
+        for name in artist.names:
             tracks |= set(self.find('artist', name))
         return list(tracks)
 
@@ -334,11 +353,11 @@ class MPD(MPDClient):
         if not hasattr(album, 'artist'):
             raise PlayerError('Album object have no artist attribute')
         albums = []
-        if self.use_mbid and album.mbid:
+        if album.mbid:
             filt = f"(MUSICBRAINZ_ALBUMID == '{album.mbid}')"
             albums = self.find(filt)
         # Now look for album with no MusicBrainzIdentifier
-        if not albums and album.artist.mbid and self.use_mbid:  # Use album artist MBID if possible
+        if not albums and album.artist.mbid:  # Use album artist MBID if possible
             filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album.name_sz}'))"
             albums = self.find(filt)
         if not albums:  # Falls back to (album)?artist/album name
@@ -363,7 +382,7 @@ class MPD(MPDClient):
         Returns an Artist object
         """
         found = False
-        if self.use_mbid and artist.mbid:
+        if artist.mbid:
             # look for exact search w/ musicbrainz_artistid
             library = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")
             if library:
@@ -373,8 +392,11 @@ class MPD(MPDClient):
                 if len(library) > 1:
                     self.log.debug('I got "%s" searching for %r', library, artist)
                 elif len(library) == 1 and library[0] != artist.name:
+                    new_alias = artist.name
                     self.log.info('Update artist name %s->%s', artist, library[0])
+                    self.log.debug('Also add alias for %s: %s', artist, new_alias)
                     artist = Artist(name=library[0], mbid=artist.mbid)
+                    artist.add_alias(new_alias)
             # Fetches remaining artists for potential match
             artists = self._cache['nombid_artists']
         else:  # not using MusicBrainzIDs
@@ -408,15 +430,15 @@ class MPD(MPDClient):
             if SimaStr(artist.name) == fuzz:
                 found = True
                 artist.add_alias(fuzz)
-                self.log.info('"%s" quite probably matches "%s" (SimaStr)',
-                              fuzz, artist)
+                self.log.debug('"%s" quite probably matches "%s" (SimaStr)',
+                               fuzz, artist)
         if found:
             if artist.aliases:
-                self.log.debug('Found aliases: %s', '/'.join(artist.names))
+                self.log.info('Found aliases: %s', '/'.join(artist.names))
             return artist
         return None
 
-    @blacklist(track=True)
+    @blocklist(track=True)
     def search_track(self, artist, title):
         """Fuzzy search of title by an artist
         """
@@ -446,7 +468,7 @@ class MPD(MPDClient):
                                mtitle, title, leven)
         return tracks
 
-    @blacklist(album=True)
+    @blocklist(album=True)
     def search_albums(self, artist):
         """Find potential albums for "artist"
 
@@ -457,13 +479,14 @@ class MPD(MPDClient):
           looking for albums for Artist_B returns wrongly this album.
         """
         # First, look for all potential albums
-        self.log.debug('Searching album for "%s"', artist)
+        self.log.debug('Searching album for "%r"', artist)
         if artist.aliases:
             self.log.debug('Searching album for %s aliases: "%s"',
                            artist, artist.aliases)
         for name_sz in artist.names_sz:
-            raw_albums = self.list('album', f"( albumartist == '{name_sz}')")
-            albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums if a]
+            mpd_filter = f"((albumartist == '{name_sz}') AND ( album != ''))"
+            raw_albums = self.list('album', mpd_filter)
+            albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums]
         candidates = []
         for album in albums:
             album_trks = self.find_tracks(album)