469 lines
18 KiB
Python
469 lines
18 KiB
Python
from couchpotato.core.event import addEvent
|
|
from couchpotato.core.helpers.encoding import simplifyString, toUnicode
|
|
from couchpotato.core.logger import CPLog
|
|
from couchpotato.core.providers.info.base import ShowProvider
|
|
from couchpotato.environment import Env
|
|
from tvdb_api import tvdb_api, tvdb_exceptions
|
|
from datetime import datetime
|
|
import traceback
|
|
import os
|
|
|
|
log = CPLog(__name__)
|
|
|
|
# TODO: Consider grabbing zips to put less strain on tvdb
|
|
# TODO: Unicode stuff (check)
|
|
# TODO: Notigy frontend on error (tvdb down at monent)
|
|
# TODO: Expose apikey in setting so it can be changed by user
|
|
|
|
class TheTVDb(ShowProvider):
|
|
|
|
def __init__(self):
|
|
addEvent('info.search', self.search, priority = 1)
|
|
addEvent('show.search', self.search, priority = 1)
|
|
addEvent('show.info', self.getShowInfo, priority = 1)
|
|
addEvent('season.info', self.getSeasonInfo, priority = 1)
|
|
addEvent('episode.info', self.getEpisodeInfo, priority = 1)
|
|
|
|
self.tvdb_api_parms = {
|
|
'apikey': self.conf('api_key'),
|
|
'banners': True,
|
|
'language': 'en',
|
|
'cache': os.path.join(Env.get('cache_dir'), 'thetvdb_api'),
|
|
}
|
|
self._setup()
|
|
|
|
def _setup(self):
|
|
self.tvdb = tvdb_api.Tvdb(**self.tvdb_api_parms)
|
|
self.valid_languages = self.tvdb.config['valid_languages']
|
|
|
|
def search(self, q, limit = 12, language = 'en'):
|
|
''' Find show by name
|
|
show = { 'id': 74713,
|
|
'language': 'en',
|
|
'lid': 7,
|
|
'seriesid': '74713',
|
|
'seriesname': u'Breaking Bad',}
|
|
'''
|
|
|
|
if self.isDisabled():
|
|
return False
|
|
|
|
if language != self.tvdb_api_parms['language'] and language in self.valid_languages:
|
|
self.tvdb_api_parms['language'] = language
|
|
self._setup()
|
|
|
|
search_string = simplifyString(q)
|
|
cache_key = 'thetvdb.cache.%s.%s' % (search_string, limit)
|
|
results = self.getCache(cache_key)
|
|
|
|
if not results:
|
|
log.debug('Searching for show: %s', q)
|
|
raw = None
|
|
try:
|
|
raw = self.tvdb.search(search_string)
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed searching TheTVDB for "%s": %s', (search_string, traceback.format_exc()))
|
|
return False
|
|
|
|
results = []
|
|
if raw:
|
|
try:
|
|
nr = 0
|
|
for show_info in raw:
|
|
show = self.tvdb[int(show_info['id'])]
|
|
results.append(self._parseShow(show))
|
|
nr += 1
|
|
if nr == limit:
|
|
break
|
|
log.info('Found: %s', [result['titles'][0] + ' (' + str(result.get('year', 0)) + ')' for result in results])
|
|
self.setCache(cache_key, results)
|
|
return results
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed parsing TheTVDB for "%s": %s', (show, traceback.format_exc()))
|
|
return False
|
|
return results
|
|
|
|
def getShow(self, identifier = None):
|
|
show = None
|
|
try:
|
|
log.debug('Getting show: %s', identifier)
|
|
show = self.tvdb[int(identifier)]
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed to getShowInfo for show id "%s": %s', (identifier, traceback.format_exc()))
|
|
return None
|
|
|
|
return show
|
|
|
|
def getShowInfo(self, identifier = None):
|
|
if not identifier:
|
|
return None
|
|
|
|
cache_key = 'thetvdb.cache.%s' % identifier
|
|
log.debug('Getting showInfo: %s', cache_key)
|
|
result = self.getCache(cache_key) or {}
|
|
if result:
|
|
return result
|
|
|
|
show = self.getShow(identifier = identifier)
|
|
if show:
|
|
result = self._parseShow(show)
|
|
self.setCache(cache_key, result)
|
|
|
|
return result
|
|
|
|
def getSeasonInfo(self, identifier = None, params = {}):
|
|
"""Either return a list of all seasons or a single season by number.
|
|
identifier is the show 'id'
|
|
"""
|
|
if not identifier:
|
|
return False
|
|
|
|
season_identifier = params.get('season_identifier', None)
|
|
|
|
# season_identifier must contain the 'show id : season number' since there is no tvdb id
|
|
# for season and we need a reference to both the show id and season number
|
|
if season_identifier:
|
|
try: season_identifier = int(season_identifier.split(':')[1])
|
|
except: return False
|
|
|
|
cache_key = 'thetvdb.cache.%s.%s' % (identifier, season_identifier)
|
|
log.debug('Getting SeasonInfo: %s', cache_key)
|
|
result = self.getCache(cache_key) or {}
|
|
if result:
|
|
return result
|
|
|
|
try:
|
|
show = self.tvdb[int(identifier)]
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed parsing TheTVDB SeasonInfo for "%s" id "%s": %s', (show, identifier, traceback.format_exc()))
|
|
return False
|
|
|
|
result = []
|
|
for number, season in show.items():
|
|
if season_identifier is not None and number == season_identifier:
|
|
result = self._parseSeason(show, (number, season))
|
|
self.setCache(cache_key, result)
|
|
return result
|
|
else:
|
|
result.append(self._parseSeason(show, (number, season)))
|
|
|
|
self.setCache(cache_key, result)
|
|
return result
|
|
|
|
def getEpisodeInfo(self, identifier = None, params = {}):
|
|
"""Either return a list of all episodes or a single episode.
|
|
If episode_identifer contains an episode number to search for
|
|
"""
|
|
season_identifier = params.get('season_identifier', None)
|
|
episode_identifier = params.get('episode_identifier', None)
|
|
|
|
if not identifier and season_identifier is None:
|
|
return False
|
|
|
|
# season_identifier must contain the 'show id : season number' since there is no tvdb id
|
|
# for season and we need a reference to both the show id and season number
|
|
if season_identifier:
|
|
try:
|
|
identifier, season_identifier = season_identifier.split(':')
|
|
season_identifier = int(season_identifier)
|
|
except: return None
|
|
|
|
cache_key = 'thetvdb.cache.%s.%s.%s' % (identifier, episode_identifier, season_identifier)
|
|
log.debug('Getting EpisodeInfo: %s', cache_key)
|
|
result = self.getCache(cache_key) or {}
|
|
if result:
|
|
return result
|
|
|
|
try:
|
|
show = self.tvdb[int(identifier)]
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed parsing TheTVDB EpisodeInfo for "%s" id "%s": %s', (show, identifier, traceback.format_exc()))
|
|
return False
|
|
|
|
result = []
|
|
for number, season in show.items():
|
|
if season_identifier is not None and number != season_identifier:
|
|
continue
|
|
|
|
for episode in season.values():
|
|
if episode_identifier is not None and episode['id'] == toUnicode(episode_identifier):
|
|
result = self._parseEpisode(show, episode)
|
|
self.setCache(cache_key, result)
|
|
return result
|
|
else:
|
|
result.append(self._parseEpisode(show, episode))
|
|
|
|
self.setCache(cache_key, result)
|
|
return result
|
|
|
|
def _parseShow(self, show):
|
|
"""
|
|
'actors': u'|Bryan Cranston|Aaron Paul|Dean Norris|RJ Mitte|Betsy Brandt|Anna Gunn|Laura Fraser|Jesse Plemons|Christopher Cousins|Steven Michael Quezada|Jonathan Banks|Giancarlo Esposito|Bob Odenkirk|',
|
|
'added': None,
|
|
'addedby': None,
|
|
'airs_dayofweek': u'Sunday',
|
|
'airs_time': u'9:00 PM',
|
|
'banner': u'http://thetvdb.com/banners/graphical/81189-g13.jpg',
|
|
'contentrating': u'TV-MA',
|
|
'fanart': u'http://thetvdb.com/banners/fanart/original/81189-28.jpg',
|
|
'firstaired': u'2008-01-20',
|
|
'genre': u'|Crime|Drama|Suspense|',
|
|
'id': u'81189',
|
|
'imdb_id': u'tt0903747',
|
|
'language': u'en',
|
|
'lastupdated': u'1376620212',
|
|
'network': u'AMC',
|
|
'networkid': None,
|
|
'overview': u"Walter White, a struggling high school chemistry teacher is diagnosed with advanced lung cancer. He turns to a life of crime, producing and selling methamphetamine accompanied by a former student, Jesse Pinkman with the aim of securing his family's financial future before he dies.",
|
|
'poster': u'http://thetvdb.com/banners/posters/81189-22.jpg',
|
|
'rating': u'9.3',
|
|
'ratingcount': u'473',
|
|
'runtime': u'60',
|
|
'seriesid': u'74713',
|
|
'seriesname': u'Breaking Bad',
|
|
'status': u'Continuing',
|
|
'zap2it_id': u'SH01009396'
|
|
"""
|
|
|
|
#
|
|
# NOTE: show object only allows direct access via
|
|
# show['id'], not show.get('id')
|
|
#
|
|
|
|
# TODO: Make sure we have a valid show id, not '' or None
|
|
#if len (show['id']) is 0:
|
|
# return None
|
|
|
|
## Images
|
|
poster = show['poster'] or None
|
|
backdrop = show['fanart'] or None
|
|
|
|
genres = [] if show['genre'] is None else show['genre'].strip('|').split('|')
|
|
if show['firstaired'] is not None:
|
|
try: year = datetime.strptime(show['firstaired'], '%Y-%m-%d').year
|
|
except: year = None
|
|
else:
|
|
year = None
|
|
|
|
try:
|
|
id = int(show['id'])
|
|
except:
|
|
id = None
|
|
|
|
show_data = {
|
|
'id': id,
|
|
'type': 'show',
|
|
'primary_provider': 'thetvdb',
|
|
'titles': [show['seriesname'] or u'', ],
|
|
'original_title': show['seriesname'] or u'',
|
|
'images': {
|
|
'poster': [poster] if poster else [],
|
|
'backdrop': [backdrop] if backdrop else [],
|
|
'poster_original': [],
|
|
'backdrop_original': [],
|
|
},
|
|
'year': year,
|
|
'genres': genres,
|
|
'imdb': show['imdb_id'] or None,
|
|
'zap2it_id': show['zap2it_id'] or None,
|
|
'seriesid': show['seriesid'] or None,
|
|
'network': show['network'] or None,
|
|
'networkid': show['networkid'] or None,
|
|
'airs_dayofweek': show['airs_dayofweek'] or None,
|
|
'airs_time': show['airs_time'] or None,
|
|
'firstaired': show['firstaired'] or None,
|
|
'released': show['firstaired'] or None,
|
|
'runtime': show['runtime'] or None,
|
|
'contentrating': show['contentrating'] or None,
|
|
'rating': show['rating'] or None,
|
|
'ratingcount': show['ratingcount'] or None,
|
|
'actors': show['actors'] or None,
|
|
'lastupdated': show['lastupdated'] or None,
|
|
'status': show['status'] or None,
|
|
'language': show['language'] or None,
|
|
}
|
|
|
|
show_data = dict((k, v) for k, v in show_data.iteritems() if v)
|
|
|
|
# Add alternative titles
|
|
try:
|
|
raw = self.tvdb.search(show['seriesname'])
|
|
if raw:
|
|
for show_info in raw:
|
|
if show_info['id'] == show_data['id'] and show_info.get('aliasnames', None):
|
|
for alt_name in show_info['aliasnames'].split('|'):
|
|
show_data['titles'].append(toUnicode(alt_name))
|
|
except (tvdb_exceptions.tvdb_error, IOError), e:
|
|
log.error('Failed searching TheTVDB for "%s": %s', (show['seriesname'], traceback.format_exc()))
|
|
|
|
return show_data
|
|
|
|
def _parseSeason(self, show, season_tuple):
|
|
"""
|
|
contains no data
|
|
"""
|
|
|
|
number, season = season_tuple
|
|
title = toUnicode('%s - Season %s' % (show['seriesname'] or u'', str(number)))
|
|
poster = []
|
|
try:
|
|
for id, data in show.data['_banners']['season']['season'].items():
|
|
if data.get('season', None) == str(number) and data['bannertype'] == 'season' and data['bannertype2'] == 'season':
|
|
poster.append(data.get('_bannerpath'))
|
|
break # Only really need one
|
|
except:
|
|
pass
|
|
|
|
try:
|
|
id = (show['id'] + ':' + str(number))
|
|
except:
|
|
id = None
|
|
|
|
# XXX: work on title; added defualt_title to fix an error
|
|
season_data = {
|
|
'id': id,
|
|
'type': 'season',
|
|
'primary_provider': 'thetvdb',
|
|
'titles': [title, ],
|
|
'original_title': title,
|
|
'via_thetvdb': True,
|
|
'parent_identifier': show['id'] or None,
|
|
'seasonnumber': str(number),
|
|
'images': {
|
|
'poster': poster,
|
|
'backdrop': [],
|
|
'poster_original': [],
|
|
'backdrop_original': [],
|
|
},
|
|
'year': None,
|
|
'genres': None,
|
|
'imdb': None,
|
|
}
|
|
|
|
season_data = dict((k, v) for k, v in season_data.iteritems() if v)
|
|
return season_data
|
|
|
|
def _parseEpisode(self, show, episode):
|
|
"""
|
|
('episodenumber', u'1'),
|
|
('thumb_added', None),
|
|
('rating', u'7.7'),
|
|
('overview',
|
|
u'Experienced waitress Max Black meets her new co-worker, former rich-girl Caroline Channing, and puts her skills to the test at an old but re-emerging Brooklyn diner. Despite her initial distaste for Caroline, Max eventually softens and the two team up for a new business venture.'),
|
|
('dvd_episodenumber', None),
|
|
('dvd_discid', None),
|
|
('combined_episodenumber', u'1'),
|
|
('epimgflag', u'7'),
|
|
('id', u'4099506'),
|
|
('seasonid', u'465948'),
|
|
('thumb_height', u'225'),
|
|
('tms_export', u'1374789754'),
|
|
('seasonnumber', u'1'),
|
|
('writer', u'|Michael Patrick King|Whitney Cummings|'),
|
|
('lastupdated', u'1371420338'),
|
|
('filename', u'http://thetvdb.com/banners/episodes/248741/4099506.jpg'),
|
|
('absolute_number', u'1'),
|
|
('ratingcount', u'102'),
|
|
('combined_season', u'1'),
|
|
('thumb_width', u'400'),
|
|
('imdb_id', u'tt1980319'),
|
|
('director', u'James Burrows'),
|
|
('dvd_chapter', None),
|
|
('dvd_season', None),
|
|
('gueststars',
|
|
u'|Brooke Lyons|Noah Mills|Shoshana Bush|Cale Hartmann|Adam Korson|Alex Enriquez|Matt Cook|Bill Parks|Eugene Shaw|Sergey Brusilovsky|Greg Lewis|Cocoa Brown|Nick Jameson|'),
|
|
('seriesid', u'248741'),
|
|
('language', u'en'),
|
|
('productioncode', u'296793'),
|
|
('firstaired', u'2011-09-19'),
|
|
('episodename', u'Pilot')]
|
|
"""
|
|
|
|
poster = episode.get('filename', [])
|
|
backdrop = []
|
|
genres = []
|
|
plot = "%s - %sx%s - %s" % (show['seriesname'] or u'',
|
|
episode.get('seasonnumber', u'?'),
|
|
episode.get('episodenumber', u'?'),
|
|
episode.get('overview', u''))
|
|
if episode.get('firstaired', None) is not None:
|
|
try: year = datetime.strptime(episode['firstaired'], '%Y-%m-%d').year
|
|
except: year = None
|
|
else:
|
|
year = None
|
|
|
|
try:
|
|
id = int(episode['id'])
|
|
except:
|
|
id = None
|
|
|
|
episode_data = {
|
|
'id': id,
|
|
'type': 'episode',
|
|
'primary_provider': 'thetvdb',
|
|
'via_thetvdb': True,
|
|
'thetvdb_id': id,
|
|
'titles': [episode.get('episodename', u''), ],
|
|
'original_title': episode.get('episodename', u'') ,
|
|
'images': {
|
|
'poster': [poster] if poster else [],
|
|
'backdrop': [backdrop] if backdrop else [],
|
|
'poster_original': [],
|
|
'backdrop_original': [],
|
|
},
|
|
'imdb': episode.get('imdb_id', None),
|
|
'runtime': None,
|
|
'released': episode.get('firstaired', None),
|
|
'year': year,
|
|
'plot': plot,
|
|
'genres': genres,
|
|
'parent_identifier': show['id'] or None,
|
|
'seasonnumber': episode.get('seasonnumber', None),
|
|
'episodenumber': episode.get('episodenumber', None),
|
|
'combined_episodenumber': episode.get('combined_episodenumber', None),
|
|
'absolute_number': episode.get('absolute_number', None),
|
|
'combined_season': episode.get('combined_season', None),
|
|
'productioncode': episode.get('productioncode', None),
|
|
'seriesid': episode.get('seriesid', None),
|
|
'seasonid': episode.get('seasonid', None),
|
|
'firstaired': episode.get('firstaired', None),
|
|
'thumb_added': episode.get('thumb_added', None),
|
|
'thumb_height': episode.get('thumb_height', None),
|
|
'thumb_width': episode.get('thumb_width', None),
|
|
'rating': episode.get('rating', None),
|
|
'ratingcount': episode.get('ratingcount', None),
|
|
'epimgflag': episode.get('epimgflag', None),
|
|
'dvd_episodenumber': episode.get('dvd_episodenumber', None),
|
|
'dvd_discid': episode.get('dvd_discid', None),
|
|
'dvd_chapter': episode.get('dvd_chapter', None),
|
|
'dvd_season': episode.get('dvd_season', None),
|
|
'tms_export': episode.get('tms_export', None),
|
|
'writer': episode.get('writer', None),
|
|
'director': episode.get('director', None),
|
|
'gueststars': episode.get('gueststars', None),
|
|
'lastupdated': episode.get('lastupdated', None),
|
|
'language': episode.get('language', None),
|
|
}
|
|
|
|
episode_data = dict((k, v) for k, v in episode_data.iteritems() if v)
|
|
return episode_data
|
|
|
|
#def getImage(self, show, type = 'poster', size = 'cover'):
|
|
#""""""
|
|
## XXX: Need to implement size
|
|
#image_url = ''
|
|
|
|
#for res, res_data in show['_banners'].get(type, {}).items():
|
|
#for bid, banner_info in res_data.items():
|
|
#image_url = banner_info.get('_bannerpath', '')
|
|
#break
|
|
|
|
#return image_url
|
|
|
|
def isDisabled(self):
|
|
if self.conf('api_key') == '':
|
|
log.error('No API key provided.')
|
|
True
|
|
else:
|
|
False
|