X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Fmpdclient.py;h=99f69474258a513cbe6567dce875b11f012c4446;hb=1a178217e8efd3b2b523afb93775124baf1be05f;hp=92ca0ceee21e1ec92a3d1450652047a8da3b4eec;hpb=12d710d35febb030442322df99d851ad2da29704;p=mpd-sima.git diff --git a/sima/mpdclient.py b/sima/mpdclient.py index 92ca0ce..99f6947 100644 --- a/sima/mpdclient.py +++ b/sima/mpdclient.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2009-2021 kaliko +# Copyright (c) 2009-2022, 2024 kaliko # # This file is part of sima # @@ -20,9 +20,10 @@ from difflib import get_close_matches from functools import wraps from logging import getLogger +from select import select # external module -from musicpd import MPDClient, MPDError +from musicpd import MPDClient, MPDError as PlayerError # local import @@ -30,10 +31,7 @@ from .lib.meta import Meta, Artist, Album from .lib.track import Track from .lib.simastr import SimaStr from .utils.leven import levenshtein_ratio - - -class PlayerError(Exception): - """Fatal error in the player.""" +from .utils.utils import get_decorator # Some decorators @@ -42,23 +40,34 @@ def bl_artist(func): cls = args[0] if not cls.database: return func(*args, **kwargs) - results = func(*args, **kwargs) - if not results: + result = func(*args, **kwargs) + if not result: return None - for art in results.names: - mbid = results.mbid - if not mbid: - mbid = cls._find_musicbrainz_artistid(results) - artist = Artist(name=art, mbid=mbid) + for art in result.names: + artist = Artist(name=art, mbid=result.mbid) if cls.database.get_bl_artist(artist, add=False): cls.log.debug('Artist in blocklist: %s', artist) return None - return results + return result + return wrapper + + +def set_artist_mbid(func): + def wrapper(*args, **kwargs): + cls = args[0] + result = func(*args, **kwargs) + if Meta.use_mbid: + if result and not result.mbid: + mbid = cls._find_musicbrainz_artistid(result) + artist = Artist(name=result.name, mbid=mbid) + artist.add_alias(result) + return artist + return result return wrapper def tracks_wrapper(func): - """Convert plain track mapping as returned by MPDClient into :py:obj:Track + """Convert plain track mapping as returned by MPDClient into :py:obj:`sima.lib.track.Track` objects. This decorator accepts single track or list of tracks as input. """ @wraps(func) @@ -68,6 +77,9 @@ def tracks_wrapper(func): return Track(**ret) return [Track(**t) for t in ret] return wrapper + +# Decorator to wrap non MPDError exceptions from musicpd in PlayerError +we = get_decorator(errors=(OSError, TimeoutError), wrap_into=PlayerError) # / decorators @@ -75,7 +87,7 @@ class MPD(MPDClient): """ Player instance inheriting from MPDClient (python-musicpd). - Some methods are overridden to format objects as sima.lib.Track for + Some methods are overridden to format objects as :py:obj:`sima.lib.track.Track` for instance, other are calling parent class directly through super(). cf. MPD.__getattr__ @@ -101,12 +113,14 @@ class MPD(MPDClient): def __init__(self, config): super().__init__() + self.socket_timeout = 10 self.use_mbid = True self.log = getLogger('sima') self.config = config self._cache = None # ######### Overriding MPDClient ########### + @we def __getattr__(self, cmd): """Wrapper around MPDClient calls for abstract overriding""" track_wrapped = {'currentsong', 'find', 'playlistinfo', } @@ -127,54 +141,37 @@ class MPD(MPDClient): port = mpd_config.get('port') password = mpd_config.get('password', fallback=None) self.disconnect() - try: - super().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)) + super().connect(host, port) if password: - try: - self.password(password) - except (MPDError, IOError) as err: - raise PlayerError("Could not connect to '%s': %s" % (host, err)) + self.password(password) # Controls we have sufficient rights available_cmd = self.commands() for cmd in MPD.needed_cmds: if cmd not in available_cmd: self.disconnect() - raise PlayerError('Could connect to "%s", ' - 'but command "%s" not available' % - (host, cmd)) - self.tagtypes('clear') + raise PlayerError(f'Could connect to "{host}", but command "{cmd}" not available') + self.tagtypes_clear() for tag in MPD.needed_tags: - self.tagtypes('enable', tag) - tt = set(map(str.lower, self.tagtypes())) + self.tagtypes_enable(tag) + ltt = set(map(str.lower, self.tagtypes())) needed_tags = set(map(str.lower, MPD.needed_tags)) - if len(needed_tags & tt) != len(MPD.needed_tags): - self.log.warning('MPD exposes: %s', tt) + if len(needed_tags & ltt) != len(MPD.needed_tags): + self.log.warning('MPD exposes: %s', ltt) self.log.warning('Tags needed: %s', needed_tags) raise PlayerError('Missing mandatory metadata!') for tag in MPD.needed_mbid_tags: - self.tagtypes('enable', tag) + self.tagtypes_enable(tag) # Controls use of MusicBrainzIdentifier if self.config.getboolean('sima', 'musicbrainzid'): - tt = set(self.tagtypes()) - if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags): + ltt = set(self.tagtypes()) + if len(MPD.needed_mbid_tags & ltt) != len(MPD.needed_mbid_tags): self.log.warning('Use of MusicBrainzIdentifier is set but MPD ' 'is not providing related metadata') - self.log.info(tt) + self.log.info(ltt) self.log.warning('Disabling MusicBrainzIdentifier') self.use_mbid = Meta.use_mbid = False else: - self.log.debug('Available metadata: %s', tt) + self.log.debug('Available metadata: %s', ltt) self.use_mbid = Meta.use_mbid = True else: self.log.warning('Use of MusicBrainzIdentifier disabled!') @@ -210,6 +207,7 @@ class MPD(MPDClient): return False return self.current.id != previous.id # pylint: disable=no-member + @we def monitor(self): """Monitor player for change Returns a list a events among: @@ -221,15 +219,19 @@ class MPD(MPDClient): * skipped current track skipped """ curr = self.current - try: - ret = self.idle('database', 'playlist', 'player', 'options') - except (MPDError, IOError) as err: - raise PlayerError("Couldn't init idle: %s" % err) - if self._skipped_track(curr): - ret.append('skipped') - if 'database' in ret: - self._reset_cache() - return ret + select_timeout = 5 + while True: + self.send_idle('database', 'playlist', 'player', 'options') + _read, _, _ = select([self], [], [], select_timeout) + if _read: # tries to read response + ret = self.fetch_idle() + if self._skipped_track(curr): + ret.append('skipped') + if 'database' in ret: + self._reset_cache() + return ret + # Nothing to read, canceling idle + self.noidle() def clean(self): """Clean blocking event (idle) and pending commands @@ -239,10 +241,11 @@ class MPD(MPDClient): elif self._pending: self.log.warning('pending commands: %s', self._pending) + @we def add(self, payload): """Overriding MPD's add method to accept Track objects - :param Track,list payload: Either a single :py:obj:`Track` or a list of it + :param Track,list payload: Either a single track or a list of it """ if isinstance(payload, Track): super().__getattr__('add')(payload.file) @@ -270,7 +273,7 @@ class MPD(MPDClient): plm = {'repeat': None, 'single': None, 'random': None, 'consume': None, } for key, val in self.status().items(): - if key in plm.keys(): + if key in plm: plm.update({key: bool(int(val))}) return plm @@ -294,8 +297,8 @@ class MPD(MPDClient): >>> player.find_tracks(Album('In Utero', artist=Artist('Nirvana')) :param Artist,Album what: Artist or Album to fetch track from - - Returns a list of :py:obj:Track objects + :return: A list of track objects + :rtype: list(Track) """ if isinstance(what, Artist): return self._find_art(what) @@ -316,7 +319,7 @@ class MPD(MPDClient): for name in artist.names: tracks |= set(self.find('artist', name)) # album blocklist - albums = {Album(trk.album, mbid=trk.musicbrainz_albumid) + albums = {Album(trk.Album.name, mbid=trk.musicbrainz_albumid) for trk in tracks} bl_albums = {Album(a.get('album'), mbid=a.get('musicbrainz_album')) for a in self.database.view_bl() if a.get('album')} @@ -355,10 +358,16 @@ class MPD(MPDClient): # #### Search Methods ##### def _find_musicbrainz_artistid(self, artist): + """Find MusicBrainzArtistID when possible. + """ if not self.use_mbid: return None - mbids = self.list('MUSICBRAINZ_ARTISTID', - f'(artist == "{artist.name_sz}")') + mbids = None + for name in artist.names_sz: + filt = f'((artist == "{name}") AND (MUSICBRAINZ_ARTISTID != ""))' + mbids = self.list('MUSICBRAINZ_ARTISTID', filt) + if mbids: + break if not mbids: return None if len(mbids) > 1: @@ -370,8 +379,10 @@ class MPD(MPDClient): artist.name, mbids[0], artist.mbid) else: return mbids[0] + return None @bl_artist + @set_artist_mbid def search_artist(self, artist): """ Search artists based on a fuzzy search in the media library @@ -381,8 +392,8 @@ class MPD(MPDClient): >>> ['The Beatles', 'Beatles', 'the beatles'] :param Artist artist: Artist to look for in MPD music library - - Returns an Artist object + :return: Artist object + :rtype: Artist """ found = False if artist.mbid: @@ -398,12 +409,6 @@ class MPD(MPDClient): if SimaStr(artist.name) == name and name != artist.name: self.log.debug('add alias for %s: %s', artist, name) artist.add_alias(name) - elif len(library) == 1 and library[0] != artist.name: - new_alias = artist.name - self.log.info('Update artist name %s->%s', artist, library[0]) - self.log.debug('Also add alias for %s: %s', artist, new_alias) - artist = Artist(name=library[0], mbid=artist.mbid) - artist.add_alias(new_alias) # Fetches remaining artists for potential match artists = self._cache['nombid_artists'] else: # not using MusicBrainzIDs @@ -527,9 +532,9 @@ class MPD(MPDClient): if artist.mbid == album_trks[0].musicbrainz_albumartistid: candidates.append(album) continue - else: - self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid', album, album.Artist) - continue + self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid', + album, album.Artist) + continue if 'Various Artists' in album_artists: self.log.debug('Discarding %s ("Various Artists" set)', album) continue