# Module: KodiHelper
# Created on: 13.01.2017
-import os
-import urllib
import xbmcplugin
import xbmcgui
-import xbmcaddon
import xbmc
import json
+from MSL import MSL
+from os import remove
+from os.path import join, isfile
+from urllib import urlencode
+from xbmcaddon import Addon
+from uuid import uuid4
+from utils import get_user_agent_for_current_platform
+from UniversalAnalytics import Tracker
try:
import cPickle as pickle
except:
class KodiHelper:
"""Consumes all the configuration data from Kodi as well as turns data into lists of folders and videos"""
- def __init__ (self, plugin_handle, base_url):
+ def __init__ (self, plugin_handle=None, base_url=None):
"""Fetches all needed info from Kodi & configures the baseline of the plugin
Parameters
base_url : :obj:`str`
Plugin base url
"""
+ addon = self.get_addon()
self.plugin_handle = plugin_handle
self.base_url = base_url
- self.addon = xbmcaddon.Addon()
- self.plugin = self.addon.getAddonInfo('name')
- self.base_data_path = xbmc.translatePath(self.addon.getAddonInfo('profile'))
+ self.plugin = addon.getAddonInfo('name')
+ self.version = addon.getAddonInfo('version')
+ self.base_data_path = xbmc.translatePath(addon.getAddonInfo('profile'))
self.home_path = xbmc.translatePath('special://home')
- self.plugin_path = self.addon.getAddonInfo('path')
+ self.plugin_path = addon.getAddonInfo('path')
self.cookie_path = self.base_data_path + 'COOKIE'
self.data_path = self.base_data_path + 'DATA'
- self.config_path = os.path.join(self.base_data_path, 'config')
+ self.config_path = join(self.base_data_path, 'config')
self.msl_data_path = xbmc.translatePath('special://profile/addon_data/service.msl').decode('utf-8') + '/'
- self.verb_log = self.addon.getSetting('logging') == 'true'
- self.default_fanart = self.addon.getAddonInfo('fanart')
- self.win = xbmcgui.Window(xbmcgui.getCurrentWindowId())
+ self.verb_log = addon.getSetting('logging') == 'true'
+ self.default_fanart = addon.getAddonInfo('fanart')
self.library = None
self.setup_memcache()
+ def get_addon (self):
+ """Returns a fresh addon instance"""
+ return Addon()
+
def refresh (self):
- """Refrsh the current list"""
+ """Refresh the current list"""
return xbmc.executebuiltin('Container.Refresh')
def show_rating_dialog (self):
dlg = xbmcgui.Dialog()
return dlg.numeric(heading=self.get_local_string(string_id=30019) + ' ' + self.get_local_string(string_id=30022), type=0)
- def show_adult_pin_dialog (self):
- """Asks the user for the adult pin
-
- Returns
- -------
- :obj:`int`
- 4 digit adult pin needed for adult movies
- """
- dlg = xbmcgui.Dialog()
- return dlg.input(self.get_local_string(string_id=30002), type=xbmcgui.INPUT_NUMERIC)
-
def show_search_term_dialog (self):
"""Asks the user for a term to query the netflix search for
Netflix password
"""
dlg = xbmcgui.Dialog()
- return dlg.input(self.get_local_string(string_id=30004), type=xbmcgui.INPUT_ALPHANUM)
+ return dlg.input(self.get_local_string(string_id=30004), type=xbmcgui.INPUT_ALPHANUM, option=xbmcgui.ALPHANUM_HIDE_INPUT)
def show_email_dialog (self):
"""Asks the user for its Netflix account email
dlg = xbmcgui.Dialog()
return dlg.input(self.get_local_string(string_id=30005), type=xbmcgui.INPUT_ALPHANUM)
- def show_wrong_adult_pin_notification (self):
- """Shows notification that a wrong adult pin was given
+ def show_login_failed_notification (self):
+ """Shows notification that the login failed
Returns
-------
Dialog shown
"""
dialog = xbmcgui.Dialog()
- dialog.notification(self.get_local_string(string_id=30006), self.get_local_string(string_id=30007), xbmcgui.NOTIFICATION_ERROR, 5000)
+ dialog.notification(self.get_local_string(string_id=30008), self.get_local_string(string_id=30009), xbmcgui.NOTIFICATION_ERROR, 5000)
return True
- def show_login_failed_notification (self):
- """Shows notification that the login failed
+ def show_missing_inputstream_addon_notification (self):
+ """Shows notification that the inputstream addon couldn't be found
Returns
-------
Dialog shown
"""
dialog = xbmcgui.Dialog()
- dialog.notification(self.get_local_string(string_id=30008), self.get_local_string(string_id=30009), xbmcgui.NOTIFICATION_ERROR, 5000)
+ dialog.notification(self.get_local_string(string_id=30028), self.get_local_string(string_id=30029), xbmcgui.NOTIFICATION_ERROR, 5000)
return True
- def show_missing_inputstream_addon_notification (self):
- """Shows notification that the inputstream addon couldn't be found
+ def show_no_search_results_notification (self):
+ """Shows notification that no search results could be found
Returns
-------
Dialog shown
"""
dialog = xbmcgui.Dialog()
- dialog.notification(self.get_local_string(string_id=30028), self.get_local_string(string_id=30029), xbmcgui.NOTIFICATION_ERROR, 5000)
+ dialog.notification(self.get_local_string(string_id=30011), self.get_local_string(string_id=30013))
+ return True
+
+ def show_no_seasons_notification (self):
+ """Shows notification that no seasons be found
+
+ Returns
+ -------
+ bool
+ Dialog shown
+ """
+ dialog = xbmcgui.Dialog()
+ dialog.notification(self.get_local_string(string_id=30010), self.get_local_string(string_id=30012))
return True
def set_setting (self, key, value):
bool
Setting could be set or not
"""
- return self.addon.setSetting(key, value)
+ return self.get_addon().setSetting(key, value)
def get_credentials (self):
"""Returns the users stored credentials
The users stored account data
"""
return {
- 'email': self.addon.getSetting('email'),
- 'password': self.addon.getSetting('password')
+ 'email': self.get_addon().getSetting('email'),
+ 'password': self.get_addon().getSetting('password')
}
+ def get_esn(self):
+ """
+ Returns the esn from settings
+ """
+ self.log(msg='Is FILE: ' + str(isfile(self.msl_data_path + 'msl_data.json')))
+ self.log(msg=self.get_addon().getSetting('esn'))
+ return self.get_addon().getSetting('esn')
+
+ def set_esn(self, esn):
+ """
+ Returns the esn from settings
+ """
+ stored_esn = self.get_esn()
+ if not stored_esn and esn:
+ self.set_setting('esn', esn)
+ self.delete_manifest_data()
+ return esn
+ return stored_esn
+
+ def delete_manifest_data(self):
+ if isfile(self.msl_data_path + 'msl_data.json'):
+ remove(self.msl_data_path + 'msl_data.json')
+ if isfile(self.msl_data_path + 'manifest.json'):
+ remove(self.msl_data_path + 'manifest.json')
+ msl = MSL(kodi_helper=self)
+ msl.perform_key_handshake()
+ msl.save_msl_data()
+
+ def get_dolby_setting(self):
+ """
+ Returns if the dolby sound is enabled
+ :return: True|False
+ """
+ return self.get_addon().getSetting('enable_dolby_sound') == 'true'
+
def get_custom_library_settings (self):
"""Returns the settings in regards to the custom library folder(s)
The users library settings
"""
return {
- 'enablelibraryfolder': self.addon.getSetting('enablelibraryfolder'),
- 'customlibraryfolder': self.addon.getSetting('customlibraryfolder')
+ 'enablelibraryfolder': self.get_addon().getSetting('enablelibraryfolder'),
+ 'customlibraryfolder': self.get_addon().getSetting('customlibraryfolder')
}
def get_ssl_verification_setting (self):
bool
Verify or not
"""
- return self.addon.getSetting('ssl_verification') == 'true'
+ return self.get_addon().getSetting('ssl_verification') == 'true'
def set_main_menu_selection (self, type):
"""Persist the chosen main menu entry in memory
type : :obj:`str`
Selected menu item
"""
- self.win.setProperty('main_menu_selection', type)
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('main_menu_selection', type)
def get_main_menu_selection (self):
"""Gets the persisted chosen main menu entry from memory
:obj:`str`
The last chosen main menu entry
"""
- return self.win.getProperty('main_menu_selection')
+ return xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('main_menu_selection')
def setup_memcache (self):
"""Sets up the memory cache if not existant"""
- cached_items = self.win.getProperty('memcache')
+ cached_items = xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache')
# no cache setup yet, create one
if len(cached_items) < 1:
- self.win.setProperty('memcache', pickle.dumps({}))
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('memcache', pickle.dumps({}))
def invalidate_memcache (self):
"""Invalidates the memory cache"""
- self.win.setProperty('memcache', pickle.dumps({}))
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('memcache', pickle.dumps({}))
def has_cached_item (self, cache_id):
"""Checks if the requested item is in memory cache
bool
Item is cached
"""
- cached_items = pickle.loads(self.win.getProperty('memcache'))
+ cached_items = pickle.loads(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache'))
return cache_id in cached_items.keys()
def get_cached_item (self, cache_id):
mixed
Contents of the requested cache item or none
"""
- cached_items = pickle.loads(self.win.getProperty('memcache'))
+ cached_items = pickle.loads(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache'))
if self.has_cached_item(cache_id) != True:
return None
return cached_items[cache_id]
contents : mixed
Cache entry contents
"""
- cached_items = pickle.loads(self.win.getProperty('memcache'))
+ cached_items = pickle.loads(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache'))
cached_items.update({cache_id: contents})
- self.win.setProperty('memcache', pickle.dumps(cached_items))
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('memcache', pickle.dumps(cached_items))
def build_profiles_listing (self, profiles, action, build_url):
"""Builds the profiles list Kodi screen
preselected_list_item = idx if item else None
preselected_list_item = idx + 1 if self.get_main_menu_selection() == 'search' else preselected_list_item
if preselected_list_item != None:
- xbmc.executebuiltin('ActivateWindowAndFocus(%s, %s)' % (str(self.win.getFocusId()), str(preselected_list_item)))
+ xbmc.executebuiltin('ActivateWindowAndFocus(%s, %s)' % (str(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getFocusId()), str(preselected_list_item)))
return True
def build_video_listing (self, video_list, actions, type, build_url):
"""
for video_list_id in video_list:
video = video_list[video_list_id]
- if type != 'queue' or (type == 'queue' and video['in_my_list'] == True):
- li = xbmcgui.ListItem(label=video['title'])
- # add some art to the item
- li = self._generate_art_info(entry=video, li=li)
+ li = xbmcgui.ListItem(label=video['title'])
+ # add some art to the item
+ li = self._generate_art_info(entry=video, li=li)
+ # add list item info
+ li, infos = self._generate_entry_info(entry=video, li=li)
+ li = self._generate_context_menu_items(entry=video, li=li)
+ # lists can be mixed with shows & movies, therefor we need to check if its a movie, so play it right away
+ if video_list[video_list_id]['type'] == 'movie':
+ # it´s a movie, so we need no subfolder & a route to play it
+ isFolder = False
+ url = build_url({'action': 'play_video', 'video_id': video_list_id, 'infoLabels': infos})
+ else:
# it´s a show, so we need a subfolder & route (for seasons)
isFolder = True
- url = build_url({'action': actions[video['type']], 'show_id': video_list_id})
- # lists can be mixed with shows & movies, therefor we need to check if its a movie, so play it right away
- if video_list[video_list_id]['type'] == 'movie':
- # it´s a movie, so we need no subfolder & a route to play it
- isFolder = False
- # check maturity index, to determine if we need the adult pin
- needs_pin = (True, False)[int(video['maturity']['level']) >= 1000]
- url = build_url({'action': 'play_video', 'video_id': video_list_id, 'pin': needs_pin})
- # add list item info
- li = self._generate_entry_info(entry=video, li=li)
- li = self._generate_context_menu_items(entry=video, li=li)
- xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=isFolder)
+ params = {'action': actions[video['type']], 'show_id': video_list_id}
+ if 'tvshowtitle' in infos:
+ params['tvshowtitle'] = infos['tvshowtitle']
+ url = build_url(params)
+ xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=isFolder)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LABEL)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_TITLE)
bool
List could be build
"""
- li = xbmcgui.ListItem(label=self.get_local_string(30012))
- xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url='', listitem=li, isFolder=False)
+ self.show_no_seasons_notification()
xbmcplugin.endOfDirectory(self.plugin_handle)
return True
bool
List could be build
"""
- li = xbmcgui.ListItem(label=self.get_local_string(30013))
- xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=build_url({'action': action}), listitem=li, isFolder=False)
- xbmcplugin.endOfDirectory(self.plugin_handle)
- return True
+ self.show_no_search_results_notification()
+ return xbmcplugin.endOfDirectory(self.plugin_handle)
def build_user_sub_listing (self, video_list_ids, type, action, build_url):
"""Builds the video lists screen for user subfolders (genres & recommendations)
for index in seasons_sorted:
for season_id in season_list:
season = season_list[season_id]
- if int(season['shortName'].split(' ')[1]) == index:
+ if int(season['idx']) == index:
li = xbmcgui.ListItem(label=season['text'])
# add some art to the item
li = self._generate_art_info(entry=season, li=li)
# add list item info
- li = self._generate_entry_info(entry=season, li=li, base_info={'mediatype': 'season'})
+ li, infos = self._generate_entry_info(entry=season, li=li, base_info={'mediatype': 'season'})
li = self._generate_context_menu_items(entry=season, li=li)
- url = build_url({'action': 'episode_list', 'season_id': season_id})
+ params = {'action': 'episode_list', 'season_id': season_id}
+ if 'tvshowtitle' in infos:
+ params['tvshowtitle'] = infos['tvshowtitle']
+ url = build_url(params)
xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=True)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_NONE)
# add some art to the item
li = self._generate_art_info(entry=episode, li=li)
# add list item info
- li = self._generate_entry_info(entry=episode, li=li, base_info={'mediatype': 'episode'})
+ li, infos = self._generate_entry_info(entry=episode, li=li, base_info={'mediatype': 'episode'})
li = self._generate_context_menu_items(entry=episode, li=li)
- # check maturity index, to determine if we need the adult pin
- needs_pin = (True, False)[int(episode['maturity']['rating']['maturityLevel']) >= 1000]
- url = build_url({'action': 'play_video', 'video_id': episode_id, 'pin': needs_pin, 'start_offset': episode['bookmark']})
+ url = build_url({'action': 'play_video', 'video_id': episode_id, 'start_offset': episode['bookmark'], 'infoLabels': infos})
xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=False)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_EPISODE)
xbmcplugin.endOfDirectory(self.plugin_handle)
return True
- def play_item (self, esn, video_id, start_offset=-1):
+ def play_item (self, esn, video_id, start_offset=-1, infoLabels={}):
"""Plays a video
Parameters
start_offset : :obj:`str`
Offset to resume playback from (in seconds)
+
+ infoLabels : :obj:`str`
+ the listitem's infoLabels
Returns
-------
bool
List could be build
"""
+ self.set_esn(esn)
+ addon = self.get_addon()
inputstream_addon = self.get_inputstream_addon()
if inputstream_addon == None:
self.show_missing_inputstream_addon_notification()
self.log(msg='Inputstream addon not found')
return False
+ # track play event
+ self.track_event('playVideo')
+
+ # check esn in settings
+ settings_esn = str(addon.getSetting('esn'))
+ if len(settings_esn) == 0:
+ addon.setSetting('esn', str(esn))
+
# inputstream addon properties
- msl_service_url = 'http://localhost:' + str(self.addon.getSetting('msl_service_port'))
+ msl_service_url = 'http://localhost:' + str(addon.getSetting('msl_service_port'))
play_item = xbmcgui.ListItem(path=msl_service_url + '/manifest?id=' + video_id)
+ play_item.setContentLookup(False)
+ play_item.setMimeType('application/dash+xml')
+ play_item.setProperty(inputstream_addon + '.stream_headers', 'user-agent=' + get_user_agent_for_current_platform())
play_item.setProperty(inputstream_addon + '.license_type', 'com.widevine.alpha')
play_item.setProperty(inputstream_addon + '.manifest_type', 'mpd')
play_item.setProperty(inputstream_addon + '.license_key', msl_service_url + '/license?id=' + video_id + '||b{SSM}!b{SID}|')
play_item.setProperty(inputstream_addon + '.server_certificate', 'Cr0CCAMSEOVEukALwQ8307Y2+LVP+0MYh/HPkwUijgIwggEKAoIBAQDm875btoWUbGqQD8eAGuBlGY+Pxo8YF1LQR+Ex0pDONMet8EHslcZRBKNQ/09RZFTP0vrYimyYiBmk9GG+S0wB3CRITgweNE15cD33MQYyS3zpBd4z+sCJam2+jj1ZA4uijE2dxGC+gRBRnw9WoPyw7D8RuhGSJ95OEtzg3Ho+mEsxuE5xg9LM4+Zuro/9msz2bFgJUjQUVHo5j+k4qLWu4ObugFmc9DLIAohL58UR5k0XnvizulOHbMMxdzna9lwTw/4SALadEV/CZXBmswUtBgATDKNqjXwokohncpdsWSauH6vfS6FXwizQoZJ9TdjSGC60rUB2t+aYDm74cIuxAgMBAAE6EHRlc3QubmV0ZmxpeC5jb20SgAOE0y8yWw2Win6M2/bw7+aqVuQPwzS/YG5ySYvwCGQd0Dltr3hpik98WijUODUr6PxMn1ZYXOLo3eED6xYGM7Riza8XskRdCfF8xjj7L7/THPbixyn4mULsttSmWFhexzXnSeKqQHuoKmerqu0nu39iW3pcxDV/K7E6aaSr5ID0SCi7KRcL9BCUCz1g9c43sNj46BhMCWJSm0mx1XFDcoKZWhpj5FAgU4Q4e6f+S8eX39nf6D6SJRb4ap7Znzn7preIvmS93xWjm75I6UBVQGo6pn4qWNCgLYlGGCQCUm5tg566j+/g5jvYZkTJvbiZFwtjMW5njbSRwB3W4CrKoyxw4qsJNSaZRTKAvSjTKdqVDXV/U5HK7SaBA6iJ981/aforXbd2vZlRXO/2S+Maa2mHULzsD+S5l4/YGpSt7PnkCe25F+nAovtl/ogZgjMeEdFyd/9YMYjOS4krYmwp3yJ7m9ZzYCQ6I8RQN4x/yLlHG5RH/+WNLNUs6JAZ0fFdCmw=')
- # TODO: Change when Kodi can handle/trnsfer defaults in hidden values in settings
- #play_item.setProperty(inputstream_addon + '.server_certificate', self.addon.getSetting('msl_service_certificate'))
play_item.setProperty('inputstreamaddon', inputstream_addon)
# check if we have a bookmark e.g. start offset position
if int(start_offset) > 0:
- play_item.setProperty('StartOffset', str(start_offset))
+ play_item.setProperty('StartOffset', str(start_offset) + '.0')
+ # set infoLabels
+ if len(infoLabels) > 0:
+ play_item.setInfo('video', infoLabels)
return xbmcplugin.setResolvedUrl(self.plugin_handle, True, listitem=play_item)
def _generate_art_info (self, entry, li):
if 'mpaa' in entry_keys:
infos.update({'mpaa': entry['mpaa']})
else:
- infos.update({'mpaa': str(entry['maturity']['board']) + '-' + str(entry['maturity']['value'])})
+ if entry.get('maturity', None) is not None:
+ if entry['maturity']['board'] is not None and entry['maturity']['value'] is not None:
+ infos.update({'mpaa': str(entry['maturity']['board'].encode('utf-8')) + '-' + str(entry['maturity']['value'].encode('utf-8'))})
if 'rating' in entry_keys:
infos.update({'rating': int(entry['rating']) * 2})
if 'synopsis' in entry_keys:
if 'type' in entry_keys:
if entry['type'] == 'movie' or entry['type'] == 'episode':
li.setProperty('IsPlayable', 'true')
+ elif entry['type'] == 'show':
+ infos.update({'tvshowtitle': entry['title']})
if 'mediatype' in entry_keys:
if entry['mediatype'] == 'movie' or entry['mediatype'] == 'episode':
li.setProperty('IsPlayable', 'true')
if entry['quality'] == '1080':
quality = {'width': '1920', 'height': '1080'}
li.addStreamInfo('video', quality)
+ if 'tvshowtitle' in entry_keys:
+ infos.update({'tvshowtitle': entry['tvshowtitle']})
li.setInfo('video', infos)
- return li
+ return li, infos
def _generate_context_menu_items (self, entry, li):
"""Adds context menue items to a Kodi list item
entry_keys = entry.keys()
# action item templates
- encoded_title = urllib.urlencode({'title': entry['title'].encode('utf-8')}) if 'title' in entry else ''
+ encoded_title = urlencode({'title': entry['title'].encode('utf-8')}) if 'title' in entry else ''
url_tmpl = 'XBMC.RunPlugin(' + self.base_url + '?action=%action%&id=' + str(entry['id']) + '&' + encoded_title + ')'
actions = [
['export_to_library', self.get_local_string(30018), 'export'],
li.addContextMenuItems(items)
return li
- def log (self, msg, level=xbmc.LOGNOTICE):
+ def log (self, msg, level=xbmc.LOGDEBUG):
"""Adds a log entry to the Kodi log
Parameters
level : :obj:`int`
Kodi log level
"""
- if self.verb_log:
- if level == xbmc.LOGDEBUG and self.verb_log:
- level = xbmc.LOGNOTICE
- if isinstance(msg, unicode):
- msg = msg.encode('utf-8')
- xbmc.log('[%s] %s' % (self.plugin, msg.__str__()), level)
+ if isinstance(msg, unicode):
+ msg = msg.encode('utf-8')
+ xbmc.log('[%s] %s' % (self.plugin, msg.__str__()), level)
def get_local_string (self, string_id):
"""Returns the localized version of a string
:obj:`str`
Requested string or empty string
"""
- src = xbmc if string_id < 30000 else self.addon
+ src = xbmc if string_id < 30000 else self.get_addon()
locString = src.getLocalizedString(string_id)
if isinstance(locString, unicode):
locString = locString.encode('utf-8')
instance of the Library class
"""
self.library = library
+
+ def track_event(self, event):
+ """
+ Send a tracking event if tracking is enabled
+ :param event: the string idetifier of the event
+ :return: None
+ """
+ addon = self.get_addon()
+ # Check if tracking is enabled
+ enable_tracking = (addon.getSetting('enable_tracking') == 'true')
+ if enable_tracking:
+ #Get or Create Tracking id
+ tracking_id = addon.getSetting('tracking_id')
+ if tracking_id is '':
+ tracking_id = str(uuid4())
+ addon.setSetting('tracking_id', tracking_id)
+ # Send the tracking event
+ tracker = Tracker.create('UA-46081640-5', client_id=tracking_id)
+ tracker.send('event', event)