sima/client.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2013, 2014 Jack 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 #
  20 """MPD client for Sima
  21
  22 This client is built above python-musicpd a fork of python-mpd
  23 """
  24 #  pylint: disable=C0111
  25
  26 # standard library import
  27 from difflib import get_close_matches
  28 from select import select
  29
  30 # third parties components
  31 try:
  32     from musicpd import (MPDClient, MPDError, CommandError)
  33 except ImportError as err:
  34     from sys import exit as sexit
  35     print('ERROR: missing python-musicpd?\n{0}'.format(err))
  36     sexit(1)
  37
  38 # local import
  39 from .lib.simastr import SimaStr
  40 from .lib.player import Player, blacklist
  41 from .lib.track import Track
  42 from .lib.meta import Album, Artist
  43 from .utils.leven import levenshtein_ratio
  44
  45
  46 class PlayerError(Exception):
  47     """Fatal error in poller."""
  48
  49 class PlayerCommandError(PlayerError):
  50     """Command error"""
  51
  52 PlayerUnHandledError = MPDError  # pylint: disable=C0103
  53
  54 def bl_artist(func):
  55     def wrapper(*args, **kwargs):
  56         cls = args[0]
  57         if not args[0].database:
  58             return func(*args, **kwargs)
  59         result = func(*args, **kwargs)
  60         if not result:
  61             return
  62         names = list()
  63         for art in result.names:
  64             if cls.database.get_bl_artist(art, add_not=True):
  65                 cls.log.debug('Blacklisted "{0}"'.format(art))
  66                 continue
  67             names.append(art)
  68         if not names:
  69             return
  70         resp = Artist(name=names.pop(), mbid=result.mbid)
  71         for name in names:
  72             resp.add_alias(name)
  73         return resp
  74     return wrapper
  75
  76
  77 class PlayerClient(Player):
  78     """MPD Client
  79     From python-musicpd:
  80         _fetch_nothing  …
  81         _fetch_item     single str
  82         _fetch_object   single dict
  83         _fetch_list     list of str
  84         _fetch_playlist list of str
  85         _fetch_changes  list of dict
  86         _fetch_database list of dict
  87         _fetch_songs    list of dict, especially tracks
  88         _fetch_plugins,
  89     TODO: handle exception in command not going through _client_wrapper() (ie.
  90           remove…)
  91     """
  92     database = None  # sima database (history, blacklist)
  93
  94     def __init__(self, host="localhost", port="6600", password=None):
  95         super().__init__()
  96         self._comm = self._args = None
  97         self._mpd = host, port, password
  98         self._client = MPDClient()
  99         self._client.iterate = True
 100         self._cache = None
 101
 102     def __getattr__(self, attr):
 103         command = attr
 104         wrapper = self._execute
 105         return lambda *args: wrapper(command, args)
 106
 107     def _execute(self, command, args):
 108         self._write_command(command, args)
 109         return self._client_wrapper()
 110
 111     def _write_command(self, command, args=None):
 112         self._comm = command
 113         self._args = list()
 114         for arg in args:
 115             self._args.append(arg)
 116
 117     def _client_wrapper(self):
 118         func = self._client.__getattr__(self._comm)
 119         try:
 120             ans = func(*self._args)
 121         # WARNING: MPDError is an ancestor class of # CommandError
 122         except CommandError as err:
 123             raise PlayerCommandError('MPD command error: %s' % err)
 124         except (MPDError, IOError) as err:
 125             raise PlayerError(err)
 126         return self._track_format(ans)
 127
 128     def _track_format(self, ans):
 129         """
 130         unicode_obj = ["idle", "listplaylist", "list", "sticker list",
 131                 "commands", "notcommands", "tagtypes", "urlhandlers",]
 132         """
 133         # TODO: ain't working for "sticker find" and "sticker list"
 134         tracks_listing = ["playlistfind", "playlistid", "playlistinfo",
 135                           "playlistsearch", "plchanges", "listplaylistinfo", "find",
 136                           "search", "sticker find",]
 137         track_obj = ['currentsong']
 138         if self._comm in tracks_listing + track_obj:
 139             #  pylint: disable=w0142
 140             if isinstance(ans, list):
 141                 return [Track(**track) for track in ans]
 142             elif isinstance(ans, dict):
 143                 return Track(**ans)
 144         return ans
 145
 146     def __skipped_track(self, old_curr):
 147         if (self.state == 'stop'
 148                 or not hasattr(old_curr, 'id')
 149                 or not hasattr(self.current, 'id')):
 150             return False
 151         return self.current.id != old_curr.id  # pylint: disable=no-member
 152
 153     def _flush_cache(self):
 154         """
 155         Both flushes and instantiates _cache
 156         """
 157         if isinstance(self._cache, dict):
 158             self.log.info('Player: Flushing cache!')
 159         else:
 160             self.log.info('Player: Initialising cache!')
 161         self._cache = {'artists': frozenset(),
 162                        'nombid_artists': frozenset(),}
 163         self._cache['artists'] = frozenset(self._execute('list', ['artist']))
 164         if Artist.use_mbid:
 165             self._cache['nombid_artists'] = frozenset(self._execute('list', ['artist', 'musicbrainz_artistid', '']))
 166
 167     @blacklist(track=True)
 168     def find_track(self, artist, title=None):
 169         tracks = set()
 170         if artist.mbid:
 171             if title:
 172                 tracks |= set(self.find('musicbrainz_artistid', artist.mbid,
 173                                         'title', title))
 174             else:
 175                 tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
 176         else:
 177             for name in artist.names:
 178                 if title:
 179                     tracks |= set(self.find('artist', name, 'title', title))
 180                 else:
 181                     tracks |= set(self.find('artist', name))
 182         return list(tracks)
 183
 184     @bl_artist
 185     def search_artist(self, artist):
 186         """
 187         Search artists based on a fuzzy search in the media library
 188             >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
 189             >>> bea = player.search_artist(art)
 190             >>> print(bea.names)
 191             >>> ['The Beatles', 'Beatles', 'the beatles']
 192
 193         Returns an Artist object
 194         """
 195         found = False
 196         if artist.mbid:
 197             # look for exact search w/ musicbrainz_artistid
 198             exact_m = self._execute('list', ['artist', 'musicbrainz_artistid', artist.mbid])
 199             if exact_m:
 200                 [artist.add_alias(name) for name in exact_m]
 201                 found = True
 202         else:
 203             artist = Artist(name=artist.name)
 204         # then complete with fuzzy search on artist with no musicbrainz_artistid
 205         if artist.mbid:
 206             # we already performed a lookup on artists with mbid set
 207             # search through remaining artists
 208             artists = self._cache.get('nombid_artists')
 209         else:
 210             artists = self._cache.get('artists')
 211         match = get_close_matches(artist.name, artists, 50, 0.73)
 212         if not match and not found:
 213             return
 214         if len(match) > 1:
 215             self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
 216         # Does not perform fuzzy matching on short and single word strings
 217         # Only lowercased comparison
 218         if ' ' not in artist.name and len(artist.name) < 8:
 219             for fuzz_art in match:
 220                 # Regular lowered string comparison
 221                 if artist.name.lower() == fuzz_art.lower():
 222                     artist.add_alias(fuzz_art)
 223                     return artist
 224         fzartist = SimaStr(artist.name)
 225         for fuzz_art in match:
 226             # Regular lowered string comparison
 227             if artist.name.lower() == fuzz_art.lower():
 228                 found = True
 229                 artist.add_alias(fuzz_art)
 230                 if artist.name != fuzz_art:
 231                     self.log.debug('"%s" matches "%s".', fuzz_art, artist)
 232                 continue
 233             # SimaStr string __eq__ (not regular string comparison here)
 234             if fzartist == fuzz_art:
 235                 found = True
 236                 artist.add_alias(fuzz_art)
 237                 self.log.info('"%s" quite probably matches "%s" (SimaStr)',
 238                               fuzz_art, artist)
 239         if found:
 240             if artist.aliases:
 241                 self.log.debug('Found: %s', '/'.join(list(artist.names)[:4]))
 242             return artist
 243
 244     def fuzzy_find_track(self, artist, title):
 245         # Retrieve all tracks from artist
 246         all_tracks = self.find_track(artist, title)
 247         # Get all titles (filter missing titles set to 'None')
 248         all_artist_titles = frozenset([tr.title for tr in all_tracks
 249                                        if tr.title is not None])
 250         match = get_close_matches(title, all_artist_titles, 50, 0.78)
 251         if not match:
 252             return []
 253         for title_ in match:
 254             leven = levenshtein_ratio(title.lower(), title_.lower())
 255             if leven == 1:
 256                 pass
 257             elif leven >= 0.79:  # PARAM
 258                 self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
 259                                title_, title, leven)
 260             else:
 261                 self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
 262                                title_, title, leven)
 263                 return []
 264             return self.find('artist', artist, 'title', title_)
 265
 266     def find_album(self, artist, album):
 267         """
 268         Special wrapper around album search:
 269         Album lookup is made through AlbumArtist/Album instead of Artist/Album
 270         """
 271         alb_art_search = self.find('albumartist', artist, 'album', album)
 272         if alb_art_search:
 273             return alb_art_search
 274         return self.find('artist', artist, 'album', album)
 275
 276     @blacklist(album=True)
 277     def search_albums(self, artist):
 278         """
 279         Fetch all albums for "AlbumArtist"  == artist
 280         Filter albums returned for "artist" == artist since MPD returns any
 281                album containing at least a single track for artist
 282         """
 283         albums = []
 284         for name in artist.names:
 285             if len(artist.names) > 1:
 286                 self.log.debug('Searching album for aliase: "%s"', name)
 287             kwalbart = {'albumartist':name, 'artist':name}
 288             for album in self.list('album', 'albumartist', artist):
 289                 if album and album not in albums:
 290                     albums.append(Album(name=album, **kwalbart))
 291             for album in self.list('album', 'artist', artist):
 292                 album_trks = [trk for trk in self.find('album', album)]
 293                 if 'Various Artists' in [tr.albumartist for tr in album_trks]:
 294                     self.log.debug('Discarding %s ("Various Artists" set)', album)
 295                     continue
 296                 arts = set([trk.artist for trk in album_trks])
 297                 if len(set(arts)) < 2:  # TODO: better heuristic, use a ratio instead
 298                     if album not in albums:
 299                         albums.append(Album(name=album, **kwalbart))
 300                 elif album and album not in albums:
 301                     self.log.debug('"{0}" probably not an album of "{1}"'.format(
 302                         album, artist) + '({0})'.format('/'.join(arts)))
 303         return albums
 304
 305     def monitor(self):
 306         curr = self.current
 307         try:
 308             self.send_idle('database', 'playlist', 'player', 'options')
 309             select([self._client], [], [], 60)
 310             ret = self.fetch_idle()
 311             if self.__skipped_track(curr):
 312                 ret.append('skipped')
 313             if 'database' in ret:
 314                 self._flush_cache()
 315             return ret
 316         except (MPDError, IOError) as err:
 317             raise PlayerError("Couldn't init idle: %s" % err)
 318
 319     def clean(self):
 320         """Clean blocking event (idle) and pending commands
 321         """
 322         if 'idle' in self._client._pending:
 323             self._client.noidle()
 324         elif self._client._pending:
 325             self.log.warning('pending commands: %s', self._client._pending)
 326
 327     def remove(self, position=0):
 328         self.delete(position)
 329
 330     def add(self, track):
 331         """Overriding MPD's add method to accept add signature with a Track
 332         object"""
 333         self._execute('add', [track.file])
 334
 335     @property
 336     def artists(self):
 337         return self._cache.get('artists')
 338
 339     @property
 340     def state(self):
 341         return str(self.status().get('state'))
 342
 343     @property
 344     def current(self):
 345         return self.currentsong()
 346
 347     @property
 348     def queue(self):
 349         plst = self.playlist
 350         plst.reverse()
 351         return [trk for trk in plst if int(trk.pos) > int(self.current.pos)]
 352
 353     @property
 354     def playlist(self):
 355         """
 356         Override deprecated MPD playlist command
 357         """
 358         return self.playlistinfo()
 359
 360     def connect(self):
 361         host, port, password = self._mpd
 362         self.disconnect()
 363         try:
 364             self._client.connect(host, port)
 365
 366         # Catch socket errors
 367         except IOError as err:
 368             raise PlayerError('Could not connect to "%s:%s": %s' %
 369                               (host, port, err.strerror))
 370
 371         # Catch all other possible errors
 372         # ConnectionError and ProtocolError are always fatal.  Others may not
 373         # be, but we don't know how to handle them here, so treat them as if
 374         # they are instead of ignoring them.
 375         except MPDError as err:
 376             raise PlayerError('Could not connect to "%s:%s": %s' %
 377                               (host, port, err))
 378
 379         if password:
 380             try:
 381                 self._client.password(password)
 382
 383             # Catch errors with the password command (e.g., wrong password)
 384             except CommandError as err:
 385                 raise PlayerError("Could not connect to '%s': "
 386                                   "password command failed: %s" %
 387                                   (host, err))
 388
 389             # Catch all other possible errors
 390             except (MPDError, IOError) as err:
 391                 raise PlayerError("Could not connect to '%s': "
 392                                   "error with password command: %s" %
 393                                   (host, err))
 394         # Controls we have sufficient rights
 395         needed_cmds = ['status', 'stats', 'add', 'find', \
 396                        'search', 'currentsong', 'ping']
 397
 398         available_cmd = self._client.commands()
 399         for nddcmd in needed_cmds:
 400             if nddcmd not in available_cmd:
 401                 self.disconnect()
 402                 raise PlayerError('Could connect to "%s", '
 403                                   'but command "%s" not available' %
 404                                   (host, nddcmd))
 405
 406         #  Controls use of MusicBrainzIdentifier
 407         if Artist.use_mbid:
 408             if 'MUSICBRAINZ_ARTISTID' not in self._client.tagtypes():
 409                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD is '
 410                                  'not providing related metadata')
 411                 self.log.info(self._client.tagtypes())
 412                 self.log.warning('Disabling MusicBrainzIdentifier')
 413                 Artist.use_mbid = False
 414         else:
 415             self.log.warning('Use of MusicBrainzIdentifier disabled!')
 416             self.log.info('Consider using MusicBrainzIdentifier for your music library')
 417         self._flush_cache()
 418
 419     def disconnect(self):
 420         # Try to tell MPD we're closing the connection first
 421         try:
 422             self._client.noidle()
 423             self._client.close()
 424         # If that fails, don't worry, just ignore it and disconnect
 425         except (MPDError, IOError):
 426             pass
 427         try:
 428             self._client.disconnect()
 429         # Disconnecting failed, so use a new client object instead
 430         # This should never happen.  If it does, something is seriously broken,
 431         # and the client object shouldn't be trusted to be re-used.
 432         except (MPDError, IOError):
 433             self._client = MPDClient()
 434
 435 # VIM MODLINE
 436 # vim: ai ts=4 sw=4 sts=4 expandtab