# -*- Mode: Python; test-case-name: morituri.test.test_common_mbngs -*- # vi:si:et:sw=4:sts=4:ts=4 # Morituri - for those about to RIP # Copyright (C) 2009, 2010, 2011 Thomas Vander Stichele # This file is part of morituri. # # morituri 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. # # morituri 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 morituri. If not, see . """ Handles communication with the musicbrainz server using NGS. """ import urllib2 from morituri.common import log VA_ID = "89ad4ac3-39f7-470e-963a-56509c546377" # Various Artists class MusicBrainzException(Exception): def __init__(self, exc): self.args = (exc, ) self.exception = exc class NotFoundException(MusicBrainzException): def __str__(self): return "Disc not found in MusicBrainz" class TrackMetadata(object): artist = None title = None duration = None # in ms mbid = None sortName = None mbidArtist = None class DiscMetadata(object): """ @param artist: artist(s) name @param sortName: album artist sort name @param release: earliest release date, in YYYY-MM-DD @type release: unicode @param title: title of the disc (with disambiguation) @param releaseTitle: title of the release (without disambiguation) @type tracks: C{list} of L{TrackMetadata} """ artist = None sortName = None title = None various = False tracks = None release = None releaseTitle = None releaseType = None mbid = None mbidArtist = None url = None catalogNumber = None barcode = None def __init__(self): self.tracks = [] def _record(record, which, name, what): # optionally record to disc as a JSON serialization if record: import json filename = 'morituri.%s.%s.json' % (which, name) handle = open(filename, 'w') handle.write(json.dumps(what)) handle.close() log.info('mbngs', 'Wrote %s %s to %s', which, name, filename) # credit is of the form [dict, str, dict, ... ] # e.g. [ # {'artist': { # 'sort-name': 'Sukilove', # 'id': '5f4af6cf-a1b8-4e51-a811-befed399a1c6', # 'name': 'Sukilove' # }}, ' & ', { # 'artist': { # 'sort-name': 'Blackie and the Oohoos', # 'id': '028a9dc7-f5ef-43c2-866b-08d69ffff363', # 'name': 'Blackie & the Oohoos'}}] # or # [{'artist': # {'sort-name': 'Pixies', # 'id': 'b6b2bb8d-54a9-491f-9607-7b546023b433', 'name': 'Pixies'}}] class _Credit(list): """ I am a representation of an artist-credit in musicbrainz for a disc or track. """ def joiner(self, attributeGetter, joinString=None): res = [] for item in self: if isinstance(item, dict): res.append(attributeGetter(item)) else: if not joinString: res.append(item) else: res.append(joinString) return "".join(res) def getSortName(self): return self.joiner(lambda i: i.get('artist').get('sort-name', None)) def getName(self): return self.joiner(lambda i: i.get('artist').get('name', None)) def getIds(self): return self.joiner(lambda i: i.get('artist').get('id', None), joinString=";") def _getMetadata(releaseShort, release, discid, country=None): """ @type release: C{dict} @param release: a release dict as returned in the value for key release from get_release_by_id @rtype: L{DiscMetadata} or None """ log.debug('program', 'getMetadata for release id %r', release['id']) if not release['id']: log.warning('program', 'No id for release %r', release) return None assert release['id'], 'Release does not have an id' if 'country' in release and country and release['country'] != country: log.warning('program', '%r was not released in %r', release, country) return None discMD = DiscMetadata() discMD.releaseType = releaseShort.get('release-group', {}).get('type') discCredit = _Credit(release['artist-credit']) # FIXME: is there a better way to check for VA ? discMD.various = False if discCredit[0]['artist']['id'] == VA_ID: discMD.various = True if len(discCredit) > 1: log.debug('mbngs', 'artist-credit more than 1: %r', discCredit) albumArtistName = discCredit.getName() # getUniqueName gets disambiguating names like Muse (UK rock band) discMD.artist = albumArtistName discMD.sortName = discCredit.getSortName() # FIXME: is format str ? if not 'date' in release: log.warning('mbngs', 'Release %r does not have date', release) else: discMD.release = release['date'] discMD.mbid = release['id'] discMD.mbidArtist = discCredit.getIds() discMD.url = 'https://musicbrainz.org/release/' + release['id'] discMD.barcode = release.get('barcode', None) lil = release.get('label-info-list', [{}]) if lil: discMD.catalogNumber = lil[0].get('catalog-number') tainted = False duration = 0 # only show discs from medium-list->disc-list with matching discid for medium in release['medium-list']: for disc in medium['disc-list']: if disc['id'] == discid: title = release['title'] discMD.releaseTitle = title if 'disambiguation' in release: title += " (%s)" % release['disambiguation'] count = len(release['medium-list']) if count > 1: title += ' (Disc %d of %d)' % ( int(medium['position']), count) if 'title' in medium: title += ": %s" % medium['title'] discMD.title = title for t in medium['track-list']: track = TrackMetadata() trackCredit = _Credit(t['recording']['artist-credit']) if len(trackCredit) > 1: log.debug('mbngs', 'artist-credit more than 1: %r', trackCredit) # FIXME: leftover comment, need an example # various artists discs can have tracks with no artist track.artist = trackCredit.getName() track.sortName = trackCredit.getSortName() track.mbidArtist = trackCredit.getIds() track.title = t['recording']['title'] track.mbid = t['recording']['id'] # FIXME: unit of duration ? track.duration = int(t['recording'].get('length', 0)) if not track.duration: log.warning('getMetadata', 'track %r (%r) does not have duration' % ( track.title, track.mbid)) tainted = True else: duration += track.duration discMD.tracks.append(track) if not tainted: discMD.duration = duration else: discMD.duration = 0 return discMD # see http://bugs.musicbrainz.org/browser/python-musicbrainz2/trunk/examples/ # ripper.py def musicbrainz(discid, country=None, record=False): """ Based on a MusicBrainz disc id, get a list of DiscMetadata objects for the given disc id. Example disc id: Mj48G109whzEmAbPBoGvd4KyCS4- @type discid: str @rtype: list of L{DiscMetadata} """ log.debug('musicbrainzngs', 'looking up results for discid %r', discid) import musicbrainzngs ret = [] try: result = musicbrainzngs.get_releases_by_discid(discid, includes=["artists", "recordings", "release-groups"]) except musicbrainzngs.ResponseError, e: if isinstance(e.cause, urllib2.HTTPError): if e.cause.code == 404: raise NotFoundException(e) else: log.debug('musicbrainzngs', 'received bad response from the server') raise MusicBrainzException(e) # The result can either be a "disc" or a "cdstub" if result.get('disc'): log.debug('musicbrainzngs', 'found %d releases for discid %r', len(result['disc']['release-list']), discid) _record(record, 'releases', discid, result) # Display the returned results to the user. import json for release in result['disc']['release-list']: formatted = json.dumps(release, sort_keys=False, indent=4) log.debug('program', 'result %s: artist %r, title %r' % ( formatted, release['artist-credit-phrase'], release['title'])) # to get titles of recordings, we need to query the release with # artist-credits res = musicbrainzngs.get_release_by_id( release['id'], includes=["artists", "artist-credits", "recordings", "discids", "labels"]) _record(record, 'release', release['id'], res) releaseDetail = res['release'] formatted = json.dumps(releaseDetail, sort_keys=False, indent=4) log.debug('program', 'release %s' % formatted) md = _getMetadata(release, releaseDetail, discid, country) if md: log.debug('program', 'duration %r', md.duration) ret.append(md) return ret elif result.get('cdstub'): log.debug('musicbrainzngs', 'query returned cdstub: ignored') return None else: return None