+++ /dev/null
-# -*- coding: utf-8 -*-
-# Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
-#
-# This file is part of sima
-#
-# sima is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# sima is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with sima. If not, see <http://www.gnu.org/licenses/>.
-#
-#
-"""MPD client for Sima
-
-This client is built above python-musicpd a fork of python-mpd
-"""
-# pylint: disable=C0111
-
-# standard library import
-from difflib import get_close_matches
-from select import select
-
-# third parties components
-try:
- from musicpd import (MPDClient, MPDError, CommandError)
-except ImportError as err:
- from sys import exit as sexit
- print('ERROR: missing python-musicpd?\n{0}'.format(err))
- sexit(1)
-
-# local import
-from .lib.simastr import SimaStr
-from .lib.player import Player, blacklist
-from .lib.track import Track
-from .lib.meta import Album, Artist
-from .utils.leven import levenshtein_ratio
-
-
-class PlayerError(Exception):
- """Fatal error in poller."""
-
-class PlayerCommandError(PlayerError):
- """Command error"""
-
-PlayerUnHandledError = MPDError # pylint: disable=C0103
-
-def bl_artist(func):
- def wrapper(*args, **kwargs):
- cls = args[0]
- if not args[0].database:
- return func(*args, **kwargs)
- result = func(*args, **kwargs)
- if not result:
- return
- names = list()
- for art in result.names:
- if cls.database.get_bl_artist(art, add_not=True):
- cls.log.debug('Blacklisted "%s"', art)
- continue
- names.append(art)
- if not names:
- return
- resp = Artist(name=names.pop(), mbid=result.mbid)
- for name in names:
- resp.add_alias(name)
- return resp
- return wrapper
-
-
-class PlayerClient(Player):
- """MPD Client
- From python-musicpd:
- _fetch_nothing …
- _fetch_item single str
- _fetch_object single dict
- _fetch_list list of str
- _fetch_playlist list of str
- _fetch_changes list of dict
- _fetch_database list of dict
- _fetch_songs list of dict, especially tracks
- _fetch_plugins,
- TODO: handle exception in command not going through _client_wrapper() (ie.
- remove…)
- """
- database = None # sima database (history, blacklist)
-
- def __init__(self, host="localhost", port="6600", password=None):
- super().__init__()
- self._comm = self._args = None
- self._mpd = host, port, password
- self._client = MPDClient()
- self._client.iterate = True
- self._cache = None
-
- def __getattr__(self, attr):
- command = attr
- wrapper = self._execute
- return lambda *args: wrapper(command, args)
-
- def _execute(self, command, args):
- self._write_command(command, args)
- return self._client_wrapper()
-
- def _write_command(self, command, args=None):
- self._comm = command
- self._args = list()
- for arg in args:
- self._args.append(arg)
-
- def _client_wrapper(self):
- func = self._client.__getattr__(self._comm)
- try:
- ans = func(*self._args)
- # WARNING: MPDError is an ancestor class of # CommandError
- except CommandError as err:
- raise PlayerCommandError('MPD command error: %s' % err)
- except (MPDError, IOError) as err:
- raise PlayerError(err)
- return self._track_format(ans)
-
- def _track_format(self, ans):
- """
- unicode_obj = ["idle", "listplaylist", "list", "sticker list",
- "commands", "notcommands", "tagtypes", "urlhandlers",]
- """
- # TODO: ain't working for "sticker find" and "sticker list"
- tracks_listing = ["playlistfind", "playlistid", "playlistinfo",
- "playlistsearch", "plchanges", "listplaylistinfo", "find",
- "search", "sticker find",]
- track_obj = ['currentsong']
- if self._comm in tracks_listing + track_obj:
- if isinstance(ans, list):
- return [Track(**track) for track in ans]
- elif isinstance(ans, dict):
- return Track(**ans)
- return ans
-
- def __skipped_track(self, old_curr):
- if (self.state == 'stop'
- or not hasattr(old_curr, 'id')
- or not hasattr(self.current, 'id')):
- return False
- return self.current.id != old_curr.id # pylint: disable=no-member
-
- def _flush_cache(self):
- """
- Both flushes and instantiates _cache
- """
- if isinstance(self._cache, dict):
- self.log.info('Player: Flushing cache!')
- else:
- self.log.info('Player: Initialising cache!')
- self._cache = {'artists': frozenset(),
- 'nombid_artists': frozenset(),}
- self._cache['artists'] = frozenset(filter(None, self._execute('list', ['artist'])))
- if Artist.use_mbid:
- self._cache['nombid_artists'] = frozenset(filter(None, self._execute('list', ['artist', 'musicbrainz_artistid', ''])))
-
- @blacklist(track=True)
- def find_track(self, artist, title=None):
- tracks = set()
- if artist.mbid:
- if title:
- tracks |= set(self.find('musicbrainz_artistid', artist.mbid,
- 'title', title))
- else:
- tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
- for name in artist.names:
- if title:
- tracks |= set(self.find('artist', name, 'title', title))
- else:
- tracks |= set(self.find('artist', name))
- return list(tracks)
-
- @bl_artist
- def search_artist(self, artist):
- """
- Search artists based on a fuzzy search in the media library
- >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
- >>> bea = player.search_artist(art)
- >>> print(bea.names)
- >>> ['The Beatles', 'Beatles', 'the beatles']
-
- Returns an Artist object
- """
- found = False
- if artist.mbid:
- # look for exact search w/ musicbrainz_artistid
- exact_m = self._execute('list', ['artist', 'musicbrainz_artistid', artist.mbid])
- if exact_m:
- _ = [artist.add_alias(name) for name in exact_m]
- found = True
- # then complete with fuzzy search on artist with no musicbrainz_artistid
- if artist.mbid:
- # we already performed a lookup on artists with mbid set
- # search through remaining artists
- artists = self._cache.get('nombid_artists')
- else:
- artists = self._cache.get('artists')
- match = get_close_matches(artist.name, artists, 50, 0.73)
- if not match and not found:
- return
- if len(match) > 1:
- self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
- # Does not perform fuzzy matching on short and single word strings
- # Only lowercased comparison
- if ' ' not in artist.name and len(artist.name) < 8:
- for close_art in match:
- # Regular lowered string comparison
- if artist.name.lower() == close_art.lower():
- artist.add_alias(close_art)
- return artist
- else:
- return
- for fuzz_art in match:
- # Regular lowered string comparison
- if artist.name.lower() == fuzz_art.lower():
- found = True
- artist.add_alias(fuzz_art)
- if artist.name != fuzz_art:
- self.log.debug('"%s" matches "%s".', fuzz_art, artist)
- continue
- # SimaStr string __eq__ (not regular string comparison here)
- if SimaStr(artist.name) == fuzz_art:
- found = True
- artist.add_alias(fuzz_art)
- self.log.info('"%s" quite probably matches "%s" (SimaStr)',
- fuzz_art, artist)
- if found:
- if artist.aliases:
- self.log.debug('Found: %s', '/'.join(list(artist.names)[:4]))
- return artist
-
- def fuzzy_find_track(self, artist, title):
- # Retrieve all tracks from artist
- all_tracks = self.find_track(artist, title)
- # Get all titles (filter missing titles set to 'None')
- all_artist_titles = frozenset([tr.title for tr in all_tracks
- if tr.title is not None])
- match = get_close_matches(title, all_artist_titles, 50, 0.78)
- if not match:
- return []
- for mtitle in match:
- leven = levenshtein_ratio(title.lower(), mtitle.lower())
- if leven == 1:
- pass
- elif leven >= 0.79: # PARAM
- self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
- mtitle, title, leven)
- else:
- self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
- mtitle, title, leven)
- return []
- return self.find('artist', artist, 'title', mtitle)
-
- def find_album(self, artist, album):
- """
- Special wrapper around album search:
- Album lookup is made through AlbumArtist/Album instead of Artist/Album
- MPD falls back to Artist if AlbumArtist is not found (cf. documentation)
- """
- return self.find('albumartist', artist, 'album', album)
-
- @blacklist(album=True)
- def search_albums(self, artist):
- """
- Fetch all albums for "AlbumArtist" == artist
- Then look for albums for "artist" == artist and try to filters
- multi-artists albums
-
- NB: Running "client.list('album', 'artist', name)" MPD returns any album
- containing at least a track with "artist" == name
- TODO: Use MusicBrainzID here cf. #30 @gitlab
- """
- albums = []
- for name in artist.names:
- if artist.aliases:
- self.log.debug('Searching album for aliase: "%s"', name)
- kwalbart = {'albumartist':name, 'artist':name}
- for album in self.list('album', 'albumartist', name):
- if album and album not in albums:
- albums.append(Album(name=album, **kwalbart))
- for album in self.list('album', 'artist', name):
- album_trks = [trk for trk in self.find('album', album)]
- if 'Various Artists' in [tr.albumartist for tr in album_trks]:
- self.log.debug('Discarding %s ("Various Artists" set)', album)
- continue
- arts = set([trk.artist for trk in album_trks])
- # Avoid selecting album where artist is credited for a single
- # track of the album
- if len(set(arts)) < 2: # TODO: better heuristic, use a ratio instead
- if album not in albums:
- albums.append(Album(name=album, **kwalbart))
- elif album and album not in albums:
- self.log.debug('"{0}" probably not an album of "{1}"'.format(
- album, artist) + '({0})'.format('/'.join(arts)))
- return albums
-
- def monitor(self):
- curr = self.current
- try:
- self.send_idle('database', 'playlist', 'player', 'options')
- select([self._client], [], [], 60)
- ret = self.fetch_idle()
- if self.__skipped_track(curr):
- ret.append('skipped')
- if 'database' in ret:
- self._flush_cache()
- return ret
- except (MPDError, IOError) as err:
- raise PlayerError("Couldn't init idle: %s" % err)
-
- def clean(self):
- """Clean blocking event (idle) and pending commands
- """
- if 'idle' in self._client._pending:
- self._client.noidle()
- elif self._client._pending:
- self.log.warning('pending commands: %s', self._client._pending)
-
- def remove(self, position=0):
- self.delete(position)
-
- def add(self, track):
- """Overriding MPD's add method to accept add signature with a Track
- object"""
- self._execute('add', [track.file])
-
- @property
- def artists(self):
- return self._cache.get('artists')
-
- @property
- def state(self):
- return str(self.status().get('state'))
-
- @property
- def playmode(self):
- plm = {'repeat': None,
- 'single': None,
- 'random': None,
- 'consume': None,
- }
- for key, val in self.status().items():
- if key in plm.keys():
- plm.update({key:bool(int(val))})
- return plm
-
- @property
- def current(self):
- return self.currentsong()
-
- @property
- def queue(self):
- plst = self.playlist
- plst.reverse()
- return [trk for trk in plst if int(trk.pos) > int(self.current.pos)]
-
- @property
- def playlist(self):
- """
- Override deprecated MPD playlist command
- """
- return self.playlistinfo()
-
- def connect(self):
- host, port, password = self._mpd
- self.disconnect()
- try:
- self._client.connect(host, port)
-
- # Catch socket errors
- except IOError as err:
- raise PlayerError('Could not connect to "%s:%s": %s' %
- (host, port, err.strerror))
-
- # Catch all other possible errors
- # ConnectionError and ProtocolError are always fatal. Others may not
- # be, but we don't know how to handle them here, so treat them as if
- # they are instead of ignoring them.
- except MPDError as err:
- raise PlayerError('Could not connect to "%s:%s": %s' %
- (host, port, err))
-
- if password:
- try:
- self._client.password(password)
- except (MPDError, IOError) as err:
- raise PlayerError("Could not connect to '%s': %s", (host, err))
- # Controls we have sufficient rights
- needed_cmds = ['status', 'stats', 'add', 'find', \
- 'search', 'currentsong', 'ping']
-
- available_cmd = self._client.commands()
- for nddcmd in needed_cmds:
- if nddcmd not in available_cmd:
- self.disconnect()
- raise PlayerError('Could connect to "%s", '
- 'but command "%s" not available' %
- (host, nddcmd))
-
- # Controls use of MusicBrainzIdentifier
- if Artist.use_mbid:
- if 'MUSICBRAINZ_ARTISTID' not in self._client.tagtypes():
- self.log.warning('Use of MusicBrainzIdentifier is set but MPD is '
- 'not providing related metadata')
- self.log.info(self._client.tagtypes())
- self.log.warning('Disabling MusicBrainzIdentifier')
- Artist.use_mbid = False
- else:
- self.log.trace('Available metadata: %s', self._client.tagtypes()) # pylint: disable=no-member
- else:
- self.log.warning('Use of MusicBrainzIdentifier disabled!')
- self.log.info('Consider using MusicBrainzIdentifier for your music library')
- self._flush_cache()
-
- def disconnect(self):
- # Try to tell MPD we're closing the connection first
- try:
- self._client.noidle()
- self._client.close()
- # If that fails, don't worry, just ignore it and disconnect
- except (MPDError, IOError):
- pass
- try:
- self._client.disconnect()
- # Disconnecting failed, so use a new client object instead
- # This should never happen. If it does, something is seriously broken,
- # and the client object shouldn't be trusted to be re-used.
- except (MPDError, IOError):
- self._client = MPDClient()
-
-# VIM MODLINE
-# vim: ai ts=4 sw=4 sts=4 expandtab
home / dev / repositories / mpd-sima.git / blobdiff