]> kaliko git repositories - mpd-sima.git/blob - mpdclient.py
23b263e1ee92b24460b097034b421b794f4a2be4
[mpd-sima.git] / mpdclient.py
1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2009-2021 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 # standard library import
20 from difflib import get_close_matches
21 from functools import wraps
22 from logging import getLogger
23 from select import select
24
25 # external module
26 from musicpd import MPDClient, MPDError as PlayerError
27
28
29 # local import
30 from .lib.meta import Meta, Artist, Album
31 from .lib.track import Track
32 from .lib.simastr import SimaStr
33 from .utils.leven import levenshtein_ratio
34
35
36 # Some decorators
37 def bl_artist(func):
38     def wrapper(*args, **kwargs):
39         cls = args[0]
40         if not cls.database:
41             return func(*args, **kwargs)
42         result = func(*args, **kwargs)
43         if not result:
44             return None
45         for art in result.names:
46             artist = Artist(name=art, mbid=result.mbid)
47             if cls.database.get_bl_artist(artist, add=False):
48                 cls.log.debug('Artist in blocklist: %s', artist)
49                 return None
50         return result
51     return wrapper
52
53
54 def set_artist_mbid(func):
55     def wrapper(*args, **kwargs):
56         cls = args[0]
57         result = func(*args, **kwargs)
58         if Meta.use_mbid:
59             if result and not result.mbid:
60                 mbid = cls._find_musicbrainz_artistid(result)
61                 artist = Artist(name=result.name, mbid=mbid)
62                 artist.add_alias(result)
63                 return artist
64         return result
65     return wrapper
66
67
68 def tracks_wrapper(func):
69     """Convert plain track mapping as returned by MPDClient into :py:obj:`sima.lib.track.Track`
70     objects. This decorator accepts single track or list of tracks as input.
71     """
72     @wraps(func)
73     def wrapper(*args, **kwargs):
74         ret = func(*args, **kwargs)
75         if isinstance(ret, dict):
76             return Track(**ret)
77         return [Track(**t) for t in ret]
78     return wrapper
79 # / decorators
80
81
82 class MPD(MPDClient):
83     """
84     Player instance inheriting from MPDClient (python-musicpd).
85
86     Some methods are overridden to format objects as :py:obj:`sima.lib.track.Track` for
87     instance, other are calling parent class directly through super().
88     cf. MPD.__getattr__
89
90     .. note::
91
92         * find methods are looking for exact match of the object provided
93           attributes in MPD music library
94         * search methods are looking for exact match + fuzzy match.
95     """
96     needed_cmds = ['status', 'stats', 'add', 'find',
97                    'search', 'currentsong', 'ping']
98     needed_tags = {'Artist', 'Album', 'AlbumArtist', 'Title', 'Track'}
99     needed_mbid_tags = {'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
100                         'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
101     MPD_supported_tags = {'Artist', 'ArtistSort', 'Album', 'AlbumSort', 'AlbumArtist',
102                           'AlbumArtistSort', 'Title', 'Track', 'Name', 'Genre',
103                           'Date', 'OriginalDate', 'Composer', 'Performer',
104                           'Conductor', 'Work', 'Grouping', 'Disc', 'Label',
105                           'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
106                           'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID',
107                           'MUSICBRAINZ_RELEASETRACKID', 'MUSICBRAINZ_WORKID'}
108     database = None
109
110     def __init__(self, config):
111         super().__init__()
112         self.socket_timeout = 10
113         self.use_mbid = True
114         self.log = getLogger('sima')
115         self.config = config
116         self._cache = None
117
118     # ######### Overriding MPDClient ###########
119     def __getattr__(self, cmd):
120         """Wrapper around MPDClient calls for abstract overriding"""
121         track_wrapped = {'currentsong', 'find', 'playlistinfo', }
122         try:
123             if cmd in track_wrapped:
124                 return tracks_wrapper(super().__getattr__(cmd))
125             return super().__getattr__(cmd)
126         except OSError as err:  # socket errors
127             raise PlayerError(err) from err
128
129     def disconnect(self):
130         """Overriding explicitly MPDClient.disconnect()"""
131         if self._sock:
132             super().disconnect()
133
134     def connect(self):
135         """Overriding explicitly MPDClient.connect()"""
136         mpd_config = self.config['MPD']
137         # host, port, password
138         host = mpd_config.get('host')
139         port = mpd_config.get('port')
140         password = mpd_config.get('password', fallback=None)
141         self.disconnect()
142         try:
143             super().connect(host, port)
144         # Catch socket errors
145         except OSError as err:
146             raise PlayerError(f'Could not connect to "{host}:{port}": {err.strerror}'
147                              ) from err
148         # Catch all other possible errors
149         # ConnectionError and ProtocolError are always fatal.  Others may not
150         # be, but we don't know how to handle them here, so treat them as if
151         # they are instead of ignoring them.
152         except MPDError as err:
153             raise PlayerError(f'Could not connect to "{host}:{port}": {err}') from err
154         if password:
155             try:
156                 self.password(password)
157             except OSError as err:
158                 raise PlayerError(f"Could not connect to '{host}': {err}") from err
159         # Controls we have sufficient rights
160         available_cmd = self.commands()
161         for cmd in MPD.needed_cmds:
162             if cmd not in available_cmd:
163                 self.disconnect()
164                 raise PlayerError(f'Could connect to "{host}", but command "{cmd}" not available')
165         self.tagtypes_clear()
166         for tag in MPD.needed_tags:
167             self.tagtypes_enable(tag)
168         ltt = set(map(str.lower, self.tagtypes()))
169         needed_tags = set(map(str.lower, MPD.needed_tags))
170         if len(needed_tags & ltt) != len(MPD.needed_tags):
171             self.log.warning('MPD exposes: %s', ltt)
172             self.log.warning('Tags needed: %s', needed_tags)
173             raise PlayerError('Missing mandatory metadata!')
174         for tag in MPD.needed_mbid_tags:
175             self.tagtypes_enable(tag)
176         # Controls use of MusicBrainzIdentifier
177         if self.config.getboolean('sima', 'musicbrainzid'):
178             ltt = set(self.tagtypes())
179             if len(MPD.needed_mbid_tags & ltt) != len(MPD.needed_mbid_tags):
180                 self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
181                                  'is not providing related metadata')
182                 self.log.info(ltt)
183                 self.log.warning('Disabling MusicBrainzIdentifier')
184                 self.use_mbid = Meta.use_mbid = False
185             else:
186                 self.log.debug('Available metadata: %s', ltt)
187                 self.use_mbid = Meta.use_mbid = True
188         else:
189             self.log.warning('Use of MusicBrainzIdentifier disabled!')
190             self.log.info('Consider using MusicBrainzIdentifier for your music library')
191             self.use_mbid = Meta.use_mbid = False
192         self._reset_cache()
193     # ######### / Overriding MPDClient #########
194
195     def _reset_cache(self):
196         """
197         Both flushes and instantiates _cache
198
199         * artists: all artists
200         * nombid_artists: artists with no mbid (set only when self.use_mbid is True)
201         * artist_tracks: caching last artist tracks, used in search_track
202         """
203         if isinstance(self._cache, dict):
204             self.log.info('Player: Flushing cache!')
205         else:
206             self.log.info('Player: Initialising cache!')
207         self._cache = {'artists': frozenset(),
208                        'nombid_artists': frozenset(),
209                        'artist_tracks': {}}
210         self._cache['artists'] = frozenset(filter(None, self.list('artist')))
211         if self.use_mbid:
212             artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
213             self._cache['nombid_artists'] = frozenset(filter(None, artists))
214
215     def _skipped_track(self, previous):
216         if (self.state == 'stop'
217                 or not hasattr(previous, 'id')
218                 or not hasattr(self.current, 'id')):
219             return False
220         return self.current.id != previous.id  # pylint: disable=no-member
221
222     def monitor(self):
223         """Monitor player for change
224         Returns a list a events among:
225
226             * database  player media library has changed
227             * playlist  playlist modified
228             * options   player options changed: repeat mode, etc…
229             * player    player state changed: paused, stopped, skip track…
230             * skipped   current track skipped
231         """
232         curr = self.current
233         select_timeout = 5
234         try:  # noidle cmd does not go through __getattr__, need to catch OSError then
235             while True:
236                 self.send_idle('database', 'playlist', 'player', 'options')
237                 _read, _, _ = select([self], [], [], select_timeout)
238                 if _read:  # tries to read response
239                     ret = self.fetch_idle()
240                     if self._skipped_track(curr):
241                         ret.append('skipped')
242                     if 'database' in ret:
243                         self._reset_cache()
244                     return ret
245                 #  Nothing to read, canceling idle
246                 self.noidle()
247         except OSError as err:
248             raise PlayerError(err) from err
249
250     def clean(self):
251         """Clean blocking event (idle) and pending commands
252         """
253         if 'idle' in self._pending:
254             self.noidle()
255         elif self._pending:
256             self.log.warning('pending commands: %s', self._pending)
257
258     def add(self, payload):
259         """Overriding MPD's add method to accept Track objects
260
261         :param Track,list payload: Either a single track or a list of it
262         """
263         if isinstance(payload, Track):
264             super().__getattr__('add')(payload.file)
265         elif isinstance(payload, list):
266             self.command_list_ok_begin()
267             map(self.add, payload)
268             self.command_list_end()
269         else:
270             self.log.error('Cannot add %s', payload)
271
272     # ######### Properties #####################
273     @property
274     def current(self):
275         return self.currentsong()
276
277     @property
278     def playlist(self):
279         """
280         Override deprecated MPD playlist command
281         """
282         return self.playlistinfo()
283
284     @property
285     def playmode(self):
286         plm = {'repeat': None, 'single': None,
287                'random': None, 'consume': None, }
288         for key, val in self.status().items():
289             if key in plm:
290                 plm.update({key: bool(int(val))})
291         return plm
292
293     @property
294     def queue(self):
295         plst = self.playlist
296         curr_position = int(self.current.pos)
297         plst.reverse()
298         return [trk for trk in plst if int(trk.pos) > curr_position]
299
300     @property
301     def state(self):
302         """Returns (play|stop|pause)"""
303         return str(self.status().get('state'))
304     # ######### / Properties ###################
305
306 # #### find_tracks ####
307     def find_tracks(self, what):
308         """Find tracks for a specific artist or album
309             >>> player.find_tracks(Artist('Nirvana'))
310             >>> player.find_tracks(Album('In Utero', artist=Artist('Nirvana'))
311
312         :param Artist,Album what: Artist or Album to fetch track from
313         :return: A list of track objects
314         :rtype: list(Track)
315         """
316         if isinstance(what, Artist):
317             return self._find_art(what)
318         if isinstance(what, Album):
319             return self._find_alb(what)
320         if isinstance(what, str):
321             return self.find_tracks(Artist(name=what))
322         raise PlayerError('Bad input argument')
323
324     def _find_art(self, artist):
325         tracks = set()
326         # artist blocklist
327         if self.database.get_bl_artist(artist, add=False):
328             self.log.info('Artist in blocklist: %s', artist)
329             return []
330         if artist.mbid:
331             tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
332         for name in artist.names:
333             tracks |= set(self.find('artist', name))
334         # album blocklist
335         albums = {Album(trk.Album.name, mbid=trk.musicbrainz_albumid)
336                   for trk in tracks}
337         bl_albums = {Album(a.get('album'), mbid=a.get('musicbrainz_album'))
338                      for a in self.database.view_bl() if a.get('album')}
339         if albums & bl_albums:
340             self.log.info('Albums in blocklist for %s: %s', artist, albums & bl_albums)
341             tracks = {trk for trk in tracks if trk.Album not in bl_albums}
342         # track blocklist
343         bl_tracks = {Track(title=t.get('title'), file=t.get('file'))
344                      for t in self.database.view_bl() if t.get('title')}
345         if tracks & bl_tracks:
346             self.log.info('Tracks in blocklist for %s: %s',
347                           artist, tracks & bl_tracks)
348             tracks = {trk for trk in tracks if trk not in bl_tracks}
349         return list(tracks)
350
351     def _find_alb(self, album):
352         if not hasattr(album, 'artist'):
353             raise PlayerError('Album object have no artist attribute')
354         if self.database.get_bl_album(album, add=False):
355             self.log.info('Album in blocklist: %s', album)
356             return []
357         albums = []
358         if album.mbid:
359             filt = f"(MUSICBRAINZ_ALBUMID == '{album.mbid}')"
360             albums = self.find(filt)
361         # Now look for album with no MusicBrainzIdentifier
362         if not albums and album.Artist.mbid:  # Use album artist MBID if possible
363             filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.Artist.mbid}') AND (album == '{album.name_sz}'))"
364             albums = self.find(filt)
365         if not albums:  # Falls back to (album)?artist/album name
366             for artist in album.Artist.names_sz:
367                 filt = f"((albumartist == '{artist}') AND (album == '{album.name_sz}'))"
368                 albums.extend(self.find(filt))
369         return albums
370 # #### / find_tracks ##
371
372 # #### Search Methods #####
373     def _find_musicbrainz_artistid(self, artist):
374         """Find MusicBrainzArtistID when possible.
375         """
376         if not self.use_mbid:
377             return None
378         mbids = None
379         for name in artist.names_sz:
380             filt = f'((artist == "{name}") AND (MUSICBRAINZ_ARTISTID != ""))'
381             mbids = self.list('MUSICBRAINZ_ARTISTID', filt)
382             if mbids:
383                 break
384         if not mbids:
385             return None
386         if len(mbids) > 1:
387             self.log.debug("Got multiple MBID for artist: %r", artist)
388             return None
389         if artist.mbid:
390             if artist.mbid != mbids[0]:
391                 self.log('MBID discrepancy, %s found with %s (instead of %s)',
392                          artist.name, mbids[0], artist.mbid)
393         else:
394             return mbids[0]
395         return None
396
397     @bl_artist
398     @set_artist_mbid
399     def search_artist(self, artist):
400         """
401         Search artists based on a fuzzy search in the media library
402             >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
403             >>> bea = player.search_artist(art)
404             >>> print(bea.names)
405             >>> ['The Beatles', 'Beatles', 'the beatles']
406
407         :param Artist artist: Artist to look for in MPD music library
408         :return: Artist object
409         :rtype: Artist
410         """
411         found = False
412         if artist.mbid:
413             # look for exact search w/ musicbrainz_artistid
414             library = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")
415             if library:
416                 found = True
417                 self.log.trace('Found mbid "%r" in library', artist)
418                 # library could fetch several artist name for a single MUSICBRAINZ_ARTISTID
419                 if len(library) > 1:
420                     self.log.debug('I got "%s" searching for %r', library, artist)
421                     for name in library:
422                         if SimaStr(artist.name) == name and name != artist.name:
423                             self.log.debug('add alias for %s: %s', artist, name)
424                             artist.add_alias(name)
425             # Fetches remaining artists for potential match
426             artists = self._cache['nombid_artists']
427         else:  # not using MusicBrainzIDs
428             artists = self._cache['artists']
429         match = get_close_matches(artist.name, artists, 50, 0.73)
430         if not match and not found:
431             return None
432         if len(match) > 1:
433             self.log.debug('found close match for "%s": %s',
434                            artist, '/'.join(match))
435         # First lowercased comparison
436         for close_art in match:
437             # Regular lowered string comparison
438             if artist.name.lower() == close_art.lower():
439                 artist.add_alias(close_art)
440                 found = True
441                 if artist.name != close_art:
442                     self.log.debug('"%s" matches "%s".', close_art, artist)
443         # Does not perform fuzzy matching on short and single word strings
444         # Only lowercased comparison
445         if ' ' not in artist.name and len(artist.name) < 8:
446             self.log.trace('no fuzzy matching for %r', artist)
447             if found:
448                 return artist
449             return None
450         # Now perform fuzzy search
451         for fuzz in match:
452             if fuzz in artist.names:  # Already found in lower cased comparison
453                 continue
454             # SimaStr string __eq__ (not regular string comparison here)
455             if SimaStr(artist.name) == fuzz:
456                 found = True
457                 artist.add_alias(fuzz)
458                 self.log.debug('"%s" quite probably matches "%s" (SimaStr)',
459                                fuzz, artist)
460         if found:
461             if artist.aliases:
462                 self.log.info('Found aliases: %s', '/'.join(artist.names))
463             return artist
464         return None
465
466     def search_track(self, artist, title):
467         """Fuzzy search of title by an artist
468         """
469         cache = self._cache.get('artist_tracks').get(artist)
470         # Retrieve all tracks from artist
471         all_tracks = cache or self.find_tracks(artist)
472         if not cache:
473             self._cache['artist_tracks'] = {}  # clean up
474             self._cache.get('artist_tracks')[artist] = all_tracks
475         # Get all titles (filter missing titles set to 'None')
476         all_artist_titles = frozenset([tr.title for tr in all_tracks
477                                        if tr.title is not None])
478         match = get_close_matches(title, all_artist_titles, 50, 0.78)
479         tracks = []
480         if not match:
481             return []
482         for mtitle in match:
483             leven = levenshtein_ratio(title, mtitle)
484             if leven == 1:
485                 tracks.extend([t for t in all_tracks if t.title == mtitle])
486             elif leven >= 0.77:
487                 self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
488                                mtitle, title, leven)
489                 tracks.extend([t for t in all_tracks if t.title == mtitle])
490             else:
491                 self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
492                                mtitle, title, leven)
493         return tracks
494
495     def search_albums(self, artist):
496         """Find potential albums for "artist"
497
498         * Fetch all albums for "AlbumArtist" == artist
499           → falls back to "Artist" == artist when no "AlbumArtist" tag is set
500         * Tries to filter some mutli-artists album
501           For instance an album by Artist_A may have a track by Artist_B. Then
502           looking for albums for Artist_B wrongly returns this album.
503         """
504         # First, look for all potential albums
505         self.log.debug('Searching album for "%r"', artist)
506         if artist.aliases:
507             self.log.debug('Searching album for %s aliases: "%s"',
508                            artist, artist.aliases)
509         albums = set()
510         if self.use_mbid and artist.mbid:
511             mpd_filter = f"((musicbrainz_albumartistid == '{artist.mbid}') AND ( album != ''))"
512             raw_album_id = self.list('musicbrainz_albumid', mpd_filter)
513             for albumid in raw_album_id:
514                 mpd_filter = f"((musicbrainz_albumid == '{albumid}') AND ( album != ''))"
515                 album_name = self.list('album', mpd_filter)
516                 if not album_name:  # something odd here
517                     continue
518                 albums.add(Album(album_name[0], artist=artist.name,
519                                  Artist=artist, mbid=albumid))
520         for name_sz in artist.names_sz:
521             mpd_filter = f"((albumartist == '{name_sz}') AND ( album != ''))"
522             raw_albums = self.list('album', mpd_filter)
523             for alb in raw_albums:
524                 if alb in [a.name for a in albums]:
525                     continue
526                 mbid = None
527                 if self.use_mbid:
528                     _ = Album(alb)
529                     mpd_filter = f"((albumartist == '{artist.name_sz}') AND ( album == '{_.name_sz}'))"
530                     mbids = self.list('MUSICBRAINZ_ALBUMID', mpd_filter)
531                     if mbids:
532                         mbid = mbids[0]
533                 albums.add(Album(alb, artist=artist.name,
534                                  Artist=artist, mbid=mbid))
535         candidates = []
536         for album in albums:
537             album_trks = self.find_tracks(album)
538             if not album_trks:  # find_track result can be empty, blocklist applied
539                 continue
540             album_artists = {tr.albumartist for tr in album_trks if tr.albumartist}
541             if album.Artist.names & album_artists:
542                 candidates.append(album)
543                 continue
544             if self.use_mbid and artist.mbid:
545                 if artist.mbid == album_trks[0].musicbrainz_albumartistid:
546                     candidates.append(album)
547                     continue
548                 self.log.debug('Discarding "%s", "%r" not set as musicbrainz_albumartistid',
549                                album, album.Artist)
550                 continue
551             if 'Various Artists' in album_artists:
552                 self.log.debug('Discarding %s ("Various Artists" set)', album)
553                 continue
554             if album_artists and album.Artist.name not in album_artists:
555                 self.log.debug('Discarding "%s", "%s" not set as albumartist', album, album.Artist)
556                 continue
557             # Attempt to detect false positive (especially when no
558             # AlbumArtist/MBIDs tag ar set)
559             # Avoid selecting albums where artist is credited for a single
560             # track of the album
561             album_trks = self.find(f"(album == '{album.name_sz}')")
562             arts = [trk.artist for trk in album_trks]  # Artists in the album
563             # count artist occurences
564             ratio = arts.count(album.Artist.name)/len(arts)
565             if ratio >= 0.8:
566                 candidates.append(album)
567             else:
568                 self.log.debug('"%s" probably not an album of "%s" (ratio=%.2f)',
569                                album, artist, ratio)
570             continue
571         return candidates
572 # #### / Search Methods ###
573
574 # VIM MODLINE
575 # vim: ai ts=4 sw=4 sts=4 expandtab