Tweak use of in memory cache.
[plugin.video.netflix.git] / resources / lib / Navigation.py
index 33711a7494714b174ad6b551a2e4a1fbc76c7bbb..2d690af942d4459039cee4bf6fc3a000c0d4f186 100644 (file)
@@ -6,6 +6,8 @@
 import urllib
 import urllib2
 import json
+import ast
+from xbmcaddon import Addon
 from urlparse import parse_qsl
 from utils import noop, log
 
@@ -45,6 +47,10 @@ class Navigation:
         """
         params = self.parse_paramters(paramstring=paramstring)
 
+        # open foreign settings dialog
+        if 'mode' in params.keys() and params['mode'] == 'openSettings':
+            return self.open_settings(params['url'])
+
         # log out the user
         if 'action' in params.keys() and params['action'] == 'logout':
             return self.call_netflix_service({'method': 'logout'})
@@ -75,10 +81,10 @@ class Navigation:
             return self.show_video_list(video_list_id=params['video_list_id'], type=type)
         elif params['action'] == 'season_list':
             # list of seasons for a show
-            return self.show_seasons(show_id=params['show_id'])
+            return self.show_seasons(show_id=params['show_id'], tvshowtitle=params['tvshowtitle'])
         elif params['action'] == 'episode_list':
             # list of episodes for a season
-            return self.show_episode_list(season_id=params['season_id'])
+            return self.show_episode_list(season_id=params['season_id'], tvshowtitle=params['tvshowtitle'])
         elif params['action'] == 'rating':
             return self.rate_on_netflix(video_id=params['id'])
         elif params['action'] == 'remove_from_list':
@@ -100,7 +106,7 @@ class Navigation:
             # display the lists (recommendations, genres, etc.)
             return self.show_user_list(type=params['type'])
         elif params['action'] == 'play_video':
-            self.play_video(video_id=params['video_id'], start_offset=params.get('start_offset', -1))
+            self.play_video(video_id=params['video_id'], start_offset=params.get('start_offset', -1), infoLabels=params['infoLabels'])
         elif params['action'] == 'user-items' and params['type'] == 'search':
             # if the user requested a search, ask for the term
             term = self.kodi_helper.show_search_term_dialog()
@@ -110,7 +116,7 @@ class Navigation:
         return True
 
     @log
-    def play_video (self, video_id, start_offset):
+    def play_video (self, video_id, start_offset, infoLabels):
         """Starts video playback
 
         Note: This is just a dummy, inputstream is needed to play the vids
@@ -122,9 +128,16 @@ class Navigation:
 
         start_offset : :obj:`str`
             Offset to resume playback from (in seconds)
+
+        infoLabels : :obj:`str`
+            the listitem's infoLabels
         """
+        try:
+            infoLabels = ast.literal_eval(infoLabels)
+        except:
+            infoLabels= {}
         esn = self.call_netflix_service({'method': 'get_esn'})
-        return self.kodi_helper.play_item(esn=esn, video_id=video_id, start_offset=start_offset)
+        return self.kodi_helper.play_item(esn=esn, video_id=video_id, start_offset=start_offset, infoLabels=infoLabels)
 
     @log
     def show_search_results (self, term):
@@ -140,7 +153,8 @@ class Navigation:
         bool
             If no results are available
         """
-        search_contents = self.call_netflix_service({'method': 'search', 'term': term})
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        search_contents = self.call_netflix_service({'method': 'search', 'term': term, 'guid': user_data['guid'], 'cache': True})
         # check for any errors
         if self._is_dirty_response(response=search_contents):
             return False
@@ -155,41 +169,41 @@ class Navigation:
         user_list_id : :obj:`str`
             Type of list to display
         """
-        video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'type': type})
+        # determine if we´re in kids mode
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'guid': user_data['guid'], 'cache': True})
         # check for any errors
         if self._is_dirty_response(response=video_list_ids):
             return False
         return self.kodi_helper.build_user_sub_listing(video_list_ids=video_list_ids[type], type=type, action='video_list', build_url=self.build_url)
 
-    def show_episode_list (self, season_id):
+    def show_episode_list (self, season_id, tvshowtitle):
         """Lists all episodes for a given season
 
         Parameters
         ----------
         season_id : :obj:`str`
             ID of the season episodes should be displayed for
-        """
-        cache_id = 'episodes_' + season_id
-        if self.kodi_helper.has_cached_item(cache_id=cache_id):
-            episode_list = self.kodi_helper.get_cached_item(cache_id=cache_id)
-        else:
-            episode_list = self.call_netflix_service({'method': 'fetch_episodes_by_season', 'season_id': season_id})
-            # check for any errors
-            if self._is_dirty_response(response=episode_list):
-                return False
-            # parse the raw Netflix data
-            self.kodi_helper.add_cached_item(cache_id=cache_id, contents=episode_list)
 
+        tvshowtitle : :obj:`str`
+            title of the show (for listitems' infolabels)
+        """
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        episode_list = self.call_netflix_service({'method': 'fetch_episodes_by_season', 'season_id': season_id, 'guid': user_data['guid'], 'cache': True})
+        # check for any errors
+        if self._is_dirty_response(response=episode_list):
+            return False
         # sort seasons by number (they´re coming back unsorted from the api)
         episodes_sorted = []
         for episode_id in episode_list:
+            episode_list[episode_id]['tvshowtitle'] = tvshowtitle
             episodes_sorted.append(int(episode_list[episode_id]['episode']))
             episodes_sorted.sort()
 
         # list the episodes
         return self.kodi_helper.build_episode_listing(episodes_sorted=episodes_sorted, episode_list=episode_list, build_url=self.build_url)
 
-    def show_seasons (self, show_id):
+    def show_seasons (self, show_id, tvshowtitle):
         """Lists all seasons for a given show
 
         Parameters
@@ -197,27 +211,25 @@ class Navigation:
         show_id : :obj:`str`
             ID of the show seasons should be displayed for
 
+        tvshowtitle : :obj:`str`
+            title of the show (for listitems' infolabels)
         Returns
         -------
         bool
             If no seasons are available
         """
-        cache_id = 'season_' + show_id
-        if self.kodi_helper.has_cached_item(cache_id=cache_id):
-            season_list = self.kodi_helper.get_cached_item(cache_id=cache_id)
-        else:
-            season_list = self.call_netflix_service({'method': 'fetch_seasons_for_show', 'show_id': show_id})
-            # check for any errors
-            if self._is_dirty_response(response=season_list):
-                return False
-            # check if we have sesons, announced shows that are not available yet have none
-            if len(season_list) == 0:
-                return self.kodi_helper.build_no_seasons_available()
-            # parse the seasons raw response from Netflix
-            self.kodi_helper.add_cached_item(cache_id=cache_id, contents=season_list)
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        season_list = self.call_netflix_service({'method': 'fetch_seasons_for_show', 'show_id': show_id, 'guid': user_data['guid'], 'cache': True})
+        # check for any errors
+        if self._is_dirty_response(response=season_list):
+            return False
+        # check if we have sesons, announced shows that are not available yet have none
+        if len(season_list) == 0:
+            return self.kodi_helper.build_no_seasons_available()
         # sort seasons by index by default (they´re coming back unsorted from the api)
         seasons_sorted = []
         for season_id in season_list:
+            season_list[season_id]['tvshowtitle'] = tvshowtitle
             seasons_sorted.append(int(season_list[season_id]['idx']))
             seasons_sorted.sort()
         return self.kodi_helper.build_season_listing(seasons_sorted=seasons_sorted, season_list=season_list, build_url=self.build_url)
@@ -233,32 +245,21 @@ class Navigation:
         type : :obj:`str`
             None or 'queue' f.e. when it´s a special video lists
         """
-        if self.kodi_helper.has_cached_item(cache_id=video_list_id):
-            video_list = self.kodi_helper.get_cached_item(cache_id=video_list_id)
-        else:
-            video_list = self.call_netflix_service({'method': 'fetch_video_list', 'list_id': video_list_id})
-            # check for any errors
-            if self._is_dirty_response(response=video_list):
-                return False
-            # parse the video list ids
-            if len(video_list) > 0:
-                self.kodi_helper.add_cached_item(cache_id=video_list_id, contents=video_list)
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        video_list = self.call_netflix_service({'method': 'fetch_video_list', 'list_id': video_list_id, 'guid': user_data['guid'] ,'cache': True})
+        # check for any errors
+        if self._is_dirty_response(response=video_list):
+            return False
         actions = {'movie': 'play_video', 'show': 'season_list'}
         return self.kodi_helper.build_video_listing(video_list=video_list, actions=actions, type=type, build_url=self.build_url)
 
     def show_video_lists (self):
         """List the users video lists (recommendations, my list, etc.)"""
-        cache_id='main_menu'
-        if self.kodi_helper.has_cached_item(cache_id=cache_id):
-            video_list_ids = self.kodi_helper.get_cached_item(cache_id=cache_id)
-        else:
-            # fetch video lists
-            video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids'})
-            # check for any errors
-            if self._is_dirty_response(response=video_list_ids):
-                return False
-            # parse the video list ids
-            self.kodi_helper.add_cached_item(cache_id=cache_id, contents=video_list_ids)
+        user_data = self.call_netflix_service({'method': 'get_user_data'})
+        video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'guid': user_data['guid'], 'cache': True})
+        # check for any errors
+        if self._is_dirty_response(response=video_list_ids):
+            return False
         # defines an order for the user list, as Netflix changes the order at every request
         user_list_order = ['queue', 'continueWatching', 'topTen', 'netflixOriginals', 'trendingNow', 'newRelease', 'popularTitles']
         # define where to route the user
@@ -412,7 +413,11 @@ class Navigation:
         # check and switch the profile if needed
         if self.check_for_designated_profile_change(params=params):
             self.kodi_helper.invalidate_memcache()
-            self.call_netflix_service({'method': 'switch_profile', 'profile_id': params['profile_id']})
+            profile_id = params.get('profile_id', None)
+            if profile_id == None:
+                user_data = self.call_netflix_service({'method': 'get_user_data'})
+                profile_id = user_data['guid']
+            self.call_netflix_service({'method': 'switch_profile', 'profile_id': profile_id})
         # check login, in case of main menu
         if 'action' not in params:
             self.establish_session(account=credentials)
@@ -433,9 +438,12 @@ class Navigation:
         """
         # check if we need to switch the user
         user_data = self.call_netflix_service({'method': 'get_user_data'})
+        profiles = self.call_netflix_service({'method': 'list_profiles'})
         if 'guid' not in user_data:
             return False
         current_profile_id = user_data['guid']
+        if profiles.get(current_profile_id).get('isKids', False) == True:
+            return True
         return 'profile_id' in params and current_profile_id != params['profile_id']
 
     def parse_paramters (self, paramstring):
@@ -516,7 +524,7 @@ class Navigation:
         str
             Url + Port
         """
-        return 'http://localhost:' + str(self.kodi_helper.addon.getSetting('netflix_service_port'))
+        return 'http://127.0.0.1:' + str(self.kodi_helper.get_addon().getSetting('netflix_service_port'))
 
     def call_netflix_service (self, params):
         """Makes a GET request to the internal Netflix HTTP proxy and returns the result
@@ -532,8 +540,27 @@ class Navigation:
             Netflix Service RPC result
         """
         url_values = urllib.urlencode(params)
+        # check for cached items
+        if params.get('cache', False) == True:
+            cached_value = self.kodi_helper.get_cached_item(cache_id=url_values)
+
+            # Cache lookup successful?
+            if cached_value != None:
+                self.log(msg='Fetched item from cache: (cache_id=' + url_values + ')')
+                return cached_value
+
         url = self.get_netflix_service_url()
         full_url = url + '?' + url_values
         data = urllib2.urlopen(full_url).read()
         parsed_json = json.loads(data)
-        return parsed_json.get('result', None)
+        result = parsed_json.get('result', None)
+        if params.get('cache', False) == True:
+            self.log(msg='Adding item to cache: (cache_id=' + url_values + ')')
+            self.kodi_helper.add_cached_item(cache_id=url_values, contents=result)
+        return result
+
+    def open_settings(self, url):
+        """Opens a foreign settings dialog"""
+        is_addon = self.kodi_helper.get_inputstream_addon()
+        url = is_addon if url == 'is' else url
+        return Addon(url).openSettings()