]> kaliko git repositories - mpd-sima.git/blobdiff - sima/mpdclient.py
MPD client: Improved album search
[mpd-sima.git] / sima / mpdclient.py
index d13c8cb417e44662e37bed1aef7a3a56db3fb9a1..ed2fbcdb37ec31bf93f3b9f497ad4612096bb2fa 100644 (file)
@@ -26,7 +26,7 @@ from musicpd import MPDClient, MPDError
 
 
 # local import
-from .lib.meta import Artist, Album
+from .lib.meta import Meta, Artist, Album
 from .lib.track import Track
 from .lib.simastr import SimaStr
 from .utils.leven import levenshtein_ratio
@@ -44,7 +44,7 @@ def bl_artist(func):
             return func(*args, **kwargs)
         result = func(*args, **kwargs)
         if not result:
-            return
+            return None
         names = list()
         for art in result.names:
             if cls.database.get_bl_artist(art, add_not=True):
@@ -52,27 +52,32 @@ def bl_artist(func):
                 continue
             names.append(art)
         if not names:
-            return
+            return None
         resp = Artist(name=names.pop(), mbid=result.mbid)
         for name in names:
             resp.add_alias(name)
         return resp
     return wrapper
 
+
 def tracks_wrapper(func):
+    """Convert plain track mapping as returned by MPDClient into :py:obj:Track
+    objects. This decorator accepts single track or list of tracks as input.
+    """
     @wraps(func)
     def wrapper(*args, **kwargs):
         ret = func(*args, **kwargs)
         if isinstance(ret, dict):
             return Track(**ret)
-        elif isinstance(ret, list):
-            return [Track(**t) for t in ret]
+        return [Track(**t) for t in ret]
     return wrapper
 # / decorators
 
+
 def blacklist(artist=False, album=False, track=False):
-    #pylint: disable=C0111,W0212
+    # pylint: disable=C0111,W0212
     field = (album, track)
+
     def decorated(func):
         def wrapper(*args, **kwargs):
             if not args[0].database:
@@ -92,7 +97,7 @@ def blacklist(artist=False, album=False, track=False):
                 if track and cls.database.get_bl_album(elem, add_not=True):
                     # filter album as well in track mode
                     # (artist have already been)
-                    cls.log.debug('Blacklisted alb. "{0.album}"'.format(elem))
+                    cls.log.debug('Blacklisted alb. "%s"', elem)
                     continue
                 results.append(elem)
             return results
@@ -110,11 +115,16 @@ class MPD(MPDClient):
 
     .. note::
 
-        * find methods are looking for exact match of the object provided attributes in MPD music library
+        * find methods are looking for exact match of the object provided
+          attributes in MPD music library
         * search methods are looking for exact match + fuzzy match.
     """
     needed_cmds = ['status', 'stats', 'add', 'find',
                    'search', 'currentsong', 'ping']
+    needed_mbid_tags = {'Artist', 'Album', 'AlbumArtist',
+                        'Title', 'Track', 'Genre',
+                        'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+                        'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
     database = None
 
     def __init__(self, daemon):
@@ -128,11 +138,7 @@ class MPD(MPDClient):
     # ######### Overriding MPDClient ###########
     def __getattr__(self, cmd):
         """Wrapper around MPDClient calls for abstract overriding"""
-        track_wrapped = {
-                         'currentsong',
-                         'find',
-                         'playlistinfo',
-                         }
+        track_wrapped = {'currentsong', 'find', 'playlistinfo', }
         if cmd in track_wrapped:
             return tracks_wrapper(super().__getattr__(cmd))
         return super().__getattr__(cmd)
@@ -166,7 +172,7 @@ class MPD(MPDClient):
             try:
                 self.password(password)
             except (MPDError, IOError) as err:
-                raise PlayerError("Could not connect to '%s': %s", (host, err))
+                raise PlayerError("Could not connect to '%s': %s" % (host, err))
         # Controls we have sufficient rights
         available_cmd = self.commands()
         for cmd in MPD.needed_cmds:
@@ -176,20 +182,24 @@ class MPD(MPDClient):
                                   'but command "%s" not available' %
                                   (host, cmd))
         # Controls use of MusicBrainzIdentifier
-        # TODO: Use config instead of Artist object attibute?
-        if self.use_mbid:
-            tt = self.tagtypes()
-            if 'MUSICBRAINZ_ARTISTID' not in tt:
-                self.log.warning('Use of MusicBrainzIdentifier is set but MPD is '
-                                 'not providing related metadata')
+        self.tagtypes('clear')
+        for tag in MPD.needed_mbid_tags:
+            self.tagtypes('enable', tag)
+        if self.daemon.config.get('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 '
+                                 'is not providing related metadata')
                 self.log.info(tt)
                 self.log.warning('Disabling MusicBrainzIdentifier')
-                self.use_mbid = False
+                self.use_mbid = Meta.use_mbid = False
             else:
-                self.log.debug('Available metadata: %s', tt)  # pylint: disable=no-member
+                self.log.debug('Available metadata: %s', tt)
+                self.use_mbid = Meta.use_mbid = True
         else:
             self.log.warning('Use of MusicBrainzIdentifier disabled!')
             self.log.info('Consider using MusicBrainzIdentifier for your music library')
+            self.use_mbid = Meta.use_mbid = False
         self._reset_cache()
     # ######### / Overriding MPDClient #########
 
@@ -205,7 +215,8 @@ class MPD(MPDClient):
                        'nombid_artists': frozenset()}
         self._cache['artists'] = frozenset(filter(None, self.list('artist')))
         if Artist.use_mbid:
-            self._cache['nombid_artists'] = frozenset(filter(None, self.list('artist', 'musicbrainz_artistid', '')))
+            artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
+            self._cache['nombid_artists'] = frozenset(filter(None, artists))
 
     def _skipped_track(self, previous):
         if (self.state == 'stop'
@@ -233,7 +244,7 @@ class MPD(MPDClient):
         if self._skipped_track(curr):
             ret.append('skipped')
         if 'database' in ret:
-            self._flush_cache()
+            self._reset_cache()
         return ret
 
     def clean(self):
@@ -249,8 +260,9 @@ class MPD(MPDClient):
         if isinstance(payload, Track):
             super().__getattr__('add')(payload.file)
         elif isinstance(payload, list):
-            for tr in payload:  # TODO: use send command here
-                self.add(tr)
+            self.command_list_ok_begin()
+            map(self.add, payload)
+            self.command_list_end()
         else:
             self.log.error('Cannot add %s', payload)
 
@@ -289,14 +301,6 @@ class MPD(MPDClient):
     # ######### / Properties ###################
 
 # #### find_tracks ####
-    def find_album(self, artist, album_name):
-        self.log.warning('update call to find_album→find_tracks(<Album object>)')
-        return self.find_tracks(Album(name=album_name, artist=artist))
-
-    def find_track(self, *args, **kwargs):
-        self.log.warning('update call to find_track→find_tracks')
-        return self.find_tracks(*args, **kwargs)
-
     def find_tracks(self, what):
         """Find tracks for a specific artist or album
             >>> player.find_tracks(Artist('Nirvana'))
@@ -308,35 +312,36 @@ class MPD(MPDClient):
         """
         if isinstance(what, Artist):
             return self._find_art(what)
-        elif isinstance(what, Album):
+        if isinstance(what, Album):
             return self._find_alb(what)
-        elif isinstance(what, str):
+        if isinstance(what, str):
             return self.find_tracks(Artist(name=what))
+        raise PlayerError('Bad input argument')
 
     def _find_art(self, artist):
         tracks = set()
         if artist.mbid:
             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
-        for name in artist.names:
+        for name in artist.names_sz:
             tracks |= set(self.find('artist', name))
         return list(tracks)
 
     def _find_alb(self, album):
-        albums = set()
-        if album.mbid and self.use_mbid:
-            filt = f'(MUSICBRAINZ_ALBUMID == {album.mbid})'
-            albums |= set(self.find(filt))
+        if not hasattr(album, 'artist'):
+            raise PlayerError('Album object have no artist attribute')
+        albums = []
+        if self.use_mbid and album.mbid:
+            filt = f"(MUSICBRAINZ_ALBUMID == '{album.mbid}')"
+            albums = self.find(filt)
         # Now look for album with no MusicBrainzIdentifier
-        if album.artist.mbid and self.use_mbid:  # Use album artist MBID if possible
-            filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album!s}'))"
-            albums |= set(self.find(filt))
-        if not albums:  # Falls back to albumartist/album name
-            filt = f"((albumartist == '{album.artist!s}') AND (album == '{album!s}'))"
-            albums |= set(self.find(filt))
-        if not albums:  # Falls back to artist/album name
-            filt = f"((artist == '{album.artist!s}') AND (album == '{album!s}'))"
-            albums |= set(self.find(filt))
-        return list(albums)
+        if not albums and album.artist.mbid and self.use_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
+            for artist in album.artist.names_sz:
+                filt = f"((albumartist == '{artist}') AND (album == '{album.name_sz}'))"
+                albums.extend(self.find(filt))
+        return albums
 # #### / find_tracks ##
 
 # #### Search Methods #####
@@ -345,60 +350,58 @@ class MPD(MPDClient):
         """
         Search artists based on a fuzzy search in the media library
             >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
-            >>> bea = player.search_artist(art)c
+            >>> bea = player.search_artist(art)
             >>> print(bea.names)
             >>> ['The Beatles', 'Beatles', 'the beatles']
 
+        :param Artist artist: Artist to look for in MPD music library
+
         Returns an Artist object
-        TODO: Re-use find method here!!!
         """
         found = False
-        if artist.mbid:
+        if self.use_mbid and artist.mbid:
             # look for exact search w/ musicbrainz_artistid
-            exact_m = self.list('artist', 'musicbrainz_artistid', artist.mbid)
-            if exact_m:
-                _ = [artist.add_alias(name) for name in exact_m]
-                found = True
-        # then complete with fuzzy search on artist with no musicbrainz_artistid
-        if artist.mbid:
-            # we already performed a lookup on artists with mbid set
-            # search through remaining artists
-            artists = self._cache.get('nombid_artists')
-        else:
-            artists = self._cache.get('artists')
+            found = bool(self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')"))
+            if found:
+                self.log.trace('Found mbid "%r" in library', artist)
+            # Fetches remaining artists for potential match
+            artists = self._cache['nombid_artists']
+        else:  # not using MusicBrainzIDs
+            artists = self._cache['artists']
         match = get_close_matches(artist.name, artists, 50, 0.73)
         if not match and not found:
             return None
         if len(match) > 1:
             self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
+        # Forst lowercased comparison
+        for close_art in match:
+            # Regular lowered string comparison
+            if artist.name.lower() == close_art.lower():
+                artist.add_alias(close_art)
+                found = True
+                if artist.name != close_art:
+                    self.log.debug('"%s" matches "%s".', close_art, artist)
         # Does not perform fuzzy matching on short and single word strings
         # Only lowercased comparison
         if ' ' not in artist.name and len(artist.name) < 8:
-            for close_art in match:
-                # Regular lowered string comparison
-                if artist.name.lower() == close_art.lower():
-                    artist.add_alias(close_art)
-                    return artist
-                else:
-                    return None
-        for fuzz_art in match:
-            # Regular lowered string comparison
-            if artist.name.lower() == fuzz_art.lower():
-                found = True
-                artist.add_alias(fuzz_art)
-                if artist.name != fuzz_art:
-                    self.log.debug('"%s" matches "%s".', fuzz_art, artist)
+            self.log.trace('no fuzzy matching for %r', artist)
+            if found:
+                return artist
+        # Now perform fuzzy search
+        for fuzz in match:
+            if fuzz in artist.names:  # Already found in lower cased comparison
                 continue
             # SimaStr string __eq__ (not regular string comparison here)
-            if SimaStr(artist.name) == fuzz_art:
+            if SimaStr(artist.name) == fuzz:
                 found = True
-                artist.add_alias(fuzz_art)
+                artist.add_alias(fuzz)
                 self.log.info('"%s" quite probably matches "%s" (SimaStr)',
-                              fuzz_art, artist)
+                              fuzz, artist)
         if found:
             if artist.aliases:
-                self.log.debug('Found: %s', '/'.join(list(artist.names)[:4]))
+                self.log.debug('Found aliases: %s', '/'.join(artist.names))
             return artist
+        return None
 
     @blacklist(track=True)
     def search_track(self, artist, title):
@@ -427,38 +430,49 @@ class MPD(MPDClient):
 
     @blacklist(album=True)
     def search_albums(self, artist):
-        """
-        Fetch all albums for "AlbumArtist"  == artist
-        Then look for albums for "artist" == artist and try to filters
-        multi-artists albums
+        """Find potential albums for "artist"
 
-        NB: Running "client.list('album', 'artist', name)" MPD returns any album
-            containing at least a track with "artist" == name
-        TODO: Use MusicBrainzID here cf. #30 @gitlab
+        * Fetch all albums for "AlbumArtist" == artist
+          → falls back to "Artist" == artist when no "AlbumArtist" tag is set
+        * Tries to filter some mutli-artists album
+          For instance an album by Artist_A may have a track by Artist_B. Then
+          looking for albums for Artist_B returns wrongly this album.
         """
-        albums = []
-        for name in artist.names:
-            if artist.aliases:
-                self.log.debug('Searching album for aliase: "%s"', name)
-            kwalbart = {'albumartist': name, 'artist': name}
-            for album in self.list('album', 'albumartist', name):
-                if album and album not in albums:
-                    albums.append(Album(name=album, **kwalbart))
-            for album in self.list('album', 'artist', name):
-                album_trks = [trk for trk in self.find('album', album)]
-                if 'Various Artists' in [tr.albumartist for tr in album_trks]:
-                    self.log.debug('Discarding %s ("Various Artists" set)', album)
-                    continue
-                arts = {trk.artist for trk in album_trks}
-                # Avoid selecting album where artist is credited for a single
-                # track of the album
-                if len(set(arts)) < 2:  # TODO: better heuristic, use a ratio instead
-                    if album not in albums:
-                        albums.append(Album(name=album, **kwalbart))
-                elif album and album not in albums:
-                    self.log.debug('"{0}" probably not an album of "{1}"'.format(
-                        album, artist) + '({0})'.format('/'.join(arts)))
-        return albums
+        # First, look for all potential albums
+        self.log.debug('Searching album for "%s"', 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]
+        candidates = []
+        for album in albums:
+            album_trks = self.find_tracks(album)
+            album_artists = {tr.albumartist for tr in album_trks if tr.albumartist}
+            if album.artist.names & album_artists:
+                candidates.append(album)
+                continue
+            if 'Various Artists' in album_artists:
+                self.log.debug('Discarding %s ("Various Artists" set)', album)
+                continue
+            if album_artists and album.artist.name not in album_artists:
+                self.log.debug('Discarding "%s", "%s" not set as albumartist', album, album.artist)
+                continue
+            # Attempt to detect false positive
+            # Avoid selecting albums where artist is credited for a single
+            # track of the album
+            album_trks = self.find(f"(album == '{album.name_sz}')")
+            arts = [trk.artist for trk in album_trks]  # Artists in the album
+            # count artist occurences
+            ratio = arts.count(album.artist.name)/len(arts)
+            if ratio >= 0.8:
+                candidates.append(album)
+            else:
+                self.log.debug('"%s" probably not an album of "%s" (ratio=%.2f)',
+                               album, artist, ratio)
+            continue
+        return candidates
 # #### / Search Methods ###
 
 # VIM MODLINE