chore(performance): Removes NetflixSession from the core addon & adds a HTTP proxy...
[plugin.video.netflix.git] / resources / lib / KodiHelper.py
index 364fd7a82115786bf0d8560e640929d0f01c4ea4..4407b87e4e19a51a4f535d51a120f9ab6a906d71 100644 (file)
@@ -3,13 +3,15 @@
 # Module: KodiHelper
 # Created on: 13.01.2017
 
-import os
-import urllib
 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:
@@ -18,7 +20,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,23 +33,22 @@ class KodiHelper:
         """
         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):
@@ -100,7 +101,7 @@ class KodiHelper:
             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
@@ -137,6 +138,30 @@ class KodiHelper:
         dialog.notification(self.get_local_string(string_id=30028), self.get_local_string(string_id=30029), xbmcgui.NOTIFICATION_ERROR, 5000)
         return True
 
+    def show_no_search_results_notification (self):
+        """Shows notification that no search results could be found
+
+        Returns
+        -------
+        bool
+            Dialog shown
+        """
+        dialog = xbmcgui.Dialog()
+        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):
         """Public interface for the addons setSetting method
 
@@ -160,6 +185,13 @@ class KodiHelper:
             '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)
 
@@ -191,7 +223,7 @@ class KodiHelper:
         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
@@ -201,18 +233,18 @@ class KodiHelper:
         :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
@@ -227,7 +259,7 @@ class KodiHelper:
         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):
@@ -243,7 +275,7 @@ class KodiHelper:
         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]
@@ -259,9 +291,9 @@ class KodiHelper:
         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
@@ -371,7 +403,7 @@ class KodiHelper:
             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):
@@ -452,8 +484,7 @@ class KodiHelper:
         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
 
@@ -473,10 +504,8 @@ class KodiHelper:
         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)
@@ -532,7 +561,7 @@ class KodiHelper:
         for index in seasons_sorted:
             for season_id in season_list:
                 season = season_list[season_id]
-                if int(season['id']) == 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)
@@ -617,6 +646,14 @@ class KodiHelper:
             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 = 'http://localhost:' + str(self.addon.getSetting('msl_service_port'))
         play_item = xbmcgui.ListItem(path=msl_service_url + '/manifest?id=' + video_id)
@@ -624,8 +661,6 @@ class KodiHelper:
         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
@@ -766,7 +801,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'],
@@ -874,3 +909,21 @@ class KodiHelper:
             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)