-
-
Notifications
You must be signed in to change notification settings - Fork 260
Dev. basic info
It is impossible to draw up a complete list of how this add-on works, so i will add some technical information
Files | Description |
---|---|
/addon.py | Entry points for Kodi, run an addon instance (more than one instance could also be initiated) |
/service.py | Entry points for Kodi, run the addon service (only one instance of the service) |
/lib/globals.py | Used by both entry points, initializes global variables |
Addon folder structure under 'resources' | Description |
---|---|
/language | .po files of the languages supported by the addon GUI |
/lib/api | Shakti and website |
/lib/common | Various utility [can be used at same time in Addon instance and Addon service instance] |
/lib/database | SQLite, MySQL database management |
/lib/kodi | Methods for interact with Kodi mainly used for context menus and library |
/lib/kodi/ui | Classes and methods to handle standard and custom Kodi window dialogs |
/lib/navigation | Handle route navigation between menus, context menu actions, settings actions, play titles |
/lib/services | Contains code used only by the service instance |
/lib/services/msl | Handle MSL Request/Response, Manifest, License, MPD for InputStream |
/lib/services/nfsession | Handle the Netflix web session, path request/response |
/lib/services/playback | Handle everything that is related to the Kodi player info in real time like Skip button dialog, stream continuity, etc... |
/media | Images used by addon itself and for directory items |
/skins | Images and XML used for custom window dialogs |
The DBMS used in this add-on are SQLite for the local databases and MySQL for the (optional) shared library database. SQLite imposes many limitations on database management (e.g. multiple read/write, connections, threads), so to better manage these limits and to make it easier to transition to MySQL, has been chosen to create two local databases.
Database nf_local - Used to store any kind of data except those of the library
Table name | Description |
---|---|
app_config | Contains data for the addon (excluded for library) |
menu_data | Contains temporary data for the management of the various menus/sub-menus of lists |
profiles | Contains the parsed Netflix profiles list *1 |
profiles_config | Contains the parsed Netflix settings of the profiles *1 |
session | Contains data for the currently opened Netflix session |
settings_monitor | Used only by settings_monitor.py the only way to distinguish which settings are changed by the user |
Database nf_shared - Used to store the data for library only, the MySQL side reflects the same scheme
Table name | Description |
---|---|
profiles | A copy of profiles table of the local database *1 |
shared_app_config | Contains the settings for the library |
stream_continuity | Contains data to remember user-selected settings for audio/subtitles of each tv show/movie |
video_lib_episodes | Contains the data of exported episodes |
video_lib_movies | Contains the data of exported movies |
video_lib_seasons | Contains the data of exported seasons |
video_lib_tvshows | Contains the data of exported tv shows |
watched_status_override | Contains the watched status manually set by the user (when is enabled the sync with nf) |
*1 Tables with frequently updated data, therefore these tables must never be used to save other data otherwise they will be deleted.
Unlike linux, iOS/tvOS does not implement or allow the use of some features, creating problems in executing of the source code
These are some known limitations (on Python 2.7, later versions are to be tested):
- There is no "fork", "exec" support for the processes, this breaks the
subprocess
module - Due to missing "fork" there is no full cleanup of process resources (memory, threads, file handles, ...)
- Due to no cleanup of processes can breaks some functionality of module
platform
e.g.machine
,system
,node
- There is no file access outside of application directory
- There is no currently support multi-processing
Why is it currently specified that on iOS/tvOS the add-on is not compatible? Currently the add-on is executable on iOS, but due to the lack of Widevine library, the videos can not be played.
This add-on relies on the website API, so it must be adapted to any changes to the website.
To understand how it sends and obtains data, you must first consider how the website works. A simple start is to start studying the network flow with the browser in debug mode, by analyzing the requests/responses on the pathEvaluator endpoint. The data is freely accessible and complies with the JSONGraph standard.
This API is also called Shakti is the basis on how the add-on makes requests and receives responses.
In addition to this, the website also relies on important parts in javascript. (which i cannot mention to avoid legal problems).
The login system is reproduced via code the one performed by the website.
The security is also taken into account by the add-on, therefore on the net credentials travel encrypted according to the SSL standard, while locally user credentials are stored with AES encryption with an UUID key based on hardware information, therefore related to the hardware in use.
On android the add-on login in the same way, but it would not be correct because the login should be through dedicated API for android. In fact because of this there are some side effects (see workaround for media-flag 4K). These APIs have not been implemented because they require further huge separate study and development.
Considering that there are no documents on which to base ourselves, i will try to explain in short what i currently understand.
There are two ways to work with Netflix profiles, one with the APIs used in "NFSession" (e.g. Shakti) and the other with the MSL APIs. In both cases to be able to activate a profile (therefore to be able to send/receive data with it) we talk about "profile switch".
There are two ways to perform the profile switch the NFSession side, by using:
- Endpoint /SwitchProfile (this allows you to obtain also the profile cookies)
- Endpoint /profiles/switch
In both cases, after making the switch, you must obtain the authURL value. The authURL is required to have access rights to make http requests with the specified profile. The new authURL obtained will need to use for all future NFSession requests.
Here Netflix has implemented a custom MSL user-authentication scheme, (MSL references User Authentication (Configuration), User Authentication) called SWITCH_PROFILE
.
This authentication method, in addition to attaching the user authentication data to the MSL request, instructs the service to activate the specified profile.
Ref PR: The MSL switch profile
This user-authentication scheme works only combined with an user-id-token and can not be used with all endpoints, after use it you will get in the response an user-id-token of the profile specified, that you will need to use for all future MSL requests.
User Documentation
- How install the addon
- Login with Authentication key
- Sync of watched status with Netflix
- FAQ (Audio, Video, Subtitle, Other)
- FAQ (Errors)
- Library settings
- Expert settings
- How to export and sync tv shows and movies in Kodi library
- Share STRM library with multiple devices
- List of 1080P 4k Android tested devices
- My credentials are safe?
- VPN and Proxy
- Key mapping
Development
- Dev. guidelines and philosophy
- Dev. documentation
- Dev. basic info
- Dev. unresolved issues
- Dev. Add-on versioning
- Dev. PyCrypto packages
About