jellyfin-kodi/resources/lib/userclient.py

487 lines
15 KiB
Python
Raw Normal View History

2015-12-24 20:07:00 +00:00
# -*- coding: utf-8 -*-
##################################################################################################
import hashlib
import threading
import xbmc
import xbmcgui
import xbmcaddon
import xbmcvfs
import artwork
import utils
import clientinfo
import downloadutils
##################################################################################################
class UserClient(threading.Thread):
# Borg - multiple instances, shared state
_shared_state = {}
stopClient = False
auth = True
retry = 0
currUser = None
currUserId = None
currServer = None
currToken = None
HasAccess = True
AdditionalUser = []
userSettings = None
def __init__(self):
self.__dict__ = self._shared_state
self.addon = xbmcaddon.Addon()
self.addonName = clientinfo.ClientInfo().getAddonName()
self.doUtils = downloadutils.DownloadUtils()
threading.Thread.__init__(self)
def logMsg(self, msg, lvl=1):
className = self.__class__.__name__
utils.logMsg("%s %s" % (self.addonName, className), msg, lvl)
def getAdditionalUsers(self):
additionalUsers = utils.settings('additionalUsers')
if additionalUsers:
self.AdditionalUser = additionalUsers.split(',')
def getUsername(self):
username = utils.settings('username')
if not username:
self.logMsg("No username saved.", 2)
return ""
return username
def getLogLevel(self):
try:
logLevel = int(utils.settings('logLevel'))
except ValueError:
logLevel = 0
return logLevel
def getUserId(self):
2016-02-17 08:13:37 +00:00
log = self.logMsg
window = utils.window
settings = utils.settings
2015-12-24 20:07:00 +00:00
username = self.getUsername()
2016-02-17 08:13:37 +00:00
w_userId = window('emby_currUser')
s_userId = settings('userId%s' % username)
2015-12-24 20:07:00 +00:00
# Verify the window property
if w_userId:
if not s_userId:
# Save access token if it's missing from settings
2016-02-17 08:13:37 +00:00
settings('userId%s' % username, value=w_userId)
log("Returning userId from WINDOW for username: %s UserId: %s"
2015-12-24 20:07:00 +00:00
% (username, w_userId), 2)
return w_userId
# Verify the settings
elif s_userId:
2016-02-17 08:13:37 +00:00
log("Returning userId from SETTINGS for username: %s userId: %s"
2015-12-24 20:07:00 +00:00
% (username, s_userId), 2)
return s_userId
# No userId found
else:
2016-02-17 08:13:37 +00:00
log("No userId saved for username: %s." % username, 1)
2015-12-24 20:07:00 +00:00
def getServer(self, prefix=True):
2016-02-17 08:13:37 +00:00
settings = utils.settings
alternate = settings('altip') == "true"
2015-12-24 20:07:00 +00:00
if alternate:
# Alternate host
2016-02-17 08:13:37 +00:00
HTTPS = settings('secondhttps') == "true"
host = settings('secondipaddress')
port = settings('secondport')
2015-12-24 20:07:00 +00:00
else:
# Original host
2016-02-17 08:13:37 +00:00
HTTPS = settings('https') == "true"
host = settings('ipaddress')
port = settings('port')
2015-12-24 20:07:00 +00:00
server = host + ":" + port
if not host:
self.logMsg("No server information saved.", 2)
return False
# If https is true
if prefix and HTTPS:
server = "https://%s" % server
return server
# If https is false
elif prefix and not HTTPS:
server = "http://%s" % server
return server
# If only the host:port is required
elif not prefix:
return server
def getToken(self):
2016-02-17 08:13:37 +00:00
log = self.logMsg
window = utils.window
settings = utils.settings
2015-12-24 20:07:00 +00:00
username = self.getUsername()
2016-02-17 08:13:37 +00:00
userId = self.getUserId()
w_token = window('emby_accessToken%s' % userId)
s_token = settings('accessToken')
2015-12-24 20:07:00 +00:00
# Verify the window property
if w_token:
if not s_token:
# Save access token if it's missing from settings
2016-02-17 08:13:37 +00:00
settings('accessToken', value=w_token)
log("Returning accessToken from WINDOW for username: %s accessToken: %s"
2015-12-24 20:07:00 +00:00
% (username, w_token), 2)
return w_token
# Verify the settings
elif s_token:
2016-02-17 08:13:37 +00:00
log("Returning accessToken from SETTINGS for username: %s accessToken: %s"
2015-12-24 20:07:00 +00:00
% (username, s_token), 2)
2016-02-17 08:13:37 +00:00
window('emby_accessToken%s' % username, value=s_token)
2015-12-24 20:07:00 +00:00
return s_token
else:
2016-02-17 08:13:37 +00:00
log("No token found.", 1)
2015-12-24 20:07:00 +00:00
return ""
def getSSLverify(self):
# Verify host certificate
2016-02-17 08:13:37 +00:00
settings = utils.settings
s_sslverify = settings('sslverify')
if settings('altip') == "true":
s_sslverify = settings('secondsslverify')
2015-12-24 20:07:00 +00:00
if s_sslverify == "true":
return True
else:
return False
def getSSL(self):
# Client side certificate
2016-02-17 08:13:37 +00:00
settings = utils.settings
s_cert = settings('sslcert')
if settings('altip') == "true":
s_cert = settings('secondsslcert')
2015-12-24 20:07:00 +00:00
if s_cert == "None":
return None
else:
return s_cert
def setUserPref(self):
2016-02-17 08:13:37 +00:00
doUtils = self.doUtils.downloadUrl
2015-12-24 22:16:58 +00:00
art = artwork.Artwork()
2015-12-24 20:07:00 +00:00
url = "{server}/emby/Users/{UserId}?format=json"
2016-02-17 08:13:37 +00:00
result = doUtils(url)
2015-12-24 20:07:00 +00:00
self.userSettings = result
# Set user image for skin display
if result.get('PrimaryImageTag'):
2015-12-24 22:16:58 +00:00
utils.window('EmbyUserImage', value=art.getUserArtwork(result['Id'], 'Primary'))
2015-12-24 20:07:00 +00:00
# Set resume point max
url = "{server}/emby/System/Configuration?format=json"
2016-02-17 08:13:37 +00:00
result = doUtils(url)
2015-12-24 20:07:00 +00:00
utils.settings('markPlayed', value=str(result['MaxResumePct']))
def getPublicUsers(self):
server = self.getServer()
# Get public Users
url = "%s/emby/Users/Public?format=json" % server
result = self.doUtils.downloadUrl(url, authenticate=False)
if result != "":
return result
else:
# Server connection failed
return False
def hasAccess(self):
# hasAccess is verified in service.py
2016-02-17 08:13:37 +00:00
log = self.logMsg
window = utils.window
2015-12-24 20:07:00 +00:00
url = "{server}/emby/Users?format=json"
result = self.doUtils.downloadUrl(url)
if result == False:
# Access is restricted, set in downloadutils.py via exception
2016-02-17 08:13:37 +00:00
log("Access is restricted.", 1)
2015-12-24 20:07:00 +00:00
self.HasAccess = False
2016-02-17 08:13:37 +00:00
elif window('emby_online') != "true":
2015-12-24 20:07:00 +00:00
# Server connection failed
pass
2016-02-17 08:13:37 +00:00
elif window('emby_serverStatus') == "restricted":
log("Access is granted.", 1)
2015-12-24 20:07:00 +00:00
self.HasAccess = True
2016-02-17 08:13:37 +00:00
window('emby_serverStatus', clear=True)
xbmcgui.Dialog().notification("Emby for Kodi", utils.language(33007))
2015-12-24 20:07:00 +00:00
def loadCurrUser(self, authenticated=False):
2016-02-17 08:13:37 +00:00
window = utils.window
2015-12-24 20:07:00 +00:00
doUtils = self.doUtils
username = self.getUsername()
userId = self.getUserId()
# Only to be used if token exists
self.currUserId = userId
self.currServer = self.getServer()
self.currToken = self.getToken()
self.ssl = self.getSSLverify()
self.sslcert = self.getSSL()
# Test the validity of current token
if authenticated == False:
url = "%s/emby/Users/%s?format=json" % (self.currServer, userId)
2016-02-17 08:13:37 +00:00
window('emby_currUser', value=userId)
window('emby_accessToken%s' % userId, value=self.currToken)
2015-12-24 20:07:00 +00:00
result = doUtils.downloadUrl(url)
if result == 401:
# Token is no longer valid
self.resetClient()
return False
# Set to windows property
2016-02-17 08:13:37 +00:00
window('emby_currUser', value=userId)
window('emby_accessToken%s' % userId, value=self.currToken)
window('emby_server%s' % userId, value=self.currServer)
window('emby_server_%s' % userId, value=self.getServer(prefix=False))
2015-12-24 20:07:00 +00:00
# Set DownloadUtils values
doUtils.setUsername(username)
doUtils.setUserId(self.currUserId)
doUtils.setServer(self.currServer)
doUtils.setToken(self.currToken)
doUtils.setSSL(self.ssl, self.sslcert)
# parental control - let's verify if access is restricted
self.hasAccess()
# Start DownloadUtils session
doUtils.startSession()
self.getAdditionalUsers()
# Set user preferences in settings
self.currUser = username
self.setUserPref()
def authenticate(self):
2016-02-17 08:13:37 +00:00
log = self.logMsg
lang = utils.language
window = utils.window
settings = utils.settings
dialog = xbmcgui.Dialog()
2015-12-24 20:07:00 +00:00
# Get /profile/addon_data
addondir = xbmc.translatePath(self.addon.getAddonInfo('profile')).decode('utf-8')
hasSettings = xbmcvfs.exists("%ssettings.xml" % addondir)
username = self.getUsername()
server = self.getServer()
# If there's no settings.xml
if not hasSettings:
2016-02-17 08:13:37 +00:00
log("No settings.xml found.", 1)
2015-12-24 20:07:00 +00:00
self.auth = False
return
# If no user information
elif not server or not username:
2016-02-17 08:13:37 +00:00
log("Missing server information.", 1)
2015-12-24 20:07:00 +00:00
self.auth = False
return
# If there's a token, load the user
elif self.getToken():
result = self.loadCurrUser()
if result == False:
pass
else:
2016-02-17 08:13:37 +00:00
log("Current user: %s" % self.currUser, 1)
log("Current userId: %s" % self.currUserId, 1)
log("Current accessToken: %s" % self.currToken, 2)
2015-12-24 20:07:00 +00:00
return
##### AUTHENTICATE USER #####
users = self.getPublicUsers()
password = ""
# Find user in list
for user in users:
name = user['Name']
if username.decode('utf-8') in name:
# If user has password
if user['HasPassword'] == True:
2016-02-17 08:13:37 +00:00
password = dialog.input(
heading="%s %s" % (lang(33008), username),
2015-12-24 20:07:00 +00:00
option=xbmcgui.ALPHANUM_HIDE_INPUT)
# If password dialog is cancelled
if not password:
2016-02-17 08:13:37 +00:00
log("No password entered.", 0)
window('emby_serverStatus', value="Stop")
2015-12-24 20:07:00 +00:00
self.auth = False
return
break
else:
# Manual login, user is hidden
2016-02-17 08:13:37 +00:00
password = dialog.input(
heading="%s %s" % (lang(33008), username),
option=xbmcgui.ALPHANUM_HIDE_INPUT)
2015-12-24 20:07:00 +00:00
sha1 = hashlib.sha1(password)
sha1 = sha1.hexdigest()
# Authenticate username and password
url = "%s/emby/Users/AuthenticateByName?format=json" % server
data = {'username': username, 'password': sha1}
2016-02-17 08:13:37 +00:00
log(data, 2)
2015-12-24 20:07:00 +00:00
result = self.doUtils.downloadUrl(url, postBody=data, type="POST", authenticate=False)
try:
2016-02-17 08:13:37 +00:00
log("Auth response: %s" % result, 1)
2015-12-24 20:07:00 +00:00
accessToken = result['AccessToken']
except (KeyError, TypeError):
2016-02-17 08:13:37 +00:00
log("Failed to retrieve the api key.", 1)
2015-12-24 20:07:00 +00:00
accessToken = None
if accessToken is not None:
self.currUser = username
2016-02-18 18:09:36 +00:00
dialog.notification("Emby for Kodi",
"%s %s!" % (lang(33000), self.currUser.decode('utf-8')))
2015-12-24 20:07:00 +00:00
userId = result['User']['Id']
2016-02-17 08:13:37 +00:00
settings('accessToken', value=accessToken)
settings('userId%s' % username, value=userId)
log("User Authenticated: %s" % accessToken, 1)
2015-12-24 20:07:00 +00:00
self.loadCurrUser(authenticated=True)
2016-02-17 08:13:37 +00:00
window('emby_serverStatus', clear=True)
2015-12-24 20:07:00 +00:00
self.retry = 0
else:
2016-02-17 08:13:37 +00:00
log("User authentication failed.", 1)
settings('accessToken', value="")
settings('userId%s' % username, value="")
dialog.ok(lang(33001), lang(33009))
2015-12-24 20:07:00 +00:00
# Give two attempts at entering password
if self.retry == 2:
2016-02-17 08:13:37 +00:00
log("Too many retries. "
"You can retry by resetting attempts in the addon settings.", 1)
window('emby_serverStatus', value="Stop")
dialog.ok(lang(33001), lang(33010))
2015-12-24 20:07:00 +00:00
self.retry += 1
self.auth = False
def resetClient(self):
2016-02-17 08:13:37 +00:00
log = self.logMsg
log("Reset UserClient authentication.", 1)
userId = self.getUserId()
2015-12-24 20:07:00 +00:00
if self.currToken is not None:
# In case of 401, removed saved token
utils.settings('accessToken', value="")
2016-02-17 08:13:37 +00:00
utils.window('emby_accessToken%s' % userId, clear=True)
2015-12-24 20:07:00 +00:00
self.currToken = None
2016-02-17 08:13:37 +00:00
log("User token has been removed.", 1)
2015-12-24 20:07:00 +00:00
self.auth = True
self.currUser = None
def run(self):
2016-02-17 08:13:37 +00:00
log = self.logMsg
window = utils.window
2015-12-24 20:07:00 +00:00
monitor = xbmc.Monitor()
2016-02-17 08:13:37 +00:00
log("----===## Starting UserClient ##===----", 0)
2015-12-24 20:07:00 +00:00
while not monitor.abortRequested():
2016-02-17 08:13:37 +00:00
status = window('emby_serverStatus')
2015-12-24 20:07:00 +00:00
if status:
# Verify the connection status to server
if status == "restricted":
# Parental control is restricting access
self.HasAccess = False
elif status == "401":
# Unauthorized access, revoke token
2016-02-17 08:13:37 +00:00
window('emby_serverStatus', value="Auth")
2015-12-24 20:07:00 +00:00
self.resetClient()
if self.auth and (self.currUser is None):
# Try to authenticate user
2016-02-17 08:13:37 +00:00
status = window('emby_serverStatus')
2015-12-24 20:07:00 +00:00
if not status or status == "Auth":
# Set auth flag because we no longer need
# to authenticate the user
self.auth = False
self.authenticate()
if not self.auth and (self.currUser is None):
# If authenticate failed.
server = self.getServer()
username = self.getUsername()
2016-02-17 08:13:37 +00:00
status = window('emby_serverStatus')
2015-12-24 20:07:00 +00:00
# The status Stop is for when user cancelled password dialog.
if server and username and status != "Stop":
# Only if there's information found to login
2016-02-17 08:13:37 +00:00
log("Server found: %s" % server, 2)
log("Username found: %s" % username, 2)
2015-12-24 20:07:00 +00:00
self.auth = True
if self.stopClient == True:
# If stopping the client didn't work
break
if monitor.waitForAbort(1):
# Abort was requested while waiting. We should exit
break
2016-02-17 08:13:37 +00:00
self.doUtils.stopSession()
log("##===---- UserClient Stopped ----===##", 0)
2015-12-24 20:07:00 +00:00
def stopClient(self):
# When emby for kodi terminates
self.stopClient = True