2 # -*- coding: utf-8 -*-
4 # Created on: 13.01.2017
9 from xbmcaddon import Addon
10 from urlparse import parse_qsl
11 from utils import noop, log
14 """Routes to the correct subfolder, dispatches actions & acts as a controller for the Kodi view & the Netflix model"""
16 def __init__ (self, kodi_helper, library, base_url, log_fn=noop):
17 """Takes the instances & configuration options needed to drive the plugin
21 kodi_helper : :obj:`KodiHelper`
22 instance of the KodiHelper class
24 library : :obj:`Library`
25 instance of the Library class
33 self.kodi_helper = kodi_helper
34 self.library = library
35 self.base_url = base_url
39 def router (self, paramstring):
40 """Route to the requested subfolder & dispatch actions along the way
44 paramstring : :obj:`str`
47 params = self.parse_paramters(paramstring=paramstring)
49 # open foreign settings dialog
50 if 'mode' in params.keys() and params['mode'] == 'openSettings':
51 return self.open_settings(params['url'])
54 if 'action' in params.keys() and params['action'] == 'logout':
55 return self.call_netflix_service({'method': 'logout'})
57 # check login & try to relogin if necessary
58 account = self.kodi_helper.get_credentials()
59 if account['email'] != '' and account['password'] != '':
60 if self.call_netflix_service({'method': 'is_logged_in'}) != True:
61 if self.establish_session(account=account) != True:
62 return self.kodi_helper.show_login_failed_notification()
64 # check if we need to execute any actions before the actual routing
65 # gives back a dict of options routes might need
66 options = self.before_routing_action(params=params)
68 # check if one of the before routing options decided to killthe routing
71 if 'action' not in params.keys():
73 return self.show_profiles()
74 elif params['action'] == 'video_lists':
75 # list lists that contain other lists (starting point with recommendations, search, etc.)
76 return self.show_video_lists()
77 elif params['action'] == 'video_list':
78 # show a list of shows/movies
79 type = None if 'type' not in params.keys() else params['type']
80 return self.show_video_list(video_list_id=params['video_list_id'], type=type)
81 elif params['action'] == 'season_list':
82 # list of seasons for a show
83 return self.show_seasons(show_id=params['show_id'])
84 elif params['action'] == 'episode_list':
85 # list of episodes for a season
86 return self.show_episode_list(season_id=params['season_id'])
87 elif params['action'] == 'rating':
88 return self.rate_on_netflix(video_id=params['id'])
89 elif params['action'] == 'remove_from_list':
90 # removes a title from the users list on Netflix
91 self.kodi_helper.invalidate_memcache()
92 return self.remove_from_list(video_id=params['id'])
93 elif params['action'] == 'add_to_list':
94 # adds a title to the users list on Netflix
95 self.kodi_helper.invalidate_memcache()
96 return self.add_to_list(video_id=params['id'])
97 elif params['action'] == 'export':
98 # adds a title to the users list on Netflix
99 alt_title = self.kodi_helper.show_add_to_library_title_dialog(original_title=urllib.unquote(params['title']).decode('utf8'))
100 return self.export_to_library(video_id=params['id'], alt_title=alt_title)
101 elif params['action'] == 'remove':
102 # adds a title to the users list on Netflix
103 return self.remove_from_library(video_id=params['id'])
104 elif params['action'] == 'user-items' and params['type'] != 'search':
105 # display the lists (recommendations, genres, etc.)
106 return self.show_user_list(type=params['type'])
107 elif params['action'] == 'play_video':
108 self.play_video(video_id=params['video_id'], start_offset=params.get('start_offset', -1))
109 elif params['action'] == 'user-items' and params['type'] == 'search':
110 # if the user requested a search, ask for the term
111 term = self.kodi_helper.show_search_term_dialog()
112 return self.show_search_results(term=term)
114 raise ValueError('Invalid paramstring: {0}!'.format(paramstring))
118 def play_video (self, video_id, start_offset):
119 """Starts video playback
121 Note: This is just a dummy, inputstream is needed to play the vids
125 video_id : :obj:`str`
126 ID of the video that should be played
128 start_offset : :obj:`str`
129 Offset to resume playback from (in seconds)
131 esn = self.call_netflix_service({'method': 'get_esn'})
132 return self.kodi_helper.play_item(esn=esn, video_id=video_id, start_offset=start_offset)
135 def show_search_results (self, term):
136 """Display a list of search results
146 If no results are available
148 user_data = self.call_netflix_service({'method': 'get_user_data'})
149 search_contents = self.call_netflix_service({'method': 'search', 'term': term, 'guid': user_data['guid'], 'cache': True})
150 # check for any errors
151 if self._is_dirty_response(response=search_contents):
153 actions = {'movie': 'play_video', 'show': 'season_list'}
154 return self.kodi_helper.build_search_result_listing(video_list=search_contents, actions=actions, build_url=self.build_url)
156 def show_user_list (self, type):
157 """List the users lists for shows/movies for recommendations/genres based on the given type
161 user_list_id : :obj:`str`
162 Type of list to display
164 # determine if we´re in kids mode
165 user_data = self.call_netflix_service({'method': 'get_user_data'})
166 profiles = self.call_netflix_service({'method': 'list_profiles'})
167 is_kids = profiles.get(user_data['guid']).get('isKids', False)
170 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids_for_kids'})
172 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'type': type})
173 # check for any errors
174 if self._is_dirty_response(response=video_list_ids):
176 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)
178 def show_episode_list (self, season_id):
179 """Lists all episodes for a given season
183 season_id : :obj:`str`
184 ID of the season episodes should be displayed for
186 user_data = self.call_netflix_service({'method': 'get_user_data'})
187 episode_list = self.call_netflix_service({'method': 'fetch_episodes_by_season', 'season_id': season_id, 'guid': user_data['guid'], 'cache': True})
188 # check for any errors
189 if self._is_dirty_response(response=episode_list):
191 # sort seasons by number (they´re coming back unsorted from the api)
193 for episode_id in episode_list:
194 episodes_sorted.append(int(episode_list[episode_id]['episode']))
195 episodes_sorted.sort()
198 return self.kodi_helper.build_episode_listing(episodes_sorted=episodes_sorted, episode_list=episode_list, build_url=self.build_url)
200 def show_seasons (self, show_id):
201 """Lists all seasons for a given show
206 ID of the show seasons should be displayed for
211 If no seasons are available
213 user_data = self.call_netflix_service({'method': 'get_user_data'})
214 season_list = self.call_netflix_service({'method': 'fetch_seasons_for_show', 'show_id': show_id, 'guid': user_data['guid'], 'cache': True})
215 # check for any errors
216 if self._is_dirty_response(response=season_list):
218 # check if we have sesons, announced shows that are not available yet have none
219 if len(season_list) == 0:
220 return self.kodi_helper.build_no_seasons_available()
221 # sort seasons by index by default (they´re coming back unsorted from the api)
223 for season_id in season_list:
224 seasons_sorted.append(int(season_list[season_id]['idx']))
225 seasons_sorted.sort()
226 return self.kodi_helper.build_season_listing(seasons_sorted=seasons_sorted, season_list=season_list, build_url=self.build_url)
228 def show_video_list (self, video_list_id, type):
229 """List shows/movies based on the given video list id
233 video_list_id : :obj:`str`
234 ID of the video list that should be displayed
237 None or 'queue' f.e. when it´s a special video lists
239 user_data = self.call_netflix_service({'method': 'get_user_data'})
240 video_list = self.call_netflix_service({'method': 'fetch_video_list', 'list_id': video_list_id, 'guid': user_data['guid'] ,'cache': True})
241 # check for any errors
242 if self._is_dirty_response(response=video_list):
244 actions = {'movie': 'play_video', 'show': 'season_list'}
245 return self.kodi_helper.build_video_listing(video_list=video_list, actions=actions, type=type, build_url=self.build_url)
247 def show_video_lists (self):
248 """List the users video lists (recommendations, my list, etc.)"""
249 # determine if we´re in Kids profile mode
250 user_data = self.call_netflix_service({'method': 'get_user_data'})
251 profiles = self.call_netflix_service({'method': 'list_profiles'})
252 is_kids = profiles.get(user_data['guid']).get('isKids', False)
255 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids_for_kids', 'guid': user_data['guid'], 'cache': True})
257 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'guid': user_data['guid'], 'cache': True})
259 # check for any errors
260 if self._is_dirty_response(response=video_list_ids):
262 # defines an order for the user list, as Netflix changes the order at every request
263 user_list_order = ['queue', 'continueWatching', 'topTen', 'netflixOriginals', 'trendingNow', 'newRelease', 'popularTitles']
264 # define where to route the user
265 actions = {'recommendations': 'user-items', 'genres': 'user-items', 'search': 'user-items', 'default': 'video_list'}
266 return self.kodi_helper.build_main_menu_listing(video_list_ids=video_list_ids, user_list_order=user_list_order, actions=actions, build_url=self.build_url)
269 def show_profiles (self):
270 """List the profiles for the active account"""
271 profiles = self.call_netflix_service({'method': 'list_profiles'})
272 if len(profiles) == 0:
273 return self.kodi_helper.show_login_failed_notification()
274 return self.kodi_helper.build_profiles_listing(profiles=profiles, action='video_lists', build_url=self.build_url)
277 def rate_on_netflix (self, video_id):
278 """Rate a show/movie/season/episode on Netflix
282 video_list_id : :obj:`str`
283 ID of the video list that should be displayed
285 rating = self.kodi_helper.show_rating_dialog()
286 return self.call_netflix_service({'method': 'rate_video', 'video_id': video_id, 'rating': rating})
289 def remove_from_list (self, video_id):
290 """Remove an item from 'My List' & refresh the view
294 video_list_id : :obj:`str`
295 ID of the video list that should be displayed
297 self.call_netflix_service({'method': 'remove_from_list', 'video_id': video_id})
298 return self.kodi_helper.refresh()
301 def add_to_list (self, video_id):
302 """Add an item to 'My List' & refresh the view
306 video_list_id : :obj:`str`
307 ID of the video list that should be displayed
309 self.call_netflix_service({'method': 'add_to_list', 'video_id': video_id})
310 return self.kodi_helper.refresh()
313 def export_to_library (self, video_id, alt_title):
314 """Adds an item to the local library
318 video_id : :obj:`str`
319 ID of the movie or show
321 alt_title : :obj:`str`
322 Alternative title (for the folder written to disc)
324 metadata = self.call_netflix_service({'method': 'fetch_metadata', 'video_id': video_id})
325 # check for any errors
326 if self._is_dirty_response(response=metadata):
328 video = metadata['video']
330 if video['type'] == 'movie':
331 self.library.add_movie(title=video['title'], alt_title=alt_title, year=video['year'], video_id=video_id, build_url=self.build_url)
332 if video['type'] == 'show':
334 for season in video['seasons']:
335 for episode in season['episodes']:
336 episodes.append({'season': season['seq'], 'episode': episode['seq'], 'id': episode['id']})
338 self.library.add_show(title=video['title'], alt_title=alt_title, episodes=episodes, build_url=self.build_url)
339 return self.kodi_helper.refresh()
342 def remove_from_library (self, video_id, season=None, episode=None):
343 """Removes an item from the local library
347 video_id : :obj:`str`
348 ID of the movie or show
350 metadata = self.call_netflix_service({'method': 'fetch_metadata', 'video_id': video_id})
351 # check for any errors
352 if self._is_dirty_response(response=metadata):
354 video = metadata['video']
356 if video['type'] == 'movie':
357 self.library.remove_movie(title=video['title'], year=video['year'])
358 if video['type'] == 'show':
359 self.library.remove_show(title=video['title'])
360 return self.kodi_helper.refresh()
363 def establish_session(self, account):
364 """Checks if we have an cookie with an active sessions, otherwise tries to login the user
368 account : :obj:`dict` of :obj:`str`
369 Dict containing an email & a password property
374 If we don't have an active session & the user couldn't be logged in
376 is_logged_in = self.call_netflix_service({'method': 'is_logged_in'})
377 return True if is_logged_in else self.call_netflix_service({'method': 'login', 'email': account['email'], 'password': account['password']})
380 def before_routing_action (self, params):
381 """Executes actions before the actual routing takes place:
383 - Check if account data has been stored, if not, asks for it
384 - Check if the profile should be changed (and changes if so)
385 - Establishes a session if no action route is given
389 params : :obj:`dict` of :obj:`str`
394 :obj:`dict` of :obj:`str`
395 Options that can be provided by this hook & used later in the routing process
398 credentials = self.kodi_helper.get_credentials()
399 # check if we have user settings, if not, set em
400 if credentials['email'] == '':
401 email = self.kodi_helper.show_email_dialog()
402 self.kodi_helper.set_setting(key='email', value=email)
403 credentials['email'] = email
404 if credentials['password'] == '':
405 password = self.kodi_helper.show_password_dialog()
406 self.kodi_helper.set_setting(key='password', value=password)
407 credentials['password'] = password
408 # persist & load main menu selection
410 self.kodi_helper.set_main_menu_selection(type=params['type'])
411 options['main_menu_selection'] = self.kodi_helper.get_main_menu_selection()
412 # check and switch the profile if needed
413 if self.check_for_designated_profile_change(params=params):
414 self.kodi_helper.invalidate_memcache()
415 profile_id = params.get('profile_id', None)
416 if profile_id == None:
417 user_data = self.call_netflix_service({'method': 'get_user_data'})
418 profile_id = user_data['guid']
419 self.call_netflix_service({'method': 'switch_profile', 'profile_id': profile_id})
420 # check login, in case of main menu
421 if 'action' not in params:
422 self.establish_session(account=credentials)
425 def check_for_designated_profile_change (self, params):
426 """Checks if the profile needs to be switched
430 params : :obj:`dict` of :obj:`str`
436 Profile should be switched or not
438 # check if we need to switch the user
439 user_data = self.call_netflix_service({'method': 'get_user_data'})
440 profiles = self.call_netflix_service({'method': 'list_profiles'})
441 if 'guid' not in user_data:
443 current_profile_id = user_data['guid']
444 if profiles.get(current_profile_id).get('isKids', False) == True:
446 return 'profile_id' in params and current_profile_id != params['profile_id']
448 def parse_paramters (self, paramstring):
449 """Tiny helper to convert a url paramstring into a dictionary
453 paramstring : :obj:`str`
454 Url query params (in url string notation)
458 :obj:`dict` of :obj:`str`
459 Url query params (as a dictionary)
461 return dict(parse_qsl(paramstring))
463 def _is_expired_session (self, response):
464 """Checks if a response error is based on an invalid session
468 response : :obj:`dict` of :obj:`str`
469 Error response object
474 Error is based on an invalid session
476 return 'error' in response and 'code' in response and str(response['code']) == '401'
478 def _is_dirty_response (self, response):
479 """Checks if a response contains an error & if the error is based on an invalid session, it tries a relogin
483 response : :obj:`dict` of :obj:`str`
484 Success response object or Error response object
489 Response contains error or not
491 # check for any errors
492 if 'error' in response:
493 # check if we do not have a valid session, in case that happens: (re)login
494 if self._is_expired_session(response=response):
495 if self.establish_session(account=self.kodi_helper.get_credentials()):
497 message = response['message'] if 'message' in response else ''
498 code = response['code'] if 'code' in response else ''
499 self.log(msg='[ERROR]: ' + message + '::' + str(code))
503 def build_url(self, query):
504 """Tiny helper to transform a dict into a url + querystring
508 query : :obj:`dict` of :obj:`str`
509 List of paramters to be url encoded
514 Url + querystring based on the param
516 return self.base_url + '?' + urllib.urlencode(query)
518 def get_netflix_service_url (self):
519 """Returns URL & Port of the internal Netflix HTTP Proxy service
526 return 'http://localhost:' + str(self.kodi_helper.addon.getSetting('netflix_service_port'))
528 def call_netflix_service (self, params):
529 """Makes a GET request to the internal Netflix HTTP proxy and returns the result
533 params : :obj:`dict` of :obj:`str`
534 List of paramters to be url encoded
539 Netflix Service RPC result
541 url_values = urllib.urlencode(params)
542 # check for cached items
543 if self.kodi_helper.has_cached_item(cache_id=url_values) and params.get('cache', False) == True:
544 self.log(msg='Fetching item from cache: (cache_id=' + url_values + ')')
545 return self.kodi_helper.get_cached_item(cache_id=url_values)
546 url = self.get_netflix_service_url()
547 full_url = url + '?' + url_values
548 data = urllib2.urlopen(full_url).read()
549 parsed_json = json.loads(data)
550 result = parsed_json.get('result', None)
551 if params.get('cache', False) == True:
552 self.log(msg='Adding item to cache: (cache_id=' + url_values + ')')
553 self.kodi_helper.add_cached_item(cache_id=url_values, contents=result)
556 def open_settings(self, url):
557 """Opens a foreign settings dialog"""
558 is_addon = self.kodi_helper.get_inputstream_addon()
559 url = is_addon if url == 'is' else url
560 return Addon(url).openSettings()