sima/mpdclient.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2009-2020 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 itertools import dropwhile
  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(Exception):
  36     """Fatal error in poller."""
  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         names = list()
  49         for art in result.names:
  50             if cls.database.get_bl_artist(art, add_not=True):
  51                 cls.log.debug('Blacklisted "%s"', art)
  52                 continue
  53             names.append(art)
  54         if not names:
  55             return None
  56         resp = Artist(name=names.pop(), mbid=result.mbid)
  57         for name in names:
  58             resp.add_alias(name)
  59         return resp
  60     return wrapper
  61
  62
  63 def tracks_wrapper(func):
  64     """Convert plain track mapping as returned by MPDClient into :py:obj:Track
  65     objects. This decorator accepts single track or list of tracks as input.
  66     """
  67     @wraps(func)
  68     def wrapper(*args, **kwargs):
  69         ret = func(*args, **kwargs)
  70         if isinstance(ret, dict):
  71             return Track(**ret)
  72         return [Track(**t) for t in ret]
  73     return wrapper
  74 # / decorators
  75
  76
  77 def blacklist(artist=False, album=False, track=False):
  78     # pylint: disable=C0111,W0212
  79     field = (album, track)
  80
  81     def decorated(func):
  82         def wrapper(*args, **kwargs):
  83             if not args[0].database:
  84                 return func(*args, **kwargs)
  85             cls = args[0]
  86             boolgen = (bl for bl in field)
  87             bl_fun = (cls.database.get_bl_album,
  88                       cls.database.get_bl_track,)
  89             #bl_getter = next(fn for fn, bl in zip(bl_fun, boolgen) if bl is True)
  90             bl_getter = next(dropwhile(lambda _: not next(boolgen), bl_fun))
  91             #cls.log.debug('using {0} as bl filter'.format(bl_getter.__name__))
  92             results = list()
  93             for elem in func(*args, **kwargs):
  94                 if bl_getter(elem, add_not=True):
  95                     #cls.log.debug('Blacklisted "{0}"'.format(elem))
  96                     continue
  97                 if track and cls.database.get_bl_album(elem, add_not=True):
  98                     # filter album as well in track mode
  99                     # (artist have already been)
 100                     cls.log.debug('Blacklisted alb. "%s"', elem)
 101                     continue
 102                 results.append(elem)
 103             return results
 104         return wrapper
 105     return decorated
 106
 107
 108 class MPD(MPDClient):
 109     """
 110     Player instance inheriting from MPDClient (python-musicpd).
 111
 112     Some methods are overridden to format objects as sima.lib.Track for
 113     instance, other are calling parent class directly through super().
 114     cf. MPD.__getattr__
 115
 116     .. note::
 117
 118         * find methods are looking for exact match of the object provided
 119           attributes in MPD music library
 120         * search methods are looking for exact match + fuzzy match.
 121     """
 122     needed_cmds = ['status', 'stats', 'add', 'find',
 123                    'search', 'currentsong', 'ping']
 124     needed_mbid_tags = {'Artist', 'Album', 'AlbumArtist',
 125                         'Title', 'Track', 'Genre',
 126                         'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
 127                         'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
 128     database = None
 129
 130     def __init__(self, daemon):
 131         super().__init__()
 132         self.use_mbid = True
 133         self.daemon = daemon
 134         self.log = daemon.log
 135         self.config = self.daemon.config['MPD']
 136         self._cache = None
 137
 138     # ######### Overriding MPDClient ###########
 139     def __getattr__(self, cmd):
 140         """Wrapper around MPDClient calls for abstract overriding"""
 141         track_wrapped = {'currentsong', 'find', 'playlistinfo', }
 142         if cmd in track_wrapped:
 143             return tracks_wrapper(super().__getattr__(cmd))
 144         return super().__getattr__(cmd)
 145
 146     def disconnect(self):
 147         """Overriding explicitly MPDClient.disconnect()"""
 148         if self._sock:
 149             super().disconnect()
 150
 151     def connect(self):
 152         """Overriding explicitly MPDClient.connect()"""
 153         # host, port, password
 154         host = self.config.get('host')
 155         port = self.config.get('port')
 156         password = self.config.get('password', fallback=None)
 157         self.disconnect()
 158         try:
 159             super().connect(host, port)
 160         # Catch socket errors
 161         except IOError as err:
 162             raise PlayerError('Could not connect to "%s:%s": %s' %
 163                               (host, port, err.strerror))
 164         # Catch all other possible errors
 165         # ConnectionError and ProtocolError are always fatal.  Others may not
 166         # be, but we don't know how to handle them here, so treat them as if
 167         # they are instead of ignoring them.
 168         except MPDError as err:
 169             raise PlayerError('Could not connect to "%s:%s": %s' %
 170                               (host, port, err))
 171         if password:
 172             try:
 173                 self.password(password)
 174             except (MPDError, IOError) as err:
 175                 raise PlayerError("Could not connect to '%s': %s" % (host, err))
 176         # Controls we have sufficient rights
 177         available_cmd = self.commands()
 178         for cmd in MPD.needed_cmds:
 179             if cmd not in available_cmd:
 180                 self.disconnect()
 181                 raise PlayerError('Could connect to "%s", '
 182                                   'but command "%s" not available' %
 183                                   (host, cmd))
 184         # Controls use of MusicBrainzIdentifier
 185         self.tagtypes('clear')
 186         for tag in MPD.needed_mbid_tags:
 187             self.tagtypes('enable', tag)
 188         if self.daemon.config.get('sima', 'musicbrainzid'):
 189             tt = set(self.tagtypes())
 190             if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
 191                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
 192                                  'is not providing related metadata')
 193                 self.log.info(tt)
 194                 self.log.warning('Disabling MusicBrainzIdentifier')
 195                 self.use_mbid = Meta.use_mbid = False
 196             else:
 197                 self.log.debug('Available metadata: %s', tt)
 198                 self.use_mbid = Meta.use_mbid = True
 199         else:
 200             self.log.warning('Use of MusicBrainzIdentifier disabled!')
 201             self.log.info('Consider using MusicBrainzIdentifier for your music library')
 202             self.use_mbid = Meta.use_mbid = False
 203         self._reset_cache()
 204     # ######### / Overriding MPDClient #########
 205
 206     def _reset_cache(self):
 207         """
 208         Both flushes and instantiates _cache
 209         """
 210         if isinstance(self._cache, dict):
 211             self.log.info('Player: Flushing cache!')
 212         else:
 213             self.log.info('Player: Initialising cache!')
 214         self._cache = {'artists': frozenset(),
 215                        'nombid_artists': frozenset()}
 216         self._cache['artists'] = frozenset(filter(None, self.list('artist')))
 217         if Artist.use_mbid:
 218             artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
 219             self._cache['nombid_artists'] = frozenset(filter(None, artists))
 220
 221     def _skipped_track(self, previous):
 222         if (self.state == 'stop'
 223                 or not hasattr(previous, 'id')
 224                 or not hasattr(self.current, 'id')):
 225             return False
 226         return self.current.id != previous.id  # pylint: disable=no-member
 227
 228     def monitor(self):
 229         """OLD socket Idler
 230         Monitor player for change
 231         Returns a list a events among:
 232
 233             * database  player media library has changed
 234             * playlist  playlist modified
 235             * options   player options changed: repeat mode, etc…
 236             * player    player state changed: paused, stopped, skip track…
 237             * skipped   current track skipped
 238         """
 239         curr = self.current
 240         try:
 241             ret = self.idle('database', 'playlist', 'player', 'options')
 242         except (MPDError, IOError) as err:
 243             raise PlayerError("Couldn't init idle: %s" % err)
 244         if self._skipped_track(curr):
 245             ret.append('skipped')
 246         if 'database' in ret:
 247             self._reset_cache()
 248         return ret
 249
 250     def clean(self):
 251         """Clean blocking event (idle) and pending commands
 252         """
 253         if 'idle' in self._pending:
 254             self.noidle()
 255         elif self._pending:
 256             self.log.warning('pending commands: %s', self._pending)
 257
 258     def add(self, payload):
 259         """Overriding MPD's add method to accept Track objects"""
 260         if isinstance(payload, Track):
 261             super().__getattr__('add')(payload.file)
 262         elif isinstance(payload, list):
 263             self.command_list_ok_begin()
 264             map(self.add, payload)
 265             self.command_list_end()
 266         else:
 267             self.log.error('Cannot add %s', payload)
 268
 269     # ######### Properties #####################
 270     @property
 271     def current(self):
 272         return self.currentsong()
 273
 274     @property
 275     def playlist(self):
 276         """
 277         Override deprecated MPD playlist command
 278         """
 279         return self.playlistinfo()
 280
 281     @property
 282     def playmode(self):
 283         plm = {'repeat': None, 'single': None,
 284                'random': None, 'consume': None, }
 285         for key, val in self.status().items():
 286             if key in plm.keys():
 287                 plm.update({key: bool(int(val))})
 288         return plm
 289
 290     @property
 291     def queue(self):
 292         plst = self.playlist
 293         curr_position = int(self.current.pos)
 294         plst.reverse()
 295         return [trk for trk in plst if int(trk.pos) > curr_position]
 296
 297     @property
 298     def state(self):
 299         """Returns (play|stop|pause)"""
 300         return str(self.status().get('state'))
 301     # ######### / Properties ###################
 302
 303 # #### find_tracks ####
 304     def find_tracks(self, what):
 305         """Find tracks for a specific artist or album
 306             >>> player.find_tracks(Artist('Nirvana'))
 307             >>> player.find_tracks(Album('In Utero', artist=(Artist('Nirvana'))
 308
 309         :param Artist,Album what: Artist or Album to fetch track from
 310
 311         Returns a list of :py:obj:Track objects
 312         """
 313         if isinstance(what, Artist):
 314             return self._find_art(what)
 315         if isinstance(what, Album):
 316             return self._find_alb(what)
 317         if isinstance(what, str):
 318             return self.find_tracks(Artist(name=what))
 319         raise PlayerError('Bad input argument')
 320
 321     def _find_art(self, artist):
 322         tracks = set()
 323         if artist.mbid:
 324             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
 325         for name in artist.names_sz:
 326             tracks |= set(self.find('artist', name))
 327         return list(tracks)
 328
 329     def _find_alb(self, album):
 330         if not hasattr(album, 'artist'):
 331             raise PlayerError('Album object have no artist attribute')
 332         albums = []
 333         if self.use_mbid and album.mbid:
 334             filt = f'(MUSICBRAINZ_ALBUMID == {album.mbid})'
 335             albums = self.find(filt)
 336         # Now look for album with no MusicBrainzIdentifier
 337         if not albums and album.artist.mbid and self.use_mbid:  # Use album artist MBID if possible
 338             filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album.name_sz}'))"
 339             albums = self.find(filt)
 340         if not albums:  # Falls back to (album)?artist/album name
 341             filt = f"((albumartist == '{album.artist!s}') AND (album == '{album.name_sz}'))"
 342             albums = self.find(filt)
 343         return albums
 344 # #### / find_tracks ##
 345
 346 # #### Search Methods #####
 347     @bl_artist
 348     def search_artist(self, artist):
 349         """
 350         Search artists based on a fuzzy search in the media library
 351             >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
 352             >>> bea = player.search_artist(art)
 353             >>> print(bea.names)
 354             >>> ['The Beatles', 'Beatles', 'the beatles']
 355
 356         :param Artist artist: Artist to look for in MPD music library
 357
 358         Returns an Artist object
 359         """
 360         found = False
 361         if self.use_mbid and artist.mbid:
 362             # look for exact search w/ musicbrainz_artistid
 363             found = bool(self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')"))
 364             if found:
 365                 self.log.trace('Found mbid "%r" in library', artist)
 366             # Fetches remaining artists for potential match
 367             artists = self._cache['nombid_artists']
 368         else:  # not using MusicBrainzIDs
 369             artists = self._cache['artists']
 370         match = get_close_matches(artist.name, artists, 50, 0.73)
 371         if not match and not found:
 372             return None
 373         if len(match) > 1:
 374             self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
 375         # Forst lowercased comparison
 376         for close_art in match:
 377             # Regular lowered string comparison
 378             if artist.name.lower() == close_art.lower():
 379                 artist.add_alias(close_art)
 380                 found = True
 381                 if artist.name != close_art:
 382                     self.log.debug('"%s" matches "%s".', close_art, artist)
 383         # Does not perform fuzzy matching on short and single word strings
 384         # Only lowercased comparison
 385         if ' ' not in artist.name and len(artist.name) < 8:
 386             self.log.trace('no fuzzy matching for %r', artist)
 387             if found:
 388                 return artist
 389         # Now perform fuzzy search
 390         for fuzz in match:
 391             if fuzz in artist.names:  # Already found in lower cased comparison
 392                 continue
 393             # SimaStr string __eq__ (not regular string comparison here)
 394             if SimaStr(artist.name) == fuzz:
 395                 found = True
 396                 artist.add_alias(fuzz)
 397                 self.log.info('"%s" quite probably matches "%s" (SimaStr)',
 398                               fuzz, artist)
 399         if found:
 400             if artist.aliases:
 401                 self.log.debug('Found aliases: %s', '/'.join(artist.names))
 402             return artist
 403         return None
 404
 405     @blacklist(track=True)
 406     def search_track(self, artist, title):
 407         """Fuzzy search of title by an artist
 408         """
 409         # Retrieve all tracks from artist
 410         all_tracks = self.find_tracks(artist)
 411         # Get all titles (filter missing titles set to 'None')
 412         all_artist_titles = frozenset([tr.title for tr in all_tracks
 413                                        if tr.title is not None])
 414         match = get_close_matches(title, all_artist_titles, 50, 0.78)
 415         if not match:
 416             return []
 417         for mtitle in match:
 418             leven = levenshtein_ratio(title.lower(), mtitle.lower())
 419             if leven == 1:
 420                 pass
 421             elif leven >= 0.79:  # PARAM
 422                 self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
 423                                mtitle, title, leven)
 424             else:
 425                 self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
 426                                mtitle, title, leven)
 427                 return []
 428             return self.find('artist', artist, 'title', mtitle)
 429
 430     @blacklist(album=True)
 431     def search_albums(self, artist):
 432         """Find potential albums for "artist"
 433
 434         * Fetch all albums for "AlbumArtist" == artist
 435           → falls back to "Artist" == artist when no "AlbumArtist" tag is set
 436         * Tries to filter some mutli-artists album
 437           For instance an album by Artist_A may have a track by Artist_B. Then
 438           looking for albums for Artist_B returns wrongly this album.
 439         """
 440         # First, look for all potential albums
 441         self.log.debug('Searching album for "%s"', artist)
 442         if artist.aliases:
 443             self.log.debug('Searching album for %s aliases: "%s"',
 444                            artist, artist.aliases)
 445         for name_sz in artist.names_sz:
 446             raw_albums = self.list('album', f"( albumartist == '{name_sz}')")
 447             albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums if a]
 448         candidates = []
 449         for album in albums:
 450             album_trks = self.find_tracks(album)
 451             album_artists = {tr.albumartist for tr in album_trks if tr.albumartist}
 452             if album.artist.names & album_artists:
 453                 candidates.append(album)
 454                 continue
 455             if 'Various Artists' in album_artists:
 456                 self.log.debug('Discarding %s ("Various Artists" set)', album)
 457                 continue
 458             if album_artists and album.artist.name not in album_artists:
 459                 self.log.debug('Discarding "%s", "%s" not set as albumartist', album, album.artist)
 460                 continue
 461             # Attempt to detect false positive
 462             # Avoid selecting albums where artist is credited for a single
 463             # track of the album
 464             album_trks = self.find(f"(album == '{album.name_sz}')")
 465             arts = [trk.artist for trk in album_trks]  # Artists in the album
 466             # count artist occurences
 467             ratio = arts.count(album.artist.name)/len(arts)
 468             if ratio >= 0.8:
 469                 candidates.append(album)
 470             else:
 471                 self.log.debug('"%s" probably not an album of "%s" (ratio=%.2f)',
 472                                album, artist, ratio)
 473             continue
 474         return candidates
 475 # #### / Search Methods ###
 476
 477 # VIM MODLINE
 478 # vim: ai ts=4 sw=4 sts=4 expandtab