Tweak use of in memory cache.
[plugin.video.netflix.git] / resources / lib / KodiHelper.py
index 8288cb5b0342d016c8cc2cda25d81081ac939d5f..0e5b6617de3696a9ba009cee73df3dcf1b84184c 100644 (file)
@@ -3,14 +3,17 @@
 # Module: KodiHelper
 # Created on: 13.01.2017
 
-import os
-import urllib
 import xbmcplugin
 import xbmcgui
-import xbmcaddon
 import xbmc
 import json
-import uuid
+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
@@ -20,7 +23,7 @@ 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
@@ -31,22 +34,27 @@ class KodiHelper:
         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.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):
         """Refresh the current list"""
         return xbmc.executebuiltin('Container.Refresh')
@@ -170,7 +178,7 @@ class KodiHelper:
         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
@@ -181,16 +189,44 @@ class KodiHelper:
             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.addon.getSetting('enable_dolby_sound') == 'true'
+        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)
@@ -201,8 +237,8 @@ class KodiHelper:
             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):
@@ -213,7 +249,7 @@ class KodiHelper:
         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
@@ -246,22 +282,6 @@ class KodiHelper:
         """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
 
@@ -276,9 +296,8 @@ class KodiHelper:
             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]
+
+        return cached_items.get(cache_id)
 
     def add_cached_item (self, cache_id, contents):
         """Adds an item to the in memory cache
@@ -430,22 +449,25 @@ class KodiHelper:
         """
         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
-                    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)
+                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)
@@ -566,9 +588,12 @@ class KodiHelper:
                     # 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)
@@ -606,9 +631,9 @@ class KodiHelper:
                     # 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)
-                    url = build_url({'action': 'play_video', 'video_id': episode_id, '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)
@@ -621,7 +646,7 @@ class KodiHelper:
         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
@@ -634,12 +659,17 @@ class KodiHelper:
 
         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()
@@ -649,20 +679,29 @@ class KodiHelper:
         # 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) + '.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):
@@ -736,7 +775,9 @@ class KodiHelper:
             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:
@@ -756,6 +797,8 @@ class KodiHelper:
         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')
@@ -775,8 +818,10 @@ class KodiHelper:
             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
@@ -798,7 +843,7 @@ class KodiHelper:
         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'],
@@ -865,7 +910,7 @@ class KodiHelper:
         :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')
@@ -913,14 +958,15 @@ class KodiHelper:
         :param event: the string idetifier of the event
         :return: None
         """
+        addon = self.get_addon()
         # Check if tracking is enabled
-        enable_tracking = (self.addon.getSetting('enable_tracking') == 'true')
+        enable_tracking = (addon.getSetting('enable_tracking') == 'true')
         if enable_tracking:
             #Get or Create Tracking id
-            tracking_id = self.addon.getSetting('tracking_id')
+            tracking_id = addon.getSetting('tracking_id')
             if tracking_id is '':
-                tracking_id = str(uuid.uuid4())
-                self.addon.setSetting('tracking_id', tracking_id)
+                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)