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