1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2013, 2014 Jack Kaliko <kaliko@azylum.org>
4 # This file is part of sima
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.
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.
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/>.
20 """MPD client for Sima
22 This client is built above python-musicpd a fork of python-mpd
24 # pylint: disable=C0111
26 # standard library import
27 from difflib import get_close_matches
28 from select import select
30 # third parties components
32 from musicpd import (MPDClient, MPDError, CommandError)
33 except ImportError as err:
34 from sys import exit as sexit
35 print('ERROR: missing python-musicpd?\n{0}'.format(err))
39 from .lib.simastr import SimaStr
40 from .lib.player import Player, blacklist
41 from .lib.track import Track
42 from .lib.meta import Album, Artist
43 from .utils.leven import levenshtein_ratio
46 class PlayerError(Exception):
47 """Fatal error in poller."""
49 class PlayerCommandError(PlayerError):
52 PlayerUnHandledError = MPDError # pylint: disable=C0103
55 def wrapper(*args, **kwargs):
57 if not args[0].database:
58 return func(*args, **kwargs)
59 result = func(*args, **kwargs)
63 for art in result.names:
64 if cls.database.get_bl_artist(art, add_not=True):
65 cls.log.debug('Blacklisted "{0}"'.format(art))
70 resp = Artist(name=names.pop(), mbid=result.mbid)
77 class PlayerClient(Player):
81 _fetch_item single str
82 _fetch_object single dict
83 _fetch_list list of str
84 _fetch_playlist list of str
85 _fetch_changes list of dict
86 _fetch_database list of dict
87 _fetch_songs list of dict, especially tracks
89 TODO: handle exception in command not going through _client_wrapper() (ie.
92 database = None # sima database (history, blacklist)
94 def __init__(self, host="localhost", port="6600", password=None):
96 self._comm = self._args = None
97 self._mpd = host, port, password
98 self._client = MPDClient()
99 self._client.iterate = True
102 def __getattr__(self, attr):
104 wrapper = self._execute
105 return lambda *args: wrapper(command, args)
107 def _execute(self, command, args):
108 self._write_command(command, args)
109 return self._client_wrapper()
111 def _write_command(self, command, args=None):
115 self._args.append(arg)
117 def _client_wrapper(self):
118 func = self._client.__getattr__(self._comm)
120 ans = func(*self._args)
121 # WARNING: MPDError is an ancestor class of # CommandError
122 except CommandError as err:
123 raise PlayerCommandError('MPD command error: %s' % err)
124 except (MPDError, IOError) as err:
125 raise PlayerError(err)
126 return self._track_format(ans)
128 def _track_format(self, ans):
130 unicode_obj = ["idle", "listplaylist", "list", "sticker list",
131 "commands", "notcommands", "tagtypes", "urlhandlers",]
133 # TODO: ain't working for "sticker find" and "sticker list"
134 tracks_listing = ["playlistfind", "playlistid", "playlistinfo",
135 "playlistsearch", "plchanges", "listplaylistinfo", "find",
136 "search", "sticker find",]
137 track_obj = ['currentsong']
138 if self._comm in tracks_listing + track_obj:
139 # pylint: disable=w0142
140 if isinstance(ans, list):
141 return [Track(**track) for track in ans]
142 elif isinstance(ans, dict):
146 def __skipped_track(self, old_curr):
147 if (self.state == 'stop'
148 or not hasattr(old_curr, 'id')
149 or not hasattr(self.current, 'id')):
151 return self.current.id != old_curr.id # pylint: disable=no-member
153 def _flush_cache(self):
155 Both flushes and instantiates _cache
157 if isinstance(self._cache, dict):
158 self.log.info('Player: Flushing cache!')
160 self.log.info('Player: Initialising cache!')
163 'nombid_artists': None,
165 self._cache['artists'] = frozenset(self._client.list('artist'))
166 self._cache['nombid_artists'] = frozenset(self._client.list('artist', 'musicbrainz_artistid', ''))
168 @blacklist(track=True)
169 def find_track(self, artist, title=None):
171 for name in artist.names:
173 tracks |= set(self.find('artist', name, 'title', title))
175 tracks |= set(self.find('artist', name))
178 tracks |= set(self.find('musicbrainz_artistid', artist.mbid))
180 tracks |= set(self.find('musicbrainz_artistid', artist.mbid,
185 def search_artist(self, artist):
187 Search artists based on a fuzzy search in the media library
188 >>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
189 >>> bea = player.search_artist(art)
191 >>> ['The Beatles', 'Beatles', 'the beatles']
193 Returns an Artist object
197 # look for exact search w/ musicbrainz_artistid
198 [artist.add_alias(name) for name in
199 self._client.list('artist', 'musicbrainz_artistid', artist.mbid)]
203 artist = Artist(name=artist.name)
204 # then complete with fuzzy search on artist with no musicbrainz_artistid
205 nombid_artists = self._cache.get('nombid_artists', [])
206 match = get_close_matches(artist.name, nombid_artists, 50, 0.73)
207 if not match and not found:
210 self.log.debug('found close match for "%s": %s' %
211 (artist, '/'.join(match)))
212 # Does not perform fuzzy matching on short and single word strings
213 # Only lowercased comparison
214 if ' ' not in artist.name and len(artist.name) < 8:
215 for fuzz_art in match:
216 # Regular lowered string comparison
217 if artist.name.lower() == fuzz_art.lower():
218 artist.add_alias(fuzz_art)
220 fzartist = SimaStr(artist.name)
221 for fuzz_art in match:
222 # Regular lowered string comparison
223 if artist.name.lower() == fuzz_art.lower():
225 artist.add_alias(fuzz_art)
226 if artist.name != fuzz_art:
227 self.log.debug('"%s" matches "%s".' % (fuzz_art, artist))
229 # SimaStr string __eq__ (not regular string comparison here)
230 if fzartist == fuzz_art:
232 artist.add_alias(fuzz_art)
233 self.log.info('"%s" quite probably matches "%s" (SimaStr)' %
237 self.log.debug('Found: {}'.format('/'.join(list(artist.names)[:4])))
240 def fuzzy_find_track(self, artist, title):
241 # Retrieve all tracks from artist
242 all_tracks = self.find_track(artist, title)
243 # Get all titles (filter missing titles set to 'None')
244 all_artist_titles = frozenset([tr.title for tr in all_tracks
245 if tr.title is not None])
246 match = get_close_matches(title, all_artist_titles, 50, 0.78)
250 leven = levenshtein_ratio(title.lower(), title_.lower())
253 elif leven >= 0.79: # PARAM
254 self.log.debug('title: "%s" should match "%s" (lr=%1.3f)' %
255 (title_, title, leven))
257 self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)' %
258 (title_, title, leven))
260 return self.find('artist', artist, 'title', title_)
262 def find_album(self, artist, album):
264 Special wrapper around album search:
265 Album lookup is made through AlbumArtist/Album instead of Artist/Album
267 alb_art_search = self.find('albumartist', artist, 'album', album)
269 return alb_art_search
270 return self.find('artist', artist, 'album', album)
272 @blacklist(album=True)
273 def search_albums(self, artist):
275 Fetch all albums for "AlbumArtist" == artist
276 Filter albums returned for "artist" == artist since MPD returns any
277 album containing at least a single track for artist
280 for name in artist.names:
281 if len(artist.names) > 1:
282 self.log.debug('Searching album for aliase: "{}"'.format(name))
283 kwalbart = {'albumartist':name, 'artist':name}
284 for album in self.list('album', 'albumartist', artist):
285 if album and album not in albums:
286 albums.append(Album(name=album, **kwalbart))
287 for album in self.list('album', 'artist', artist):
288 album_trks = [trk for trk in self.find('album', album)]
289 if 'Various Artists' in [tr.albumartist for tr in album_trks]:
290 self.log.debug('Discarding {0} ("Various Artists" set)'.format(album))
292 arts = set([trk.artist for trk in album_trks])
293 if len(set(arts)) < 2: # TODO: better heuristic, use a ratio instead
294 if album not in albums:
295 albums.append(Album(name=album, albumartist=artist))
296 elif album and album not in albums:
297 self.log.debug('"{0}" probably not an album of "{1}"'.format(
298 album, artist) + '({0})'.format('/'.join(arts)))
304 self.send_idle('database', 'playlist', 'player', 'options')
305 select([self._client], [], [], 60)
306 ret = self.fetch_idle()
307 if self.__skipped_track(curr):
308 ret.append('skipped')
309 if 'database' in ret:
312 except (MPDError, IOError) as err:
313 raise PlayerError("Couldn't init idle: %s" % err)
316 """Clean blocking event (idle) and pending commands
318 if 'idle' in self._client._pending:
319 self._client.noidle()
320 elif self._client._pending:
321 self.log.warning('pending commands: {}'.format(self._client._pending))
323 def remove(self, position=0):
324 self.delete(position)
326 def add(self, track):
327 """Overriding MPD's add method to accept add signature with a Track
329 self._client.add(track.file)
333 return self._cache.get('artists')
337 return str(self.status().get('state'))
341 return self.currentsong()
347 return [trk for trk in plst if int(trk.pos) > int(self.current.pos)]
352 Override deprecated MPD playlist command
354 return self.playlistinfo()
357 host, port, password = self._mpd
360 self._client.connect(host, port)
362 # Catch socket errors
363 except IOError as err:
364 raise PlayerError('Could not connect to "%s:%s": %s' %
365 (host, port, err.strerror))
367 # Catch all other possible errors
368 # ConnectionError and ProtocolError are always fatal. Others may not
369 # be, but we don't know how to handle them here, so treat them as if
370 # they are instead of ignoring them.
371 except MPDError as err:
372 raise PlayerError('Could not connect to "%s:%s": %s' %
377 self._client.password(password)
379 # Catch errors with the password command (e.g., wrong password)
380 except CommandError as err:
381 raise PlayerError("Could not connect to '%s': "
382 "password command failed: %s" %
385 # Catch all other possible errors
386 except (MPDError, IOError) as err:
387 raise PlayerError("Could not connect to '%s': "
388 "error with password command: %s" %
390 # Controls we have sufficient rights
391 needed_cmds = ['status', 'stats', 'add', 'find', \
392 'search', 'currentsong', 'ping']
394 available_cmd = self._client.commands()
395 for nddcmd in needed_cmds:
396 if nddcmd not in available_cmd:
398 raise PlayerError('Could connect to "%s", '
399 'but command "%s" not available' %
402 # Controls use of MusicBrainzIdentifier
404 if 'MUSICBRAINZ_ARTISTID' not in self._client.tagtypes():
405 self.log.warning('Use of MusicBrainzIdentifier is set but MPD is '
406 'not providing related metadata')
407 self.log.info(self._client.tagtypes())
408 self.log.warning('Disabling MusicBrainzIdentifier')
409 Artist.use_mbid = False
411 self.log.warning('Use of MusicBrainzIdentifier disabled!')
412 self.log.info('Consider using MusicBrainzIdentifier for your music library')
415 def disconnect(self):
416 # Try to tell MPD we're closing the connection first
418 self._client.noidle()
420 # If that fails, don't worry, just ignore it and disconnect
421 except (MPDError, IOError):
424 self._client.disconnect()
425 # Disconnecting failed, so use a new client object instead
426 # This should never happen. If it does, something is seriously broken,
427 # and the client object shouldn't be trusted to be re-used.
428 except (MPDError, IOError):
429 self._client = MPDClient()
432 # vim: ai ts=4 sw=4 sts=4 expandtab