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 search_contents = self.call_netflix_service({'method': 'search', 'term': term})
149 # check for any errors
150 if self._is_dirty_response(response=search_contents):
152 actions = {'movie': 'play_video', 'show': 'season_list'}
153 return self.kodi_helper.build_search_result_listing(video_list=search_contents, actions=actions, build_url=self.build_url)
155 def show_user_list (self, type):
156 """List the users lists for shows/movies for recommendations/genres based on the given type
160 user_list_id : :obj:`str`
161 Type of list to display
163 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids', 'type': type})
164 # check for any errors
165 if self._is_dirty_response(response=video_list_ids):
167 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)
169 def show_episode_list (self, season_id):
170 """Lists all episodes for a given season
174 season_id : :obj:`str`
175 ID of the season episodes should be displayed for
177 cache_id = 'episodes_' + season_id
178 if self.kodi_helper.has_cached_item(cache_id=cache_id):
179 episode_list = self.kodi_helper.get_cached_item(cache_id=cache_id)
181 episode_list = self.call_netflix_service({'method': 'fetch_episodes_by_season', 'season_id': season_id})
182 # check for any errors
183 if self._is_dirty_response(response=episode_list):
185 # parse the raw Netflix data
186 self.kodi_helper.add_cached_item(cache_id=cache_id, contents=episode_list)
188 # sort seasons by number (they´re coming back unsorted from the api)
190 for episode_id in episode_list:
191 episodes_sorted.append(int(episode_list[episode_id]['episode']))
192 episodes_sorted.sort()
195 return self.kodi_helper.build_episode_listing(episodes_sorted=episodes_sorted, episode_list=episode_list, build_url=self.build_url)
197 def show_seasons (self, show_id):
198 """Lists all seasons for a given show
203 ID of the show seasons should be displayed for
208 If no seasons are available
210 cache_id = 'season_' + show_id
211 if self.kodi_helper.has_cached_item(cache_id=cache_id):
212 season_list = self.kodi_helper.get_cached_item(cache_id=cache_id)
214 season_list = self.call_netflix_service({'method': 'fetch_seasons_for_show', 'show_id': show_id})
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 # parse the seasons raw response from Netflix
222 self.kodi_helper.add_cached_item(cache_id=cache_id, contents=season_list)
223 # sort seasons by index by default (they´re coming back unsorted from the api)
225 for season_id in season_list:
226 seasons_sorted.append(int(season_list[season_id]['idx']))
227 seasons_sorted.sort()
228 return self.kodi_helper.build_season_listing(seasons_sorted=seasons_sorted, season_list=season_list, build_url=self.build_url)
230 def show_video_list (self, video_list_id, type):
231 """List shows/movies based on the given video list id
235 video_list_id : :obj:`str`
236 ID of the video list that should be displayed
239 None or 'queue' f.e. when it´s a special video lists
241 if self.kodi_helper.has_cached_item(cache_id=video_list_id):
242 video_list = self.kodi_helper.get_cached_item(cache_id=video_list_id)
244 video_list = self.call_netflix_service({'method': 'fetch_video_list', 'list_id': video_list_id})
245 # check for any errors
246 if self._is_dirty_response(response=video_list):
248 # parse the video list ids
249 if len(video_list) > 0:
250 self.kodi_helper.add_cached_item(cache_id=video_list_id, contents=video_list)
251 actions = {'movie': 'play_video', 'show': 'season_list'}
252 return self.kodi_helper.build_video_listing(video_list=video_list, actions=actions, type=type, build_url=self.build_url)
254 def show_video_lists (self):
255 """List the users video lists (recommendations, my list, etc.)"""
257 if self.kodi_helper.has_cached_item(cache_id=cache_id):
258 video_list_ids = self.kodi_helper.get_cached_item(cache_id=cache_id)
261 video_list_ids = self.call_netflix_service({'method': 'fetch_video_list_ids'})
262 # check for any errors
263 if self._is_dirty_response(response=video_list_ids):
265 # parse the video list ids
266 self.kodi_helper.add_cached_item(cache_id=cache_id, contents=video_list_ids)
267 # defines an order for the user list, as Netflix changes the order at every request
268 user_list_order = ['queue', 'continueWatching', 'topTen', 'netflixOriginals', 'trendingNow', 'newRelease', 'popularTitles']
269 # define where to route the user
270 actions = {'recommendations': 'user-items', 'genres': 'user-items', 'search': 'user-items', 'default': 'video_list'}
271 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)
274 def show_profiles (self):
275 """List the profiles for the active account"""
276 profiles = self.call_netflix_service({'method': 'list_profiles'})
277 if len(profiles) == 0:
278 return self.kodi_helper.show_login_failed_notification()
279 return self.kodi_helper.build_profiles_listing(profiles=profiles, action='video_lists', build_url=self.build_url)
282 def rate_on_netflix (self, video_id):
283 """Rate a show/movie/season/episode on Netflix
287 video_list_id : :obj:`str`
288 ID of the video list that should be displayed
290 rating = self.kodi_helper.show_rating_dialog()
291 return self.call_netflix_service({'method': 'rate_video', 'video_id': video_id, 'rating': rating})
294 def remove_from_list (self, video_id):
295 """Remove an item from 'My List' & refresh the view
299 video_list_id : :obj:`str`
300 ID of the video list that should be displayed
302 self.call_netflix_service({'method': 'remove_from_list', 'video_id': video_id})
303 return self.kodi_helper.refresh()
306 def add_to_list (self, video_id):
307 """Add an item to 'My List' & refresh the view
311 video_list_id : :obj:`str`
312 ID of the video list that should be displayed
314 self.call_netflix_service({'method': 'add_to_list', 'video_id': video_id})
315 return self.kodi_helper.refresh()
318 def export_to_library (self, video_id, alt_title):
319 """Adds an item to the local library
323 video_id : :obj:`str`
324 ID of the movie or show
326 alt_title : :obj:`str`
327 Alternative title (for the folder written to disc)
329 metadata = self.call_netflix_service({'method': 'fetch_metadata', 'video_id': video_id})
330 # check for any errors
331 if self._is_dirty_response(response=metadata):
333 video = metadata['video']
335 if video['type'] == 'movie':
336 self.library.add_movie(title=video['title'], alt_title=alt_title, year=video['year'], video_id=video_id, build_url=self.build_url)
337 if video['type'] == 'show':
339 for season in video['seasons']:
340 for episode in season['episodes']:
341 episodes.append({'season': season['seq'], 'episode': episode['seq'], 'id': episode['id']})
343 self.library.add_show(title=video['title'], alt_title=alt_title, episodes=episodes, build_url=self.build_url)
344 return self.kodi_helper.refresh()
347 def remove_from_library (self, video_id, season=None, episode=None):
348 """Removes an item from the local library
352 video_id : :obj:`str`
353 ID of the movie or show
355 metadata = self.call_netflix_service({'method': 'fetch_metadata', 'video_id': video_id})
356 # check for any errors
357 if self._is_dirty_response(response=metadata):
359 video = metadata['video']
361 if video['type'] == 'movie':
362 self.library.remove_movie(title=video['title'], year=video['year'])
363 if video['type'] == 'show':
364 self.library.remove_show(title=video['title'])
365 return self.kodi_helper.refresh()
368 def establish_session(self, account):
369 """Checks if we have an cookie with an active sessions, otherwise tries to login the user
373 account : :obj:`dict` of :obj:`str`
374 Dict containing an email & a password property
379 If we don't have an active session & the user couldn't be logged in
381 is_logged_in = self.call_netflix_service({'method': 'is_logged_in'})
382 return True if is_logged_in else self.call_netflix_service({'method': 'login', 'email': account['email'], 'password': account['password']})
385 def before_routing_action (self, params):
386 """Executes actions before the actual routing takes place:
388 - Check if account data has been stored, if not, asks for it
389 - Check if the profile should be changed (and changes if so)
390 - Establishes a session if no action route is given
394 params : :obj:`dict` of :obj:`str`
399 :obj:`dict` of :obj:`str`
400 Options that can be provided by this hook & used later in the routing process
403 credentials = self.kodi_helper.get_credentials()
404 # check if we have user settings, if not, set em
405 if credentials['email'] == '':
406 email = self.kodi_helper.show_email_dialog()
407 self.kodi_helper.set_setting(key='email', value=email)
408 credentials['email'] = email
409 if credentials['password'] == '':
410 password = self.kodi_helper.show_password_dialog()
411 self.kodi_helper.set_setting(key='password', value=password)
412 credentials['password'] = password
413 # persist & load main menu selection
415 self.kodi_helper.set_main_menu_selection(type=params['type'])
416 options['main_menu_selection'] = self.kodi_helper.get_main_menu_selection()
417 # check and switch the profile if needed
418 if self.check_for_designated_profile_change(params=params):
419 self.kodi_helper.invalidate_memcache()
420 self.call_netflix_service({'method': 'switch_profile', 'profile_id': params['profile_id']})
421 # check login, in case of main menu
422 if 'action' not in params:
423 self.establish_session(account=credentials)
426 def check_for_designated_profile_change (self, params):
427 """Checks if the profile needs to be switched
431 params : :obj:`dict` of :obj:`str`
437 Profile should be switched or not
439 # check if we need to switch the user
440 user_data = self.call_netflix_service({'method': 'get_user_data'})
441 if 'guid' not in user_data:
443 current_profile_id = user_data['guid']
444 return 'profile_id' in params and current_profile_id != params['profile_id']
446 def parse_paramters (self, paramstring):
447 """Tiny helper to convert a url paramstring into a dictionary
451 paramstring : :obj:`str`
452 Url query params (in url string notation)
456 :obj:`dict` of :obj:`str`
457 Url query params (as a dictionary)
459 return dict(parse_qsl(paramstring))
461 def _is_expired_session (self, response):
462 """Checks if a response error is based on an invalid session
466 response : :obj:`dict` of :obj:`str`
467 Error response object
472 Error is based on an invalid session
474 return 'error' in response and 'code' in response and str(response['code']) == '401'
476 def _is_dirty_response (self, response):
477 """Checks if a response contains an error & if the error is based on an invalid session, it tries a relogin
481 response : :obj:`dict` of :obj:`str`
482 Success response object or Error response object
487 Response contains error or not
489 # check for any errors
490 if 'error' in response:
491 # check if we do not have a valid session, in case that happens: (re)login
492 if self._is_expired_session(response=response):
493 if self.establish_session(account=self.kodi_helper.get_credentials()):
495 message = response['message'] if 'message' in response else ''
496 code = response['code'] if 'code' in response else ''
497 self.log(msg='[ERROR]: ' + message + '::' + str(code))
501 def build_url(self, query):
502 """Tiny helper to transform a dict into a url + querystring
506 query : :obj:`dict` of :obj:`str`
507 List of paramters to be url encoded
512 Url + querystring based on the param
514 return self.base_url + '?' + urllib.urlencode(query)
516 def get_netflix_service_url (self):
517 """Returns URL & Port of the internal Netflix HTTP Proxy service
524 return 'http://localhost:' + str(self.kodi_helper.addon.getSetting('netflix_service_port'))
526 def call_netflix_service (self, params):
527 """Makes a GET request to the internal Netflix HTTP proxy and returns the result
531 params : :obj:`dict` of :obj:`str`
532 List of paramters to be url encoded
537 Netflix Service RPC result
539 url_values = urllib.urlencode(params)
540 url = self.get_netflix_service_url()
541 full_url = url + '?' + url_values
542 data = urllib2.urlopen(full_url).read()
543 parsed_json = json.loads(data)
544 return parsed_json.get('result', None)
546 def open_settings(self, url):
547 """Opens a foreign settings dialog"""
548 is_addon = self.kodi_helper.get_inputstream_addon()
549 url = is_addon if url == 'is' else url
550 return Addon(url).openSettings()