Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change artwork lookup to fanart.tv #3213

Closed
wants to merge 16 commits into from
Closed

Change artwork lookup to fanart.tv #3213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
dc22bb0
Hotfix index creation from develop
AdeHub Jan 8, 2019
8ad8487
redacted - add album type to search filter
nopoz Jun 9, 2019
fd83934
clean up whitespace
nopoz Jun 9, 2019
b0585e8
redacted and orpheus sort results by seeders
nopoz Jun 9, 2019
028b851
Merge pull request #1 from doucheymcdoucherson/seeder_sort
nopoz Jun 9, 2019
8c84edc
Merge pull request #2 from doucheymcdoucherson/redacted
nopoz Jun 9, 2019
3d626be
add config option for last.fm api key and musicbrainz useragent
nopoz Jun 10, 2019
8ba3f10
Merge pull request #3 from doucheymcdoucherson/useragent
nopoz Jun 10, 2019
033f52a
extra newline fix
nopoz Jun 10, 2019
0d87b52
add debug logging for musicbrainz
nopoz Jun 10, 2019
c5a42f9
Merge pull request #4 from doucheymcdoucherson/useragent
nopoz Jun 10, 2019
5820ca1
make if statement safer
nopoz Jun 10, 2019
03b1c86
minor typo fix
nopoz Jun 10, 2019
1255569
Merge pull request #5 from doucheymcdoucherson/seeder_sort
nopoz Jun 10, 2019
d3e4d5e
change artwork lookup to fanart.tv
nopoz Jun 13, 2019
890632c
Merge branch 'master' into artwork
nopoz Jun 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions data/interfaces/default/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ <h1 class="clearfix"><i class="fa fa-gear"></i> Settings</h1>
<div class="row">
<label>QBitTorrent Label</label>
<input type="text" name="qbittorrent_label" value="${config['qbittorrent_label']}" size="30">
</div>
</div>
</fieldset>
<fieldset id="deluge_options">
<div class="row">
Expand Down Expand Up @@ -1722,6 +1722,23 @@ <h1 class="clearfix"><i class="fa fa-gear"></i> Settings</h1>
<a href="https://headphones.codeshy.com/vip" id="vipserver" target="_blank">Get an Account!</a>
</div>
</div>

<div id="mbuseragent_options">
<div class="row">
<a target="_blank" href="https://musicbrainz.org/doc/XML_Web_Service/Rate_Limiting"><label>Musicbrainz Useragent</label></a>
<input type="text" name="musicbrainz_useragent" value="${config['musicbrainz_useragent']}" size="40" title="Custom user-agent should be in the format:&#013;Application name/<version> ( contact-email )&#013;&#013;Example:&#013;MyAwesomeTagger/1.2.0 ( me@example.com )">
</div>
</div>
</fieldset>

<fieldset>
<legend>Lastfm</legend>
<div id="lastfm_options">
<div class="row">
<a target="_blank" href="https://www.last.fm/api"><label>Last.fm API Key</label></a>
<input type="text" name="lastfm_personal_key" value="${config['lastfm_personal_key']}" size="40" title="Custom Last.fm API key. If left blank, the default key that comes with Headphones is used.">
</div>
</div>
</fieldset>

</td>
Expand Down Expand Up @@ -2456,7 +2473,7 @@ <h1 class="clearfix"><i class="fa fa-gear"></i> Settings</h1>
if ($("#torrent_downloader_qbittorrent").is(":checked"))
{
$("#torrent_blackhole_options,#transmission_options,#utorrent_options,#deluge_options").fadeOut("fast", function() { $("#qbittorrent_options").fadeIn() });
}
}
if ($("#torrent_downloader_deluge").is(":checked"))
{
$("#torrent_blackhole_options,#utorrent_options,#transmission_options,#qbittorrent_options").fadeOut("fast", function() { $("#deluge_options").fadeIn() });
Expand Down
2 changes: 1 addition & 1 deletion data/interfaces/default/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"aTargets": [0],
"mData":"ArtistID",
"mRender": function ( data, type, full ) {
return '<div id="artistImg"><img class="albumArt" alt="" id="'+ data + '" data-src="artwork/thumbs/artist/' + data + '"/></div>';
return '<div id="artistImg"><img class="albumArt" height="50" width="50" alt="" id="'+ data + '" data-src="artwork/thumbs/artist/' + data + '"/></div>';
}
},
{
Expand Down
145 changes: 93 additions & 52 deletions headphones/cache.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@
import os

import headphones
from headphones import db, helpers, logger, lastfm, request, mb
from headphones import db, helpers, logger, lastfm, request, mb, os
from fanart.music import Artist

LASTFM_API_KEY = "690e1ed3bc00bc91804cd8f7fe5ed6d4"
os.environ.setdefault('FANART_APIKEY', '1f081b32bcd780219f4e6d519f78e37e')

if headphones.CONFIG.LASTFM_PERSONAL_KEY:
LASTFM_API_KEY = headphones.CONFIG.LASTFM_PERSONAL_KEY
else:
LASTFM_API_KEY = "690e1ed3bc00bc91804cd8f7fe5ed6d4"

class Cache(object):
"""
Expand Down Expand Up @@ -106,22 +111,6 @@ def _is_current(self, filename=None, date=None):
else:
return False

def _get_thumb_url(self, data):

thumb_url = None

try:
images = data[self.id_type]['image']
except KeyError:
return None

for image in images:
if image['size'] == 'medium' and '#text' in image:
thumb_url = image['#text']
break

return thumb_url

def get_artwork_from_cache(self, ArtistID=None, AlbumID=None):
"""
Pass a musicbrainz id to this function (either ArtistID or AlbumID)
Expand All @@ -139,7 +128,7 @@ def get_artwork_from_cache(self, ArtistID=None, AlbumID=None):
if self._exists('artwork') and self._is_current(filename=self.artwork_files[0]):
return self.artwork_files[0]
else:
self._update_cache()
self._update_cache(ArtistID, AlbumID)
# If we failed to get artwork, either return the url or the older file
if self.artwork_errors and self.artwork_url:
return self.artwork_url
Expand All @@ -165,7 +154,7 @@ def get_thumb_from_cache(self, ArtistID=None, AlbumID=None):
if self._exists('thumb') and self._is_current(filename=self.thumb_files[0]):
return self.thumb_files[0]
else:
self._update_cache()
self._update_cache(ArtistID, AlbumID)
# If we failed to get artwork, either return the url or the older file
if self.thumb_errors and self.thumb_url:
return self.thumb_url
Expand Down Expand Up @@ -195,7 +184,7 @@ def get_info_from_cache(self, ArtistID=None, AlbumID=None):
if not db_info or not db_info['LastUpdated'] or not self._is_current(
date=db_info['LastUpdated']):

self._update_cache()
self._update_cache(ArtistID, AlbumID)
info_dict = {'Summary': self.info_summary, 'Content': self.info_content}
return info_dict

Expand All @@ -211,39 +200,62 @@ def get_image_links(self, ArtistID=None, AlbumID=None):
if ArtistID:

self.id_type = 'artist'
data = lastfm.request_lastfm("artist.getinfo", mbid=ArtistID, api_key=LASTFM_API_KEY)
data = Artist.get(id=ArtistID)
logger.debug('Fanart.tv ArtistID: %s', ArtistID)

if not data:
logger.debug('Fanart.tv ArtistID not found!')
return

try:
image_url = data['artist']['image'][-1]['#text']
for thumbs in data.thumbs[0:1]:
url = str(thumbs.url)
thumb_url = url.replace('fanart/', 'preview/')
image_url = thumb_url
logger.debug('Fanart.tv artist url: %s', image_url)
logger.debug('Fanart.tv artist thumb url: %s', thumb_url)
except (KeyError, IndexError):
logger.debug('No artist image found')
logger.debug('Fanart.tv: No artist image found')
image_url = None
thumb_url = None

thumb_url = self._get_thumb_url(data)
if not thumb_url:
logger.debug('No artist thumbnail image found')
logger.debug('Fanart.tv: No artist thumbnail image found')

if not image_url:
logger.debug('Fanart.tv: No artist image found')

else:

self.id_type = 'album'
data = lastfm.request_lastfm("album.getinfo", mbid=AlbumID, api_key=LASTFM_API_KEY)
data = Artist.get(id="ArtistID")
logger.debug('Fanart.tv AlbumID: %s', AlbumID)
for x in data.albums:
if x.mbid == AlbumID:
album_url = str(x.covers[0])

if not data:
logger.debug('Fanart.tv: Album not found')
return

try:
image_url = data['album']['image'][-1]['#text']
for x in data.albums:
if x.mbid == AlbumID:
album_url = str(x.covers[0])
thumb_url = album_url.replace('fanart/', 'preview/')
image_url = thumb_url
logger.debug('Fanart.tv album url: %s', image_url)
logger.debug('Fanart.tv album thumb url: %s', thumb_url)
except (KeyError, IndexError):
logger.debug('No album image found on last.fm')
logger.debug('Fanart.tv: No album image found')
image_url = None

thumb_url = self._get_thumb_url(data)
thumb_url = None

if not thumb_url:
logger.debug('No album thumbnail image found on last.fm')
logger.debug('Fanart.tv no album thumbnail image found on fanart.tv')

if not image_url:
logger.debug('Fanart.tv no album image found on fanart.tv')

return {'artwork': image_url, 'thumbnail': thumb_url}

Expand Down Expand Up @@ -277,7 +289,7 @@ def remove_from_cache(self, ArtistID=None, AlbumID=None):
except Exception:
logger.warn('Error deleting file from the cache: %s', thumb_file)

def _update_cache(self):
def _update_cache(self, ArtistID, AlbumID):
"""
Since we call the same url for both info and artwork, we'll update both at the same time
"""
Expand All @@ -288,6 +300,28 @@ def _update_cache(self):
# Exception is when adding albums manually, then we should use release id
if self.id_type == 'artist':

data = Artist.get(id=self.id)

logger.debug('Fanart.tv ArtistID is: %s', self.id)

try:
for thumbs in data.thumbs[0:1]:
url = str(thumbs.url)
thumb_url = url.replace('fanart/', 'preview/')
image_url = thumb_url
logger.debug('Fanart.tv artist url: %s', image_url)
logger.debug('Fanart.tv artist thumb url: %s', thumb_url)
except KeyError:
logger.debug('Fanart.tv: No artist image found')
image_url = None
thumb_url = None

if not thumb_url:
logger.debug('Fanart.tv: No artist thumbnail image found')

if not image_url:
logger.debug('Fanart.tv: No artist image found')

data = lastfm.request_lastfm("artist.getinfo", mbid=self.id, api_key=LASTFM_API_KEY)

# Try with name if not found
Expand All @@ -311,17 +345,38 @@ def _update_cache(self):
except KeyError:
logger.debug('No artist bio found')
self.info_content = None

else:

# get ArtistID from AlbumID lookup - ArtistID not passed into this function otherwise
myDB = db.DBConnection()
ArtistID = myDB.action('SELECT ArtistID FROM albums WHERE ReleaseID=?', [self.id]).fetchone()[0]

#ALBUM SECTION
logger.debug('Fanart.tv AlbumID: %s', AlbumID)
logger.debug('Fanart.tv ArtistID: %s', ArtistID)

data = Artist.get(id=ArtistID)

try:
image_url = data['artist']['image'][-1]['#text']
for x in data.albums:
if x.mbid == AlbumID:
album_url = str(x.covers[0])
thumb_url = album_url.replace('fanart/', 'preview/')
image_url = thumb_url
logger.debug('Fanart.tv album url: %s', image_url)
logger.debug('Fanart.tv album thumb url: %s', thumb_url)
except KeyError:
logger.debug('No artist image found')
logger.debug('Fanart.tv: No album image link found')
image_url = None
thumb_url = None

thumb_url = self._get_thumb_url(data)
if not thumb_url:
logger.debug('No artist thumbnail image found')
logger.debug('Fanart.tv: No album thumbnail image found')

if not image_url:
logger.debug('Fanart.tv: No album image found')

else:
dbalbum = myDB.action(
'SELECT ArtistName, AlbumTitle, ReleaseID, Type FROM albums WHERE AlbumID=?',
[self.id]).fetchone()
Expand Down Expand Up @@ -362,16 +417,6 @@ def _update_cache(self):
except KeyError:
logger.debug('No album infomation found')
self.info_content = None
try:
image_url = data['album']['image'][-1]['#text']
except KeyError:
logger.debug('No album image link found')
image_url = None

thumb_url = self._get_thumb_url(data)

if not thumb_url:
logger.debug('No album thumbnail image found')

# Save the content & summary to the database no matter what if we've
# opened up the url
Expand Down Expand Up @@ -478,7 +523,6 @@ def _update_cache(self):
self.thumb_errors = True
self.thumb_url = image_url


def getArtwork(ArtistID=None, AlbumID=None):
c = Cache()
artwork_path = c.get_artwork_from_cache(ArtistID, AlbumID)
Expand All @@ -492,7 +536,6 @@ def getArtwork(ArtistID=None, AlbumID=None):
artwork_file = os.path.basename(artwork_path)
return "cache/artwork/" + artwork_file


def getThumb(ArtistID=None, AlbumID=None):
c = Cache()
artwork_path = c.get_thumb_from_cache(ArtistID, AlbumID)
Expand All @@ -506,14 +549,12 @@ def getThumb(ArtistID=None, AlbumID=None):
thumbnail_file = os.path.basename(artwork_path)
return "cache/artwork/" + thumbnail_file


def getInfo(ArtistID=None, AlbumID=None):
c = Cache()
info_dict = c.get_info_from_cache(ArtistID, AlbumID)

return info_dict


def getImageLinks(ArtistID=None, AlbumID=None):
c = Cache()
image_links = c.get_image_links(ArtistID, AlbumID)
Expand Down
4 changes: 3 additions & 1 deletion headphones/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,9 @@ def __repr__(self):
'XBMC_PASSWORD': (str, 'XBMC', ''),
'XBMC_UPDATE': (int, 'XBMC', 0),
'XBMC_USERNAME': (str, 'XBMC', ''),
'XLDPROFILE': (str, 'General', '')
'XLDPROFILE': (str, 'General', ''),
'MUSICBRAINZ_USERAGENT': (str, 'General', ''),
'LASTFM_PERSONAL_KEY': (str, 'General', '')
}


Expand Down
9 changes: 7 additions & 2 deletions headphones/lastfm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
# Required for API request limit
lastfm_lock = headphones.lock.TimedLock(REQUEST_LIMIT)


def request_lastfm(method, **kwargs):
"""
Call a Last.FM API method. Automatically sets the method and API key. Method
Expand All @@ -37,14 +36,20 @@ def request_lastfm(method, **kwargs):
By default, this method will request the JSON format, since it is more
lightweight than XML.
"""


if headphones.CONFIG.LASTFM_PERSONAL_KEY:
API_KEY = headphones.CONFIG.LASTFM_PERSONAL_KEY
else:
API_KEY = "395e6ec6bb557382fc41fde867bce66f"

# Prepare request
kwargs["method"] = method
kwargs.setdefault("api_key", API_KEY)
kwargs.setdefault("format", "json")

# Send request
logger.debug("Calling Last.FM method: %s", method)
logger.debug("Last.FM API Key is: %s" % API_KEY)
logger.debug("Last.FM call parameters: %s", kwargs)

data = request.request_json(ENTRY_POINT, timeout=TIMEOUT, params=kwargs, lock=lastfm_lock)
Expand Down
Loading