]> kaliko git repositories - mpd-sima.git/blobdiff - sima/mpdclient.py
Default config definition more consistent
[mpd-sima.git] / sima / mpdclient.py
index bbc7e071e95d0706a6b063663c792c1ad39d1dad..95cfb5765c23e41df83cb571924cdb0e6c6f6575 100644 (file)
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2009-2020 kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
@@ -33,7 +33,7 @@ from .utils.leven import levenshtein_ratio
 
 
 class PlayerError(Exception):
-    """Fatal error in poller."""
+    """Fatal error in the player."""
 
 
 # Some decorators
@@ -121,10 +121,16 @@ class MPD(MPDClient):
     """
     needed_cmds = ['status', 'stats', 'add', 'find',
                    'search', 'currentsong', 'ping']
-    needed_mbid_tags = {'Artist', 'Album', 'AlbumArtist',
-                        'Title', 'Track', 'Genre',
-                        'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+    needed_tags = {'Artist', 'Album', 'AlbumArtist', 'Title', 'Track'}
+    needed_mbid_tags = {'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
                         'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
+    MPD_supported_tags = {'Artist', 'ArtistSort', 'Album', 'AlbumSort', 'AlbumArtist',
+                          'AlbumArtistSort', 'Title', 'Track', 'Name', 'Genre',
+                          'Date', 'OriginalDate', 'Composer', 'Performer',
+                          'Conductor', 'Work', 'Grouping', 'Disc', 'Label',
+                          'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+                          'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID',
+                          'MUSICBRAINZ_RELEASETRACKID', 'MUSICBRAINZ_WORKID'}
     database = None
 
     def __init__(self, daemon):
@@ -181,10 +187,18 @@ class MPD(MPDClient):
                 raise PlayerError('Could connect to "%s", '
                                   'but command "%s" not available' %
                                   (host, cmd))
-        # Controls use of MusicBrainzIdentifier
         self.tagtypes('clear')
+        for tag in MPD.needed_tags:
+            self.tagtypes('enable', tag)
+        tt = 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)
+            self.log.warning('Tags needed: %s', needed_tags)
+            raise PlayerError('Missing mandatory metadata!')
         for tag in MPD.needed_mbid_tags:
             self.tagtypes('enable', tag)
+        # Controls use of MusicBrainzIdentifier
         if self.daemon.config.get('sima', 'musicbrainzid'):
             tt = set(self.tagtypes())
             if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
@@ -206,15 +220,20 @@ class MPD(MPDClient):
     def _reset_cache(self):
         """
         Both flushes and instantiates _cache
+
+        * artists: all artists
+        * nombid_artists: artists with no mbid (set only when self.use_mbid is True)
+        * artist_tracks: caching last artist tracks, used in search_track
         """
         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()}
+                       'nombid_artists': frozenset(),
+                       'artist_tracks': {}}
         self._cache['artists'] = frozenset(filter(None, self.list('artist')))
-        if Artist.use_mbid:
+        if self.use_mbid:
             artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
             self._cache['nombid_artists'] = frozenset(filter(None, artists))
 
@@ -226,8 +245,7 @@ class MPD(MPDClient):
         return self.current.id != previous.id  # pylint: disable=no-member
 
     def monitor(self):
-        """OLD socket Idler
-        Monitor player for change
+        """Monitor player for change
         Returns a list a events among:
 
             * database  player media library has changed
@@ -256,7 +274,10 @@ class MPD(MPDClient):
             self.log.warning('pending commands: %s', self._pending)
 
     def add(self, payload):
-        """Overriding MPD's add method to accept Track objects"""
+        """Overriding MPD's add method to accept Track objects
+
+        :param Track,list payload: Either a single :py:obj:`Track` or a list of it
+        """
         if isinstance(payload, Track):
             super().__getattr__('add')(payload.file)
         elif isinstance(payload, list):
@@ -322,7 +343,7 @@ class MPD(MPDClient):
         tracks = set()
         if artist.mbid:
             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
-        for name in artist.names_sz:
+        for name in artist.names:
             tracks |= set(self.find('artist', name))
         return list(tracks)
 
@@ -367,10 +388,13 @@ class MPD(MPDClient):
                 self.log.trace('Found mbid "%r" in library', artist)
                 # library could fetch several artist name for a single MUSICBRAINZ_ARTISTID
                 if len(library) > 1:
-                    self.log.warning('I got "%s" searching for %r', library, artist)
+                    self.log.debug('I got "%s" searching for %r', library, artist)
                 elif len(library) == 1 and library[0] != artist.name:
-                    self.log.debug('Update artist name %s->%s', artist, library[0])
+                    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
@@ -379,8 +403,9 @@ class MPD(MPDClient):
         if not match and not found:
             return None
         if len(match) > 1:
-            self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
-        # Forst lowercased comparison
+            self.log.debug('found close match for "%s": %s',
+                           artist, '/'.join(match))
+        # First lowercased comparison
         for close_art in match:
             # Regular lowered string comparison
             if artist.name.lower() == close_art.lower():
@@ -403,11 +428,11 @@ class MPD(MPDClient):
             if SimaStr(artist.name) == fuzz:
                 found = True
                 artist.add_alias(fuzz)
-                self.log.info('"%s" quite probably matches "%s" (SimaStr)',
-                              fuzz, artist)
+                self.log.debug('"%s" quite probably matches "%s" (SimaStr)',
+                               fuzz, artist)
         if found:
             if artist.aliases:
-                self.log.debug('Found aliases: %s', '/'.join(artist.names))
+                self.log.info('Found aliases: %s', '/'.join(artist.names))
             return artist
         return None
 
@@ -415,8 +440,12 @@ class MPD(MPDClient):
     def search_track(self, artist, title):
         """Fuzzy search of title by an artist
         """
+        cache = self._cache.get('artist_tracks').get(artist)
         # Retrieve all tracks from artist
-        all_tracks = self.find_tracks(artist)
+        all_tracks = cache or self.find_tracks(artist)
+        if not cache:
+            self._cache['artist_tracks'] = {}  # clean up
+            self._cache.get('artist_tracks')[artist] = all_tracks
         # 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])
@@ -448,13 +477,14 @@ class MPD(MPDClient):
           looking for albums for Artist_B returns wrongly this album.
         """
         # First, look for all potential albums
-        self.log.debug('Searching album for "%s"', artist)
+        self.log.debug('Searching album for "%r"', artist)
         if artist.aliases:
             self.log.debug('Searching album for %s aliases: "%s"',
                            artist, artist.aliases)
         for name_sz in artist.names_sz:
-            raw_albums = self.list('album', f"( albumartist == '{name_sz}')")
-            albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums if a]
+            mpd_filter = f"((albumartist == '{name_sz}') AND ( album != ''))"
+            raw_albums = self.list('album', mpd_filter)
+            albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums]
         candidates = []
         for album in albums:
             album_trks = self.find_tracks(album)