# Module: KodiHelper
# Created on: 13.01.2017
-import os
import xbmcplugin
import xbmcgui
-import xbmcaddon
import xbmc
import json
+from os.path import join
+from urllib import urlencode
+from xbmcaddon import Addon
+from uuid import uuid4
+from UniversalAnalytics import Tracker
+try:
+ import cPickle as pickle
+except:
+ import pickle
class KodiHelper:
"""Consumes all the configuration data from Kodi as well as turns data into lists of folders and videos"""
- msl_service_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='
- """str: MSL service certificate"""
-
- msl_service_server_url = 'http://localhost:%PORT%'
- """str: MSL service url"""
-
- msl_service_port = 8000
- """str: MSL service port (TODO: Make it dynamic)"""
-
def __init__ (self, plugin_handle, base_url):
"""Fetches all needed info from Kodi & configures the baseline of the plugin
"""
self.plugin_handle = plugin_handle
self.base_url = base_url
- self.addon = xbmcaddon.Addon()
+ self.addon = Addon()
self.plugin = self.addon.getAddonInfo('name')
self.base_data_path = xbmc.translatePath(self.addon.getAddonInfo('profile'))
self.home_path = xbmc.translatePath('special://home')
self.plugin_path = self.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.library = None
+ self.setup_memcache()
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
+ def show_search_term_dialog (self):
+ """Asks the user for a term to query the netflix search for
Returns
-------
- :obj:`int`
- 4 digit adult pin needed for adult movies
+ :obj:`str`
+ Term to search for
"""
dlg = xbmcgui.Dialog()
- return dlg.input(self.get_local_string(string_id=30002), type=xbmcgui.INPUT_NUMERIC)
+ term = dlg.input(self.get_local_string(string_id=30003), type=xbmcgui.INPUT_ALPHANUM)
+ if len(term) == 0:
+ term = ' '
+ return term
- def show_search_term_dialog (self):
- """Asks the user for a term to query the netflix search for
+ def show_add_to_library_title_dialog (self, original_title):
+ """Asks the user for an alternative title for the show/movie that gets exported to the local library
+
+ Parameters
+ ----------
+ original_title : :obj:`str`
+ Original title of the show (as suggested by the addon)
Returns
-------
- term : :obj:`str`
- Term to search for
+ :obj:`str`
+ Title to persist
"""
dlg = xbmcgui.Dialog()
- return dlg.input(self.get_local_string(string_id=30003), type=xbmcgui.INPUT_ALPHANUM)
+ return dlg.input(heading=self.get_local_string(string_id=30031), defaultt=original_title, type=xbmcgui.INPUT_ALPHANUM)
def show_password_dialog (self):
"""Asks the user for its Netflix password
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 set_setting (key, value):
+ 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):
"""Public interface for the addons setSetting method
Returns
'password': self.addon.getSetting('password')
}
+ def get_dolby_setting(self):
+ """
+ Returns if the dolby sound is enabled
+ :return: True|False
+ """
+ return self.addon.getSetting('enable_dolby_sound') == 'true'
+
def get_custom_library_settings (self):
"""Returns the settings in regards to the custom library folder(s)
'customlibraryfolder': self.addon.getSetting('customlibraryfolder')
}
+ def get_ssl_verification_setting (self):
+ """Returns the setting that describes if we should verify the ssl transport when loading data
+
+ Returns
+ -------
+ bool
+ Verify or not
+ """
+ return self.addon.getSetting('ssl_verification') == 'true'
+
def set_main_menu_selection (self, type):
- self.win.setProperty('main_menu_selection', type)
+ """Persist the chosen main menu entry in memory
+
+ Parameters
+ ----------
+ type : :obj:`str`
+ Selected menu item
+ """
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('main_menu_selection', type)
def get_main_menu_selection (self):
- return self.win.getProperty('main_menu_selection')
+ """Gets the persisted chosen main menu entry from memory
+
+ Returns
+ -------
+ :obj:`str`
+ The last chosen main menu entry
+ """
+ return xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('main_menu_selection')
+
+ def setup_memcache (self):
+ """Sets up the memory cache if not existant"""
+ cached_items = xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache')
+ # no cache setup yet, create one
+ if len(cached_items) < 1:
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('memcache', pickle.dumps({}))
+
+ def invalidate_memcache (self):
+ """Invalidates the memory cache"""
+ xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty('memcache', pickle.dumps({}))
+
+ def has_cached_item (self, cache_id):
+ """Checks if the requested item is in memory cache
+
+ Parameters
+ ----------
+ cache_id : :obj:`str`
+ ID of the cache entry
+
+ Returns
+ -------
+ bool
+ Item is cached
+ """
+ cached_items = pickle.loads(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache'))
+ return cache_id in cached_items.keys()
+
+ def get_cached_item (self, cache_id):
+ """Returns an item from the in memory cache
+
+ Parameters
+ ----------
+ cache_id : :obj:`str`
+ ID of the cache entry
+
+ Returns
+ -------
+ mixed
+ Contents of the requested cache item or none
+ """
+ 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]
+
+ def add_cached_item (self, cache_id, contents):
+ """Adds an item to the in memory cache
+
+ Parameters
+ ----------
+ cache_id : :obj:`str`
+ ID of the cache entry
+
+ contents : mixed
+ Cache entry contents
+ """
+ cached_items = pickle.loads(xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty('memcache'))
+ cached_items.update({cache_id: contents})
+ 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
# (re)select the previously selected main menu entry
idx = 1
- preselected_list_item = None
for item in preselect_items:
idx += 1
- if item:
- preselected_list_item = idx
- if self.get_main_menu_selection() == 'search':
- preselected_list_item = idx + 2
+ 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('SetFocus(%s, %s)' % (self.win.getFocusId(), 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):
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})
+ url = build_url({'action': 'play_video', 'video_id': video_list_id})
# 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)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LABEL)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_TITLE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_VIDEO_YEAR)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_GENRE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LASTPLAYED)
xbmcplugin.endOfDirectory(self.plugin_handle)
return True
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)
xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=True)
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_NONE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_VIDEO_YEAR)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LABEL)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LASTPLAYED)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_TITLE)
xbmcplugin.endOfDirectory(self.plugin_handle)
return True
# add list item info
li = 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']})
xbmcplugin.addDirectoryItem(handle=self.plugin_handle, url=url, listitem=li, isFolder=False)
+
xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_EPISODE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_NONE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_VIDEO_YEAR)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LABEL)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_LASTPLAYED)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_TITLE)
+ xbmcplugin.addSortMethod(handle=self.plugin_handle, sortMethod=xbmcplugin.SORT_METHOD_DURATION)
xbmcplugin.endOfDirectory(self.plugin_handle)
return True
self.log(msg='Inputstream addon not found')
return False
+ # track play event
+ self.track_event('playVideo')
+
+ # check esn in settings
+ settings_esn = str(self.addon.getSetting('esn'))
+ if len(settings_esn) == 0:
+ self.addon.setSetting('esn', str(esn))
+
# inputstream addon properties
- msl_service_url = self.msl_service_server_url.replace('%PORT%', str(self.msl_service_port))
+ msl_service_url = 'http://localhost:' + str(self.addon.getSetting('msl_service_port'))
play_item = xbmcgui.ListItem(path=msl_service_url + '/manifest?id=' + video_id)
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', self.msl_service_server_certificate)
+ 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=')
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')
return xbmcplugin.setResolvedUrl(self.plugin_handle, True, listitem=play_item)
def _generate_art_info (self, entry, li):
entry_keys = entry.keys()
# action item templates
- url_tmpl = 'XBMC.RunPlugin(' + self.base_url + '?action=%action%&id=' + str(entry['id']) + ')'
+ 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'],
['remove_from_library', self.get_local_string(30030), 'remove'],
items.append(action['rate_on_netflix'])
# add possibility to export this movie/show/season/episode to a static/local library (and to remove it)
- # TODO: Not yet finished, still needs implementation
- #if 'type' in entry_keys:
- #items.append(action['export_to_library'])
- #items.append(action['remove_from_library'])
+ if 'type' in entry_keys:
+ # add/remove movie
+ if entry['type'] == 'movie':
+ action_type = 'remove_from_library' if self.library.movie_exists(title=entry['title'], year=entry['year']) else 'export_to_library'
+ items.append(action[action_type])
+ # add/remove show
+ if entry['type'] == 'show' and 'title' in entry_keys:
+ action_type = 'remove_from_library' if self.library.show_exists(title=entry['title']) else 'export_to_library'
+ items.append(action[action_type])
# add it to the item
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 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)
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
+ """
+ # Check if tracking is enabled
+ enable_tracking = (self.addon.getSetting('enable_tracking') == 'true')
+ if enable_tracking:
+ #Get or Create Tracking id
+ tracking_id = self.addon.getSetting('tracking_id')
+ if tracking_id is '':
+ tracking_id = str(uuid4())
+ self.addon.setSetting('tracking_id', tracking_id)
+ # Send the tracking event
+ tracker = Tracker.create('UA-46081640-5', client_id=tracking_id)
+ tracker.send('event', event)
projects / plugin.video.netflix.git / blobdiff