sima/mpdclient.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
   3 #
   4 #  This file is part of sima
   5 #
   6 #  sima is free software: you can redistribute it and/or modify
   7 #  it under the terms of the GNU General Public License as published by
   8 #  the Free Software Foundation, either version 3 of the License, or
   9 #  (at your option) any later version.
  10 #
  11 #  sima is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #  GNU General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU General Public License
  17 #  along with sima.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 # standard library import
  20 from difflib import get_close_matches
  21 from functools import wraps
  22 from logging import getLogger
  23
  24 # external module
  25 from musicpd import MPDClient, MPDError
  26
  27
  28 # local import
  29 from .lib.meta import Meta, Artist, Album
  30 from .lib.track import Track
  31 from .lib.simastr import SimaStr
  32 from .utils.leven import levenshtein_ratio
  33
  34
  35 class PlayerError(MPDError):
  36     """Fatal error in the player."""
  37
  38
  39 # Some decorators
  40 def bl_artist(func):
  41     def wrapper(*args, **kwargs):
  42         cls = args[0]
  43         if not cls.database:
  44             return func(*args, **kwargs)
  45         result = func(*args, **kwargs)
  46         if not result:
  47             return None
  48         for art in result.names:
  49             artist = Artist(name=art, mbid=result.mbid)
  50             if cls.database.get_bl_artist(artist, add=False):
  51                 cls.log.debug('Artist in blocklist: %s', artist)
  52                 return None
  53         return result
  54     return wrapper
  55
  56 def set_artist_mbid(func):
  57     def wrapper(*args, **kwargs):
  58         cls = args[0]
  59         result = func(*args, **kwargs)
  60         if Meta.use_mbid:
  61             if result and not result.mbid:
  62                 result.mbid = cls._find_musicbrainz_artistid(result)
  63         return result
  64     return wrapper
  65
  66 def tracks_wrapper(func):
  67     """Convert plain track mapping as returned by MPDClient into :py:obj:Track
  68     objects. This decorator accepts single track or list of tracks as input.
  69     """
  70     @wraps(func)
  71     def wrapper(*args, **kwargs):
  72         ret = func(*args, **kwargs)
  73         if isinstance(ret, dict):
  74             return Track(**ret)
  75         return [Track(**t) for t in ret]
  76     return wrapper
  77 # / decorators
  78
  79
  80 class MPD(MPDClient):
  81     """
  82     Player instance inheriting from MPDClient (python-musicpd).
  83
  84     Some methods are overridden to format objects as sima.lib.Track for
  85     instance, other are calling parent class directly through super().
  86     cf. MPD.__getattr__
  87
  88     .. note::
  89
  90         * find methods are looking for exact match of the object provided
  91           attributes in MPD music library
  92         * search methods are looking for exact match + fuzzy match.
  93     """
  94     needed_cmds = ['status', 'stats', 'add', 'find',
  95                    'search', 'currentsong', 'ping']
  96     needed_tags = {'Artist', 'Album', 'AlbumArtist', 'Title', 'Track'}
  97     needed_mbid_tags = {'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
  98                         'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
  99     MPD_supported_tags = {'Artist', 'ArtistSort', 'Album', 'AlbumSort', 'AlbumArtist',
 100                           'AlbumArtistSort', 'Title', 'Track', 'Name', 'Genre',
 101                           'Date', 'OriginalDate', 'Composer', 'Performer',
 102                           'Conductor', 'Work', 'Grouping', 'Disc', 'Label',
 103                           'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
 104                           'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID',
 105                           'MUSICBRAINZ_RELEASETRACKID', 'MUSICBRAINZ_WORKID'}
 106     database = None
 107
 108     def __init__(self, config):
 109         super().__init__()
 110         self.use_mbid = True
 111         self.log = getLogger('sima')
 112         self.config = config
 113         self._cache = None
 114
 115     # ######### Overriding MPDClient ###########
 116     def __getattr__(self, cmd):
 117         """Wrapper around MPDClient calls for abstract overriding"""
 118         track_wrapped = {'currentsong', 'find', 'playlistinfo', }
 119         if cmd in track_wrapped:
 120             return tracks_wrapper(super().__getattr__(cmd))
 121         return super().__getattr__(cmd)
 122
 123     def disconnect(self):
 124         """Overriding explicitly MPDClient.disconnect()"""
 125         if self._sock:
 126             super().disconnect()
 127
 128     def connect(self):
 129         """Overriding explicitly MPDClient.connect()"""
 130         mpd_config = self.config['MPD']
 131         # host, port, password
 132         host = mpd_config.get('host')
 133         port = mpd_config.get('port')
 134         password = mpd_config.get('password', fallback=None)
 135         self.disconnect()
 136         try:
 137             super().connect(host, port)
 138         # Catch socket errors
 139         except IOError as err:
 140             raise PlayerError('Could not connect to "%s:%s": %s' %
 141                               (host, port, err.strerror))
 142         # Catch all other possible errors
 143         # ConnectionError and ProtocolError are always fatal.  Others may not
 144         # be, but we don't know how to handle them here, so treat them as if
 145         # they are instead of ignoring them.
 146         except MPDError as err:
 147             raise PlayerError('Could not connect to "%s:%s": %s' %
 148                               (host, port, err))
 149         if password:
 150             try:
 151                 self.password(password)
 152             except (MPDError, IOError) as err:
 153                 raise PlayerError("Could not connect to '%s': %s" % (host, err))
 154         # Controls we have sufficient rights
 155         available_cmd = self.commands()
 156         for cmd in MPD.needed_cmds:
 157             if cmd not in available_cmd:
 158                 self.disconnect()
 159                 raise PlayerError('Could connect to "%s", '
 160                                   'but command "%s" not available' %
 161                                   (host, cmd))
 162         self.tagtypes('clear')
 163         for tag in MPD.needed_tags:
 164             self.tagtypes('enable', tag)
 165         tt = set(map(str.lower, self.tagtypes()))
 166         needed_tags = set(map(str.lower, MPD.needed_tags))
 167         if len(needed_tags & tt) != len(MPD.needed_tags):
 168             self.log.warning('MPD exposes: %s', tt)
 169             self.log.warning('Tags needed: %s', needed_tags)
 170             raise PlayerError('Missing mandatory metadata!')
 171         for tag in MPD.needed_mbid_tags:
 172             self.tagtypes('enable', tag)
 173         # Controls use of MusicBrainzIdentifier
 174         if self.config.getboolean('sima', 'musicbrainzid'):
 175             tt = set(self.tagtypes())
 176             if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
 177                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
 178                                  'is not providing related metadata')
 179                 self.log.info(tt)
 180                 self.log.warning('Disabling MusicBrainzIdentifier')
 181                 self.use_mbid = Meta.use_mbid = False
 182             else:
 183                 self.log.debug('Available metadata: %s', tt)
 184                 self.use_mbid = Meta.use_mbid = True
 185         else:
 186             self.log.warning('Use of MusicBrainzIdentifier disabled!')
 187             self.log.info('Consider using MusicBrainzIdentifier for your music library')
 188             self.use_mbid = Meta.use_mbid = False
 189         self._reset_cache()
 190     # ######### / Overriding MPDClient #########
 191
 192     def _reset_cache(self):
 193         """
 194         Both flushes and instantiates _cache
 195
 196         * artists: all artists
 197         * nombid_artists: artists with no mbid (set only when self.use_mbid is True)
 198         * artist_tracks: caching last artist tracks, used in search_track
 199         """
 200         if isinstance(self._cache, dict):
 201             self.log.info('Player: Flushing cache!')
 202         else:
 203             self.log.info('Player: Initialising cache!')
 204         self._cache = {'artists': frozenset(),
 205                        'nombid_artists': frozenset(),
 206                        'artist_tracks': {}}
 207         self._cache['artists'] = frozenset(filter(None, self.list('artist')))
 208         if self.use_mbid:
 209             artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
 210             self._cache['nombid_artists'] = frozenset(filter(None, artists))
 211
 212     def _skipped_track(self, previous):
 213         if (self.state == 'stop'
 214                 or not hasattr(previous, 'id')
 215                 or not hasattr(self.current, 'id')):
 216             return False
 217         return self.current.id != previous.id  # pylint: disable=no-member
 218
 219     def monitor(self):
 220         """Monitor player for change
 221         Returns a list a events among:
 222
 223             * database  player media library has changed
 224             * playlist  playlist modified
 225             * options   player options changed: repeat mode, etc…
 226             * player    player state changed: paused, stopped, skip track…
 227             * skipped   current track skipped
 228         """
 229         curr = self.current
 230         try:
 231             ret = self.idle('database', 'playlist', 'player', 'options')
 232         except (MPDError, IOError) as err:
 233             raise PlayerError("Couldn't init idle: %s" % err)
 234         if self._skipped_track(curr):
 235             ret.append('skipped')
 236         if 'database' in ret:
 237             self._reset_cache()
 238         return ret
 239
 240     def clean(self):
 241         """Clean blocking event (idle) and pending commands
 242         """
 243         if 'idle' in self._pending:
 244             self.noidle()
 245         elif self._pending:
 246             self.log.warning('pending commands: %s', self._pending)
 247
 248     def add(self, payload):
 249         """Overriding MPD's add method to accept Track objects
 250
 251         :param Track,list payload: Either a single :py:obj:`Track` or a list of it
 252         """
 253         if isinstance(payload, Track):
 254             super().__getattr__('add')(payload.file)
 255         elif isinstance(payload, list):
 256             self.command_list_ok_begin()
 257             map(self.add, payload)
 258             self.command_list_end()
 259         else:
 260             self.log.error('Cannot add %s', payload)
 261
 262     # ######### Properties #####################
 263     @property
 264     def current(self):
 265         return self.currentsong()
 266
 267     @property
 268     def playlist(self):
 269         """
 270         Override deprecated MPD playlist command
 271         """
 272         return self.playlistinfo()
 273
 274     @property
 275     def playmode(self):
 276         plm = {'repeat': None, 'single': None,
 277                'random': None, 'consume': None, }
 278         for key, val in self.status().items():
 279             if key in plm.keys():
 280                 plm.update({key: bool(int(val))})
 281         return plm
 282
 283     @property
 284     def queue(self):
 285         plst = self.playlist
 286         curr_position = int(self.current.pos)
 287         plst.reverse()
 288         return [trk for trk in plst if int(trk.pos) > curr_position]
 289
 290     @property
 291     def state(self):
 292         """Returns (play|stop|pause)"""
 293         return str(self.status().get('state'))
 294     # ######### / Properties ###################
 295
 296 # #### find_tracks ####
 297     def find_tracks(self, what):
 298         """Find tracks for a specific artist or album
 299             >>> player.find_tracks(Artist('Nirvana'))
 300             >>> player.find_tracks(Album('In Utero', artist=Artist('Nirvana'))
 301
 302         :param Artist,Album what: Artist or Album to fetch track from
 303
 304         Returns a list of :py:obj:Track objects
 305         """
 306         if isinstance(what, Artist):
 307             return self._find_art(what)
 308         if isinstance(what, Album):
 309             return self._find_alb(what)
 310         if isinstance(what, str):
 311             return self.find_tracks(Artist(name=what))
 312         raise PlayerError('Bad input argument')
 313
 314     def _find_art(self, artist):
 315         tracks = set()
 316         # artist blocklist
 317         if self.database.get_bl_artist(artist, add=False):
 318             self.log.info('Artist in blocklist: %s', artist)
 319             return []
 320         if artist.mbid:
 321             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
 322         for name in artist.names:
 323             tracks |= set(self.find('artist', name))
 324         # album blocklist
 325         albums = {Album(trk.Album.name, mbid=trk.musicbrainz_albumid)
 326                   for trk in tracks}
 327         bl_albums = {Album(a.get('album'), mbid=a.get('musicbrainz_album'))
 328                      for a in self.database.view_bl() if a.get('album')}
 329         if albums & bl_albums:
 330             self.log.info('Albums in blocklist for %s: %s', artist, albums & bl_albums)
 331             tracks = {trk for trk in tracks if trk.Album not in bl_albums}
 332         # track blocklist
 333         bl_tracks = {Track(title=t.get('title'), file=t.get('file'))
 334                      for t in self.database.view_bl() if t.get('title')}
 335         if tracks & bl_tracks:
 336             self.log.info('Tracks in blocklist for %s: %s',
 337                           artist, tracks & bl_tracks)
 338             tracks = {trk for trk in tracks if trk not in bl_tracks}
 339         return list(tracks)
 340
 341     def _find_alb(self, album):
 342         if not hasattr(album, 'artist'):
 343             raise PlayerError('Album object have no artist attribute')
 344         if self.database.get_bl_album(album, add=False):
 345             self.log.info('Album in blocklist: %s', album)
 346             return []
 347         albums = []
 348         if album.mbid:
 349             filt = f"(MUSICBRAINZ_ALBUMID == '{album.mbid}')"
 350             albums = self.find(filt)
 351         # Now look for album with no MusicBrainzIdentifier
 352         if not albums and album.Artist.mbid:  # Use album artist MBID if possible
 353             filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.Artist.mbid}') AND (album == '{album.name_sz}'))"
 354             albums = self.find(filt)
 355         if not albums:  # Falls back to (album)?artist/album name
 356             for artist in album.Artist.names_sz:
 357                 filt = f"((albumartist == '{artist}') AND (album == '{album.name_sz}'))"
 358                 albums.extend(self.find(filt))
 359         return albums
 360 # #### / find_tracks ##
 361
 362 # #### Search Methods #####
 363     def _find_musicbrainz_artistid(self, artist):
 364         """Find MusicBrainzArtistID when possible.
 365         For artist with aliases having a mbid but not the main name, no mbid is
 366         fetched…
 367         Searching for Artist('Russian Circls') do not reslove the MBID
 368         """
 369         if not self.use_mbid:
 370             return None
 371         mbids = self.list('MUSICBRAINZ_ARTISTID',
 372                           f'(artist == "{artist.name_sz}")')
 373         if not mbids:
 374             return None
 375         if len(mbids) > 1:
 376             self.log.debug("Got multiple MBID for artist: %r", artist)
 377             return None
 378         if artist.mbid:
 379             if artist.mbid != mbids[0]:
 380                 self.log('MBID discrepancy, %s found with %s (instead of %s)',
 381                          artist.name, mbids[0], artist.mbid)
 382         else:
 383             return mbids[0]
 384
 385     @bl_artist
 386     @set_artist_mbid
 387     def search_artist(self, artist):
 388         """
 389         Search artists based on a fuzzy search in the media library
 390             >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
 391             >>> bea = player.search_artist(art)
 392             >>> print(bea.names)
 393             >>> ['The Beatles', 'Beatles', 'the beatles']
 394
 395         :param Artist artist: Artist to look for in MPD music library
 396
 397         Returns an Artist object
 398         """
 399         found = False
 400         if artist.mbid:
 401             # look for exact search w/ musicbrainz_artistid
 402             library = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")
 403             if library:
 404                 found = True
 405                 self.log.trace('Found mbid "%r" in library', artist)
 406                 # library could fetch several artist name for a single MUSICBRAINZ_ARTISTID
 407                 if len(library) > 1:
 408                     self.log.debug('I got "%s" searching for %r', library, artist)
 409                     for name in library:
 410                         if SimaStr(artist.name) == name and name != artist.name:
 411                             self.log.debug('add alias for %s: %s', artist, name)
 412                             artist.add_alias(name)
 413                 elif len(library) == 1 and library[0] != artist.name:
 414                     new_alias = artist.name
 415                     self.log.info('Update artist name %s->%s', artist, library[0])
 416                     self.log.debug('Also add alias for %s: %s', artist, new_alias)
 417                     artist = Artist(name=library[0], mbid=artist.mbid)
 418                     artist.add_alias(new_alias)
 419             # Fetches remaining artists for potential match
 420             artists = self._cache['nombid_artists']
 421         else:  # not using MusicBrainzIDs
 422             artists = self._cache['artists']
 423         match = get_close_matches(artist.name, artists, 50, 0.73)
 424         if not match and not found:
 425             return None
 426         if len(match) > 1:
 427             self.log.debug('found close match for "%s": %s',
 428                            artist, '/'.join(match))
 429         # First lowercased comparison
 430         for close_art in match:
 431             # Regular lowered string comparison
 432             if artist.name.lower() == close_art.lower():
 433                 artist.add_alias(close_art)
 434                 found = True
 435                 if artist.name != close_art:
 436                     self.log.debug('"%s" matches "%s".', close_art, artist)
 437         # Does not perform fuzzy matching on short and single word strings
 438         # Only lowercased comparison
 439         if ' ' not in artist.name and len(artist.name) < 8:
 440             self.log.trace('no fuzzy matching for %r', artist)
 441             if found:
 442                 return artist
 443             return None
 444         # Now perform fuzzy search
 445         for fuzz in match:
 446             if fuzz in artist.names:  # Already found in lower cased comparison
 447                 continue
 448             # SimaStr string __eq__ (not regular string comparison here)
 449             if SimaStr(artist.name) == fuzz:
 450                 found = True
 451                 artist.add_alias(fuzz)
 452                 self.log.debug('"%s" quite probably matches "%s" (SimaStr)',
 453                                fuzz, artist)
 454         if found:
 455             if artist.aliases:
 456                 self.log.info('Found aliases: %s', '/'.join(artist.names))
 457             return artist
 458         return None
 459
 460     def search_track(self, artist, title):
 461         """Fuzzy search of title by an artist
 462         """
 463         cache = self._cache.get('artist_tracks').get(artist)
 464         # Retrieve all tracks from artist
 465         all_tracks = cache or self.find_tracks(artist)
 466         if not cache:
 467             self._cache['artist_tracks'] = {}  # clean up
 468             self._cache.get('artist_tracks')[artist] = all_tracks
 469         # Get all titles (filter missing titles set to 'None')
 470         all_artist_titles = frozenset([tr.title for tr in all_tracks
 471                                        if tr.title is not None])
 472         match = get_close_matches(title, all_artist_titles, 50, 0.78)
 473         tracks = []
 474         if not match:
 475             return []
 476         for mtitle in match:
 477             leven = levenshtein_ratio(title, mtitle)
 478             if leven == 1:
 479                 tracks.extend([t for t in all_tracks if t.title == mtitle])
 480             elif leven >= 0.77:
 481                 self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
 482                                mtitle, title, leven)
 483                 tracks.extend([t for t in all_tracks if t.title == mtitle])
 484             else:
 485                 self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
 486                                mtitle, title, leven)
 487         return tracks
 488
 489     def search_albums(self, artist):
 490         """Find potential albums for "artist"
 491
 492         * Fetch all albums for "AlbumArtist" == artist
 493           → falls back to "Artist" == artist when no "AlbumArtist" tag is set
 494         * Tries to filter some mutli-artists album
 495           For instance an album by Artist_A may have a track by Artist_B. Then
 496           looking for albums for Artist_B wrongly returns this album.
 497         """
 498         # First, look for all potential albums
 499         self.log.debug('Searching album for "%r"', artist)
 500         if artist.aliases:
 501             self.log.debug('Searching album for %s aliases: "%s"',
 502                            artist, artist.aliases)
 503         albums = set()
 504         if self.use_mbid and artist.mbid:
 505             mpd_filter = f"((musicbrainz_albumartistid == '{artist.mbid}') AND ( album != ''))"
 506             raw_album_id = self.list('musicbrainz_albumid', mpd_filter)
 507             for albumid in raw_album_id:
 508                 mpd_filter = f"((musicbrainz_albumid == '{albumid}') AND ( album != ''))"
 509                 album_name = self.list('album', mpd_filter)
 510                 if not album_name:  # something odd here
 511                     continue
 512                 albums.add(Album(album_name[0], artist=artist.name,
 513                                  Artist=artist, mbid=albumid))
 514         for name_sz in artist.names_sz:
 515             mpd_filter = f"((albumartist == '{name_sz}') AND ( album != ''))"
 516             raw_albums = self.list('album', mpd_filter)
 517             for alb in raw_albums:
 518                 if alb in [a.name for a in albums]:
 519                     continue
 520                 mbid = None
 521                 if self.use_mbid:
 522                     _ = Album(alb)
 523                     mpd_filter = f"((albumartist == '{artist.name_sz}') AND ( album == '{_.name_sz}'))"
 524                     mbids = self.list('MUSICBRAINZ_ALBUMID', mpd_filter)
 525                     if mbids:
 526                         mbid = mbids[0]
 527                 albums.add(Album(alb, artist=artist.name,
 528                                  Artist=artist, mbid=mbid))
 529         candidates = []
 530         for album in albums:
 531             album_trks = self.find_tracks(album)
 532             if not album_trks:  # find_track result can be empty, blocklist applied
 533                 continue
 534             album_artists = {tr.albumartist for tr in album_trks if tr.albumartist}
 535             if album.Artist.names & album_artists:
 536                 candidates.append(album)
 537                 continue
 538             if self.use_mbid and artist.mbid:
 539                 if artist.mbid == album_trks[0].musicbrainz_albumartistid:
 540                     candidates.append(album)
 541                     continue
 542                 else:
 543                     self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid', album, album.Artist)
 544                     continue
 545             if 'Various Artists' in album_artists:
 546                 self.log.debug('Discarding %s ("Various Artists" set)', album)
 547                 continue
 548             if album_artists and album.Artist.name not in album_artists:
 549                 self.log.debug('Discarding "%s", "%s" not set as albumartist', album, album.Artist)
 550                 continue
 551             # Attempt to detect false positive (especially when no
 552             # AlbumArtist/MBIDs tag ar set)
 553             # Avoid selecting albums where artist is credited for a single
 554             # track of the album
 555             album_trks = self.find(f"(album == '{album.name_sz}')")
 556             arts = [trk.artist for trk in album_trks]  # Artists in the album
 557             # count artist occurences
 558             ratio = arts.count(album.Artist.name)/len(arts)
 559             if ratio >= 0.8:
 560                 candidates.append(album)
 561             else:
 562                 self.log.debug('"%s" probably not an album of "%s" (ratio=%.2f)',
 563                                album, artist, ratio)
 564             continue
 565         return candidates
 566 # #### / Search Methods ###
 567
 568 # VIM MODLINE
 569 # vim: ai ts=4 sw=4 sts=4 expandtab