X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Fmpdclient.py;h=0883b009e8f45826226f66694f9c7b3ba754a634;hb=c048e4a8c0100e77ad3edc1159fd63e938267ca0;hp=97be9dabf0c3dddbb1e4e9bf8b743896b37c6cb1;hpb=54849baefbe39c4c0a09bd8ad27bde7743dac5ef;p=mpd-sima.git diff --git a/sima/mpdclient.py b/sima/mpdclient.py index 97be9da..0883b00 100644 --- a/sima/mpdclient.py +++ b/sima/mpdclient.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2009-2020 kaliko +# Copyright (c) 2009-2021 kaliko # # This file is part of sima # @@ -19,7 +19,7 @@ # standard library import 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 +33,7 @@ from .utils.leven import levenshtein_ratio class PlayerError(Exception): - """Fatal error in poller.""" + """Fatal error in the player.""" # Some decorators @@ -42,63 +42,34 @@ def bl_artist(func): cls = args[0] if not cls.database: return func(*args, **kwargs) - result = func(*args, **kwargs) - if not result: - return - names = list() - for art in result.names: - if cls.database.get_bl_artist(art, add_not=True): - cls.log.debug('Blacklisted "%s"', art) - continue - names.append(art) - if not names: - return - resp = Artist(name=names.pop(), mbid=result.mbid) - for name in names: - resp.add_alias(name) - return resp + results = func(*args, **kwargs) + if not results: + return None + for art in results.names: + mbid = results.mbid + if not mbid: + mbid = cls._find_musicbrainz_artistid(results) + artist = Artist(name=art, mbid=mbid) + if cls.database.get_bl_artist(artist, add=False): + cls.log.debug('Artist in blocklist: %s', artist) + return None + return results 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 - field = (album, track) - def decorated(func): - def wrapper(*args, **kwargs): - if not args[0].database: - return func(*args, **kwargs) - cls = args[0] - boolgen = (bl for bl in field) - bl_fun = (cls.database.get_bl_album, - cls.database.get_bl_track,) - #bl_getter = next(fn for fn, bl in zip(bl_fun, boolgen) if bl is True) - bl_getter = next(dropwhile(lambda _: not next(boolgen), bl_fun)) - #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): - #cls.log.debug('Blacklisted "{0}"'.format(elem)) - continue - 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. "%s"', elem) - continue - results.append(elem) - return results - return wrapper - return decorated - class MPD(MPDClient): """ @@ -110,33 +81,35 @@ 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', + 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 ########### 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) @@ -148,10 +121,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) @@ -170,7 +144,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: @@ -179,11 +153,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 ' @@ -204,15 +186,20 @@ 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()} + 'nombid_artists': frozenset(), + 'artist_tracks': {}} self._cache['artists'] = frozenset(filter(None, self.list('artist'))) - if Artist.use_mbid: + if self.use_mbid: artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')") self._cache['nombid_artists'] = frozenset(filter(None, artists)) @@ -224,8 +211,7 @@ class MPD(MPDClient): return self.current.id != previous.id # pylint: disable=no-member def monitor(self): - """OLD socket Idler - Monitor player for change + """Monitor player for change Returns a list a events among: * database player media library has changed @@ -254,13 +240,15 @@ class MPD(MPDClient): self.log.warning('pending commands: %s', self._pending) def add(self, payload): - """Overriding MPD's add method to accept Track objects""" + """Overriding MPD's add method to accept Track objects + + :param Track,list payload: Either a single :py:obj:`Track` or a list of it + """ if isinstance(payload, Track): super().__getattr__('add')(payload.file) elif isinstance(payload, list): self.command_list_ok_begin() - for tr in payload: - self.add(tr) + map(self.add, payload) self.command_list_end() else: self.log.error('Cannot add %s', payload) @@ -303,7 +291,7 @@ class MPD(MPDClient): def find_tracks(self, what): """Find tracks for a specific artist or album >>> player.find_tracks(Artist('Nirvana')) - >>> player.find_tracks(Album('In Utero', artist=(Artist('Nirvana')) + >>> player.find_tracks(Album('In Utero', artist=Artist('Nirvana')) :param Artist,Album what: Artist or Album to fetch track from @@ -311,43 +299,84 @@ 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() + # artist blocklist + if self.database.get_bl_artist(artist, add=False): + self.log.info('Artist in blocklist: %s', artist) + return [] 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)) + # album blocklist + albums = {Album(trk.album, mbid=trk.musicbrainz_albumid) + for trk in tracks} + bl_albums = {Album(a.get('album'), mbid=a.get('musicbrainz_album')) + for a in self.database.view_bl() if a.get('album')} + if albums & bl_albums: + self.log.info('Albums in blocklist for %s: %s', artist, albums & bl_albums) + tracks = {trk for trk in tracks if trk.Album not in bl_albums} + # track blocklist + bl_tracks = {Track(title=t.get('title'), file=t.get('file')) + for t in self.database.view_bl() if t.get('title')} + if tracks & bl_tracks: + self.log.info('Tracks in blocklist for %s: %s', + artist, tracks & bl_tracks) + tracks = {trk for trk in tracks if trk not in bl_tracks} return list(tracks) def _find_alb(self, album): if not hasattr(album, 'artist'): raise PlayerError('Album object have no artist attribute') + if self.database.get_bl_album(album, add=False): + self.log.info('Album in blocklist: %s', album) + return [] albums = [] - if self.use_mbid and album.mbid: - filt = f'(MUSICBRAINZ_ALBUMID == {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 - filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album.name_sz}'))" + 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 - filt = f"((albumartist == '{album.artist!s}') AND (album == '{album.name_sz}'))" - albums = self.find(filt) + 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 ##### + def _find_musicbrainz_artistid(self, artist): + if not self.use_mbid: + return None + mbids = self.list('MUSICBRAINZ_ARTISTID', + f'(artist == "{artist.name_sz}")') + if not mbids: + return None + if len(mbids) > 1: + self.log.debug("Got multiple MBID for artist: %r", artist) + return None + if artist.mbid: + if artist.mbid != mbids[0]: + self.log('MBID discrepancy, %s found with %s (instead of %s)', + artist.name, mbids[0], artist.mbid) + else: + return mbids[0] + @bl_artist def search_artist(self, artist): """ Search artists based on a fuzzy search in the media library >>> art = Artist(name='the beatles', mbid=) # mbid optional - >>> bea = player.search_artist(art)c + >>> bea = player.search_artist(art) >>> print(bea.names) >>> ['The Beatles', 'Beatles', 'the beatles'] @@ -356,11 +385,25 @@ 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 - found = bool(self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")) - if found: + library = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')") + if library: + found = True self.log.trace('Found mbid "%r" in library', artist) + # library could fetch several artist name for a single MUSICBRAINZ_ARTISTID + if len(library) > 1: + self.log.debug('I got "%s" searching for %r', library, artist) + for name in library: + if SimaStr(artist.name) == name and name != artist.name: + self.log.debug('add alias for %s: %s', artist, name) + artist.add_alias(name) + 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 @@ -369,8 +412,9 @@ class MPD(MPDClient): 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 + self.log.debug('found close match for "%s": %s', + artist, '/'.join(match)) + # First lowercased comparison for close_art in match: # Regular lowered string comparison if artist.name.lower() == close_art.lower(): @@ -384,6 +428,7 @@ class MPD(MPDClient): self.log.trace('no fuzzy matching for %r', artist) if found: return artist + return None # Now perform fuzzy search for fuzz in match: if fuzz in artist.names: # Already found in lower cased comparison @@ -392,40 +437,43 @@ 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) def search_track(self, artist, title): """Fuzzy search of title by an artist """ + cache = self._cache.get('artist_tracks').get(artist) # Retrieve all tracks from artist - all_tracks = self.find_tracks(artist) + all_tracks = cache or self.find_tracks(artist) + if not cache: + self._cache['artist_tracks'] = {} # clean up + self._cache.get('artist_tracks')[artist] = all_tracks # Get all titles (filter missing titles set to 'None') all_artist_titles = frozenset([tr.title for tr in all_tracks if tr.title is not None]) match = get_close_matches(title, all_artist_titles, 50, 0.78) + tracks = [] if not match: return [] for mtitle in match: - leven = levenshtein_ratio(title.lower(), mtitle.lower()) + leven = levenshtein_ratio(title, mtitle) if leven == 1: - pass - elif leven >= 0.79: # PARAM + tracks.extend([t for t in all_tracks if t.title == mtitle]) + elif leven >= 0.77: self.log.debug('title: "%s" should match "%s" (lr=%1.3f)', mtitle, title, leven) + tracks.extend([t for t in all_tracks if t.title == mtitle]) else: self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)', mtitle, title, leven) - return [] - return self.find('artist', artist, 'title', mtitle) + return tracks - @blacklist(album=True) def search_albums(self, artist): """Find potential albums for "artist" @@ -433,42 +481,76 @@ class MPD(MPDClient): → 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. + looking for albums for Artist_B wrongly returns 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) + albums = set() + if self.use_mbid and artist.mbid: + mpd_filter = f"((musicbrainz_albumartistid == '{artist.mbid}') AND ( album != ''))" + raw_album_id = self.list('musicbrainz_albumid', mpd_filter) + for albumid in raw_album_id: + mpd_filter = f"((musicbrainz_albumid == '{albumid}') AND ( album != ''))" + album_name = self.list('album', mpd_filter) + if not album_name: # something odd here + continue + albums.add(Album(album_name[0], artist=artist.name, + Artist=artist, mbid=albumid)) 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) + for alb in raw_albums: + if alb in [a.name for a in albums]: + continue + mbid = None + if self.use_mbid: + _ = Album(alb) + mpd_filter = f"((albumartist == '{artist.name_sz}') AND ( album == '{_.name_sz}'))" + mbids = self.list('MUSICBRAINZ_ALBUMID', mpd_filter) + if mbids: + mbid = mbids[0] + albums.add(Album(alb, artist=artist.name, + Artist=artist, mbid=mbid)) 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: + if album.Artist.names & album_artists: candidates.append(album) continue + if self.use_mbid and artist.mbid: + if artist.mbid == album_trks[0].musicbrainz_albumartistid: + candidates.append(album) + continue + else: + self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid', album, album.Artist) + 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) + 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 + # Attempt to detect false positive (especially when no + # AlbumArtist/MBIDs tag ar set) # 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) + 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 + for alb in albums: + if self.database.get_bl_album(album, add=False): + candidates.remove(album) return candidates # #### / Search Methods ###