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