""" Taken from iBaa, https://github.com/iBaa/PlexConnect Point of time: December 22, 2015 Collection of "connector functions" to Plex Media Server/MyPlex PlexGDM: loosely based on hippojay's plexGDM: https://github.com/hippojay/script.plexbmc.helper... /resources/lib/plexgdm.py Plex Media Server communication: source (somewhat): https://github.com/hippojay/plugin.video.plexbmc later converted from httplib to urllib2 Transcoder support: PlexAPI_getTranscodePath() based on getTranscodeURL from pyplex/plexAPI https://github.com/megawubs/pyplex/blob/master/plexAPI/info.py MyPlex - Basic Authentication: http://www.voidspace.org.uk/python/articles/urllib2.shtml http://www.voidspace.org.uk/python/articles/authentication.shtml http://stackoverflow.com/questions/2407126/python-urllib2-basic-auth-problem http://stackoverflow.com/questions/111945/is-there-any-way-to-do-http-put-in-python (and others...) """ import struct import time import urllib2 import httplib import socket import StringIO import gzip from threading import Thread import traceback import requests import xml.etree.ElementTree as etree from uuid import uuid4 import re import json from urllib import urlencode, quote_plus, unquote import clientinfo import utils import downloadutils import xbmcaddon import xbmcgui import xbmc import xbmcvfs from PlexFunctions import PlexToKodiTimefactor, PMSHttpsEnabled # Disable requests logging from requests.packages.urllib3.exceptions import InsecureRequestWarning requests.packages.urllib3.disable_warnings(InsecureRequestWarning) @utils.logging class PlexAPI(): # CONSTANTS # Timeout for POST/GET commands, I guess in seconds timeout = 10 def __init__(self): self.__language__ = xbmcaddon.Addon().getLocalizedString self.g_PMS = {} self.doUtils = downloadutils.DownloadUtils().downloadUrl def GetPlexLoginFromSettings(self): """ Returns a dict: 'plexLogin': utils.settings('plexLogin'), 'plexToken': utils.settings('plexToken'), 'plexhome': utils.settings('plexhome'), 'plexid': utils.settings('plexid'), 'myplexlogin': utils.settings('myplexlogin'), 'plexAvatar': utils.settings('plexAvatar'), 'plexHomeSize': utils.settings('plexHomeSize') Returns strings or unicode Returns empty strings '' for a setting if not found. myplexlogin is 'true' if user opted to log into plex.tv (the default) plexhome is 'true' if plex home is used (the default) """ return { 'plexLogin': utils.settings('plexLogin'), 'plexToken': utils.settings('plexToken'), 'plexhome': utils.settings('plexhome'), 'plexid': utils.settings('plexid'), 'myplexlogin': utils.settings('myplexlogin'), 'plexAvatar': utils.settings('plexAvatar'), 'plexHomeSize': utils.settings('plexHomeSize') } def GetPlexLoginAndPassword(self): """ Signs in to plex.tv. plexLogin, authtoken = GetPlexLoginAndPassword() Input: nothing Output: plexLogin plex.tv username authtoken token for plex.tv Also writes 'plexLogin' and 'token_plex.tv' to Kodi settings file If not logged in, empty strings are returned for both. """ string = self.__language__ retrievedPlexLogin = '' plexLogin = 'dummy' authtoken = '' dialog = xbmcgui.Dialog() while retrievedPlexLogin == '' and plexLogin != '': # Enter plex.tv username. Or nothing to cancel. plexLogin = dialog.input(self.addonName + string(39300), type=xbmcgui.INPUT_ALPHANUM) if plexLogin != "": # Enter password for plex.tv user plexPassword = dialog.input( string(39301) + plexLogin, type=xbmcgui.INPUT_ALPHANUM, option=xbmcgui.ALPHANUM_HIDE_INPUT) retrievedPlexLogin, authtoken = self.MyPlexSignIn( plexLogin, plexPassword, {'X-Plex-Client-Identifier': clientinfo.ClientInfo().getDeviceId()}) self.logMsg("plex.tv username and token: %s, %s" % (plexLogin, authtoken), 1) if plexLogin == '': # Could not sign in user dialog.ok(self.addonName, string(39302) + plexLogin) # Write to Kodi settings file utils.settings('plexLogin', value=retrievedPlexLogin) utils.settings('plexToken', value=authtoken) return (retrievedPlexLogin, authtoken) def PlexTvSignInWithPin(self): """ Prompts user to sign in by visiting https://plex.tv/pin Writes to Kodi settings file. Also returns: { 'plexhome': 'true' if Plex Home, 'false' otherwise 'username': 'avatar': URL to user avator 'token': 'plexid': Plex user ID 'homesize': Number of Plex home users (defaults to '1') } Returns False if authentication did not work. """ string = self.__language__ code, identifier = self.GetPlexPin() dialog = xbmcgui.Dialog() if not code: # Problems trying to contact plex.tv. Try again later dialog.ok(self.addonName, string(39303)) return False # Go to https://plex.tv/pin and enter the code: # Or press No to cancel the sign in. answer = dialog.yesno(self.addonName, string(39304) + "\n\n", code + "\n\n", string(39311)) if not answer: return False count = 0 # Wait for approx 30 seconds (since the PIN is not visible anymore :-)) while count < 30: xml = self.CheckPlexTvSignin(identifier) if xml is not False: break # Wait for 1 seconds xbmc.sleep(1000) count += 1 if xml is False: # Could not sign in to plex.tv Try again later dialog.ok(self.addonName, string(39305)) return False # Parse xml userid = xml.attrib.get('id') home = xml.get('home', '0') if home == '1': home = 'true' else: home = 'false' username = xml.get('username', '') avatar = xml.get('thumb', '') token = xml.findtext('authentication-token') homeSize = xml.get('homeSize', '1') result = { 'plexhome': home, 'username': username, 'avatar': avatar, 'token': token, 'plexid': userid, 'homesize': homeSize } utils.settings('plexLogin', username) utils.settings('plexToken', token) utils.settings('plexhome', home) utils.settings('plexid', userid) utils.settings('plexAvatar', avatar) utils.settings('plexHomeSize', homeSize) # Let Kodi log into plex.tv on startup from now on utils.settings('myplexlogin', 'true') return result def CheckPlexTvSignin(self, identifier): """ Checks with plex.tv whether user entered the correct PIN on plex.tv/pin Returns False if not yet done so, or the XML response file as etree """ # Try to get a temporary token xml = self.doUtils('https://plex.tv/pins/%s.xml' % identifier, authenticate=False, type="GET") try: temp_token = xml.find('auth_token').text except: self.logMsg("Error: Could not find token in plex.tv answer.", -1) return False self.logMsg("temp token from plex.tv is: %s" % temp_token, 2) if not temp_token: return False # Use temp token to get the final plex credentials xml = self.doUtils('https://plex.tv/users/account?X-Plex-Token=%s' % temp_token, authenticate=False, type="GET") return xml def GetPlexPin(self): """ For plex.tv sign-in: returns 4-digit code and identifier as 2 str """ code = None identifier = None # Download xml = self.doUtils('https://plex.tv/pins.xml', authenticate=False, type="POST") try: xml.attrib except: self.logMsg("Error, no PIN from plex.tv provided", -1) return None, None code = xml.find('code').text identifier = xml.find('id').text self.logMsg('Successfully retrieved code and id from plex.tv', 1) return code, identifier def TalkToPlexServer(self, url, talkType="GET", verify=True, token=None): """ Start request with PMS with url. Returns the parsed XML answer as an etree object. False if the server could not be reached/timeout occured. False if HTTP error code of >=400 was returned. """ header = self.getXArgsDeviceInfo() if token: header['X-Plex-Token'] = token timeout = (3, 10) try: if talkType == "GET": answer = requests.get(url, headers={}, params=header, verify=verify, timeout=timeout) # Only seems to be used for initial plex.tv sign in if talkType == "GET2": answer = requests.get(url, headers=header, params={}, verify=verify, timeout=timeout) elif talkType == "POST": answer = requests.post(url, data='', headers=header, params={}, verify=verify, timeout=timeout) except requests.exceptions.ConnectionError as e: self.logMsg("Server is offline or cannot be reached. Url: %s. " "Error message: %s" % (url, e), -1) return False except requests.exceptions.ReadTimeout: self.logMsg("Server timeout reached for Url %s" % url, -1) return False # We received an answer from the server, but not as expected. if answer.status_code >= 400: self.logMsg("Error, answer from server %s was not as expected. " "HTTP status code: %s" % (url, answer.status_code), -1) return False xml = answer.text.encode('utf-8') self.logMsg("xml received from server %s: %s" % (url, xml), 2) try: xml = etree.fromstring(xml) except: self.logMsg("Error parsing XML answer from %s" % url, -1) return False return xml def CheckConnection(self, url, token=None): """ Checks connection to a Plex server, available at url. Can also be used to check for connection with plex.tv. Will check up to 3x until reply with False Input: url URL to Plex server (e.g. https://192.168.1.1:32400) token appropriate token to access server. If None is passed, the current token is used Output: False if server could not be reached or timeout occured e.g. 200 if connection was successfull int or other HTML status codes as received from the server """ # Add '/clients' to URL because then an authentication is necessary # If a plex.tv URL was passed, this does not work. header = clientinfo.ClientInfo().getXArgsDeviceInfo() if token: header['X-Plex-Token'] = token sslverify = utils.settings('sslverify') if sslverify == "true": sslverify = True else: sslverify = False self.logMsg("Checking connection to server %s with sslverify=%s" % (url, sslverify), 1) timeout = (3, 10) if 'plex.tv' in url: url = 'https://plex.tv/api/home/users' else: url = url + '/library/onDeck' # Check up to 3 times before giving up - this sometimes happens when # PKC was just started count = 0 while count < 3: try: answer = requests.get(url, headers={}, params=header, verify=sslverify, timeout=timeout) except requests.exceptions.ConnectionError as e: self.logMsg("Server is offline or cannot be reached. Url: %s " "Header: %s Error message: %s" % (url, header, e), 0) count += 1 xbmc.sleep(1000) continue except requests.exceptions.ReadTimeout: self.logMsg("Server timeout reached for Url %s with header %s" % (url, header), 0) count += 1 xbmc.sleep(1000) continue else: result = answer.status_code self.logMsg("Result was: %s" % result, 1) return result self.logMsg('Failed to connect to %s too many times.' % url, -1) return False def GetgPMSKeylist(self): """ Returns a list of all keys that are saved for every entry in the g_PMS variable. """ keylist = [ 'address', 'baseURL', 'enableGzip', 'ip', 'local', 'name', 'owned', 'port', 'scheme' ] return keylist def setgPMSToSettings(self, g_PMS): """ PlexDB: takes an g_PMS list of Plex servers and saves them all to the Kodi settings file. It does NOT save the ATV_udid as that id seems to change with reboot. Settings are set using the Plex server machineIdentifier. Input: g_PMS Output: Assumptions: There is only one ATV_udid in g_PMS Existing entries for servers with the same ID get overwritten. New entries get added. Serverinfo already set in file are set to ''. NOTE: it is currently not possible to delete entries in Kodi settings file! """ addon = xbmcaddon.Addon() # Get rid of uppermost level ATV_udid in g_PMS ATV_udid = list(g_PMS.keys())[0] g_PMS = g_PMS[ATV_udid] serverlist = [] keylist = self.getgPMSKeylist() for serverid, servervalues in g_PMS.items(): serverlist.append(serverid) # Set values in Kodi settings file for item in keylist: # Append the server's ID first, then immediatelly the setting addon.setSetting( str(serverid) + str(item), # the key str(g_PMS[serverid][item]) # the value ) # Write a new or updated 'serverlist' string to settings oldserverlist = addon.getSetting('serverlist') # If no server has been saved yet, return if oldserverlist == '': serverlist = ','.join(serverlist) addon.setSetting('serverlist', serverlist) return oldserverlist = oldserverlist.split(',') for server in oldserverlist: # Delete serverinfo that has NOT been passed in serverlist if server not in serverlist: # Set old value to '', because deleting is not possible for item in keylist: addon.setSetting(str(server) + str(item), '') serverlist = ','.join(serverlist) addon.setSetting('serverlist', serverlist) return def declarePMS(self, ATV_udid, uuid, name, scheme, ip, port): """ Plex Media Server handling parameters: ATV_udid uuid - PMS ID name, scheme, ip, port, type, owned, token """ # store PMS information in g_PMS database if ATV_udid not in self.g_PMS: self.g_PMS[ATV_udid] = {} address = ip + ':' + port baseURL = scheme+'://'+ip+':'+port self.g_PMS[ATV_udid][uuid] = { 'name': name, 'scheme':scheme, 'ip': ip , 'port': port, 'address': address, 'baseURL': baseURL, 'local': '1', 'owned': '1', 'accesstoken': '', 'enableGzip': False } def updatePMSProperty(self, ATV_udid, uuid, tag, value): # set property element of PMS by UUID if not ATV_udid in self.g_PMS: return '' # no server known for this aTV if not uuid in self.g_PMS[ATV_udid]: return '' # requested PMS not available self.g_PMS[ATV_udid][uuid][tag] = value def getPMSProperty(self, ATV_udid, uuid, tag): # get name of PMS by UUID if not ATV_udid in self.g_PMS: return '' # no server known for this aTV if not uuid in self.g_PMS[ATV_udid]: return '' # requested PMS not available return self.g_PMS[ATV_udid][uuid].get(tag, '') def getPMSFromAddress(self, ATV_udid, address): # find PMS by IP, return UUID if not ATV_udid in self.g_PMS: return '' # no server known for this aTV for uuid in self.g_PMS[ATV_udid]: if address in self.g_PMS[ATV_udid][uuid].get('address', None): return uuid return '' # IP not found def getPMSAddress(self, ATV_udid, uuid, data): # get address of PMS by UUID if not ATV_udid in data: return '' # no server known for this aTV if not uuid in data[ATV_udid]: return '' # requested PMS not available return data[ATV_udid][uuid]['ip'] + ':' + data[ATV_udid][uuid]['port'] def getPMSCount(self, ATV_udid): # get count of discovered PMS by UUID if not ATV_udid in self.g_PMS: return 0 # no server known for this aTV return len(self.g_PMS[ATV_udid]) def PlexGDM(self): """ PlexGDM parameters: none result: PMS_list - dict() of PMSs found """ IP_PlexGDM = '239.0.0.250' # multicast to PMS Port_PlexGDM = 32414 Msg_PlexGDM = 'M-SEARCH * HTTP/1.0' # dprint(__name__, 0, "***") # dprint(__name__, 0, "PlexGDM - looking up Plex Media Server") # dprint(__name__, 0, "***") # setup socket for discovery -> multicast message GDM = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) GDM.settimeout(1.0) # Set the time-to-live for messages to 1 for local network ttl = struct.pack('b', 1) GDM.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, ttl) returnData = [] try: # Send data to the multicast group # dprint(__name__, 1, "Sending discovery message: {0}", Msg_PlexGDM) GDM.sendto(Msg_PlexGDM, (IP_PlexGDM, Port_PlexGDM)) # Look for responses from all recipients while True: try: data, server = GDM.recvfrom(1024) # dprint(__name__, 1, "Received data from {0}", server) # dprint(__name__, 1, "Data received:\n {0}", data) returnData.append( { 'from' : server, 'data' : data } ) except socket.timeout: break finally: GDM.close() discovery_complete = True PMS_list = {} if returnData: for response in returnData: update = { 'ip' : response.get('from')[0] } # Check if we had a positive HTTP response if "200 OK" in response.get('data'): for each in response.get('data').split('\n'): # decode response data update['discovery'] = "auto" #update['owned']='1' #update['master']= 1 #update['role']='master' if "Content-Type:" in each: update['content-type'] = each.split(':')[1].strip() elif "Resource-Identifier:" in each: update['uuid'] = each.split(':')[1].strip() elif "Name:" in each: update['serverName'] = each.split(':')[1].strip().decode('utf-8', 'replace') # store in utf-8 elif "Port:" in each: update['port'] = each.split(':')[1].strip() elif "Updated-At:" in each: update['updated'] = each.split(':')[1].strip() elif "Version:" in each: update['version'] = each.split(':')[1].strip() PMS_list[update['uuid']] = update # if PMS_list=={}: # dprint(__name__, 0, "GDM: No servers discovered") # else: # dprint(__name__, 0, "GDM: Servers discovered: {0}", len(PMS_list)) # for uuid in PMS_list: # dprint(__name__, 1, "{0} {1}:{2}", PMS_list[uuid]['serverName'], PMS_list[uuid]['ip'], PMS_list[uuid]['port']) return PMS_list def discoverPMS(self, ATV_udid, CSettings, IP_self, tokenDict={}): """ discoverPMS parameters: ATV_udid CSettings - for manual PMS configuration. this one looks strange. IP_self optional: tokenDict - dictionary of tokens for MyPlex, PlexHome result: self.g_PMS dictionary for ATV_udid """ self.g_PMS[ATV_udid] = {} # install plex.tv "virtual" PMS - for myPlex, PlexHome self.declarePMS(ATV_udid, 'plex.tv', 'plex.tv', 'https', 'plex.tv', '443') self.updatePMSProperty(ATV_udid, 'plex.tv', 'local', '-') self.updatePMSProperty(ATV_udid, 'plex.tv', 'owned', '-') self.updatePMSProperty(ATV_udid, 'plex.tv', 'accesstoken', tokenDict.get('MyPlexToken', '')) if 'PlexHomeToken' in tokenDict: authtoken = tokenDict.get('PlexHomeToken') else: authtoken = tokenDict.get('MyPlexToken', '') if authtoken == '': # not logged into myPlex # local PMS # PlexGDM PMS_list = self.PlexGDM() for uuid_id in PMS_list: PMS = PMS_list[uuid_id] self.declarePMS(ATV_udid, PMS['uuid'], PMS['serverName'], 'http', PMS['ip'], PMS['port']) # dflt: token='', local, owned else: # MyPlex servers self.getPMSListFromMyPlex(ATV_udid, authtoken) # Delete plex.tv again del self.g_PMS[ATV_udid]['plex.tv'] # all servers - update enableGzip for uuid_id in self.g_PMS.get(ATV_udid, {}): # Ping to check whether we need HTTPs or HTTP url = (self.getPMSProperty(ATV_udid, uuid_id, 'ip') + ':' + self.getPMSProperty(ATV_udid, uuid_id, 'port')) https = PMSHttpsEnabled(url) if https is None: # Error contacting url continue elif https: self.updatePMSProperty(ATV_udid, uuid_id, 'scheme', 'https') else: self.updatePMSProperty(ATV_udid, uuid_id, 'scheme', 'http') # enable Gzip if not on same host, local&remote PMS depending # on setting enableGzip = (not self.getPMSProperty(ATV_udid, uuid_id, 'ip') == IP_self) \ and ( (self.getPMSProperty(ATV_udid, uuid_id, 'local') == '1' and False) or (self.getPMSProperty(ATV_udid, uuid_id, 'local') == '0' and True) == 'True' ) self.updatePMSProperty(ATV_udid, uuid_id, 'enableGzip', enableGzip) def getPMSListFromMyPlex(self, ATV_udid, authtoken): """ getPMSListFromMyPlex get Plex media Server List from plex.tv/pms/resources """ xml = self.doUtils('https://plex.tv/api/resources?includeHttps=1', authenticate=False, headerOptions={'X-Plex-Token': authtoken}) try: xml.attrib except: self.logMsg('Could not get list of PMS from plex.tv', -1) return import Queue queue = Queue.Queue() threads = [] for Dir in xml.iter(tag='Device'): if "server" in Dir.get('provides'): if Dir.find('Connection') is None: # no valid connection - skip continue # check MyPlex data age - skip if >2 days PMS = {} PMS['name'] = Dir.get('name') infoAge = time.time() - int(Dir.get('lastSeenAt')) oneDayInSec = 2*60*60*24 if infoAge > 1*oneDayInSec: self.logMsg("Server %s not seen for 1 day - " "skipping." % PMS['name'], 0) continue PMS['uuid'] = Dir.get('clientIdentifier') PMS['token'] = Dir.get('accessToken', authtoken) PMS['owned'] = Dir.get('owned', '0') PMS['local'] = Dir.get('publicAddressMatches') PMS['ownername'] = Dir.get('sourceTitle', '') PMS['path'] = '/' PMS['options'] = None # flag to set first connection, possibly overwrite later with # more suitable PMS['baseURL'] = "" for Con in Dir.iter(tag='Connection'): if (PMS['baseURL'] == "" or Con.get('local') == PMS['local']): PMS['protocol'] = Con.get('protocol') PMS['ip'] = Con.get('address') PMS['port'] = Con.get('port') PMS['baseURL'] = Con.get('baseURL') # todo: handle unforeseen - like we get multiple suitable # connections. how to choose one? # poke PMS, own thread for each poke t = Thread(target=self.pokePMS, args=(PMS['baseURL'], PMS['token'], PMS, queue)) t.start() threads.append(t) # wait for requests being answered for t in threads: t.join() # declare new PMSs while not queue.empty(): PMS = queue.get() self.declarePMS(ATV_udid, PMS['uuid'], PMS['name'], PMS['protocol'], PMS['ip'], PMS['port']) # dflt: token='', local, owned - updated later self.updatePMSProperty( ATV_udid, PMS['uuid'], 'accesstoken', PMS['token']) self.updatePMSProperty( ATV_udid, PMS['uuid'], 'owned', PMS['owned']) self.updatePMSProperty( ATV_udid, PMS['uuid'], 'local', PMS['local']) # set in declarePMS, overwrite for https encryption self.updatePMSProperty( ATV_udid, PMS['uuid'], 'baseURL', PMS['baseURL']) self.updatePMSProperty( ATV_udid, PMS['uuid'], 'ownername', PMS['ownername']) queue.task_done() def pokePMS(self, url, token, PMS, queue): xml = self.doUtils(url, authenticate=False, headerOptions={'X-Plex-Token': token}) try: xml.attrib except: return else: queue.put(PMS) def getURL(self, baseURL, path, key): if key.startswith('http://') or key.startswith('https://'): # external server URL = key elif key.startswith('/'): # internal full path. URL = baseURL + key elif key == '': # internal path URL = baseURL + path else: # internal path, add-on URL = baseURL + path + '/' + key return URL def MyPlexSignIn(self, username, password, options): """ MyPlex Sign In, Sign Out parameters: username - Plex forum name, MyPlex login, or email address password options - dict() of PlexConnect-options as received from aTV - necessary: PlexConnectUDID result: username authtoken - token for subsequent communication with MyPlex """ # MyPlex web address MyPlexHost = 'plex.tv' MyPlexSignInPath = '/users/sign_in.xml' MyPlexURL = 'https://' + MyPlexHost + MyPlexSignInPath # create POST request xargs = clientinfo.ClientInfo().getXArgsDeviceInfo(options) self.logMsg("Header is: %s" % xargs, 1) request = urllib2.Request(MyPlexURL, None, xargs) request.get_method = lambda: 'POST' # turn into 'POST' # done automatically with data!=None. But we don't have data. # no certificate, will fail with "401 - Authentification required" """ try: f = urllib2.urlopen(request) except urllib2.HTTPError, e: print e.headers print "has WWW_Authenticate:", e.headers.has_key('WWW-Authenticate') print """ # provide credentials ### optional... when 'realm' is unknown ##passmanager = urllib2.HTTPPasswordMgrWithDefaultRealm() ##passmanager.add_password(None, address, username, password) # None: default "realm" passmanager = urllib2.HTTPPasswordMgr() passmanager.add_password(MyPlexHost, MyPlexURL, username, password) authhandler = urllib2.HTTPBasicAuthHandler(passmanager) urlopener = urllib2.build_opener(authhandler) # sign in, get MyPlex response try: response = urlopener.open(request).read() except urllib2.HTTPError as e: if e.code == 401: self.logMsg("Authentication failed", 0) return ('', '') else: raise # analyse response XMLTree = etree.ElementTree(etree.fromstring(response)) el_username = XMLTree.find('username') el_authtoken = XMLTree.find('authentication-token') if el_username is None or \ el_authtoken is None: username = '' authtoken = '' else: username = el_username.text authtoken = el_authtoken.text return (username, authtoken) def MyPlexSignOut(self, authtoken): # MyPlex web address MyPlexHost = 'plex.tv' MyPlexSignOutPath = '/users/sign_out.xml' MyPlexURL = 'http://' + MyPlexHost + MyPlexSignOutPath # create POST request xargs = { 'X-Plex-Token': authtoken } request = urllib2.Request(MyPlexURL, None, xargs) request.get_method = lambda: 'POST' # turn into 'POST' - done automatically with data!=None. But we don't have data. response = urllib2.urlopen(request).read() dprint(__name__, 1, "====== MyPlex sign out XML ======") dprint(__name__, 1, response) dprint(__name__, 1, "====== MyPlex sign out XML finished ======") dprint(__name__, 0, 'MyPlex Sign Out done') def GetUserArtworkURL(self, username): """ Returns the URL for the user's Avatar. Or False if something went wrong. """ plexToken = utils.settings('plexToken') users = self.MyPlexListHomeUsers(plexToken) url = '' # If an error is encountered, set to False if not users: self.logMsg("Could not get userlist from plex.tv.", 1) self.logMsg("No URL for user avatar.", 1) return False for user in users: if username in user['title']: url = user['thumb'] self.logMsg("Avatar url for user %s is: %s" % (username, url), 1) return url def ChoosePlexHomeUser(self, plexToken): """ Let's user choose from a list of Plex home users. Will switch to that user accordingly. Returns a dict: { 'username': Unicode 'userid': '' Plex ID of the user 'token': '' User's token 'protected': True if PIN is needed, else False } Will return False if something went wrong (wrong PIN, no connection) """ string = self.__language__ dialog = xbmcgui.Dialog() # Get list of Plex home users users = self.MyPlexListHomeUsers(plexToken) if not users: self.logMsg("User download failed.", -1) return False userlist = [] userlistCoded = [] for user in users: username = user['title'] userlist.append(username) # To take care of non-ASCII usernames userlistCoded.append(username.encode('utf-8')) usernumber = len(userlist) username = '' usertoken = '' trials = 0 while trials < 3: if usernumber > 1: # Select user user_select = dialog.select( self.addonName + string(39306), userlistCoded) if user_select == -1: self.logMsg("No user selected.", 0) utils.settings('username', value='') xbmc.executebuiltin('Addon.OpenSettings(%s)' % clientinfo.ClientInfo().getAddonId()) return False # Only 1 user received, choose that one else: user_select = 0 selected_user = userlist[user_select] self.logMsg("Selected user: %s" % selected_user, 0) user = users[user_select] # Ask for PIN, if protected: pin = None if user['protected'] == '1': self.logMsg('Asking for users PIN', 1) pin = dialog.input( string(39307) + selected_user, type=xbmcgui.INPUT_NUMERIC, option=xbmcgui.ALPHANUM_HIDE_INPUT) # User chose to cancel # Plex bug: don't call url for protected user with empty PIN if not pin: trials += 1 continue # Switch to this Plex Home user, if applicable result = self.PlexSwitchHomeUser( user['id'], pin, plexToken, utils.settings('plex_machineIdentifier')) if result: # Successfully retrieved username: break out of while loop username = result['username'] usertoken = result['usertoken'] break # Couldn't get user auth else: trials += 1 # Could not login user, please try again if not dialog.yesno(self.addonName, string(39308) + selected_user, string(39309)): # User chose to cancel break if not username: self.logMsg('Failed signing in a user to plex.tv', -1) xbmc.executebuiltin('Addon.OpenSettings(%s)' % clientinfo.ClientInfo().getAddonId()) return False return { 'username': username, 'userid': user['id'], 'protected': True if user['protected'] == '1' else False, 'token': usertoken } def PlexSwitchHomeUser(self, userId, pin, token, machineIdentifier): """ Retrieves Plex home token for a Plex home user. Returns False if unsuccessful Input: userId id of the Plex home user pin PIN of the Plex home user, if protected token token for plex.tv Output: { 'username' 'usertoken' Might be empty strings if no token found for the machineIdentifier that was chosen } settings('userid') and settings('username') with new plex token """ url = 'https://plex.tv/api/home/users/' + userId + '/switch' if pin: url += '?pin=' + pin self.logMsg('Switching to user %s' % userId, 0) answer = self.doUtils(url, authenticate=False, type="POST", headerOptions={'X-Plex-Token': token}) try: answer.attrib except: self.logMsg('Error: plex.tv switch HomeUser change failed', -1) return False username = answer.attrib.get('title', '') token = answer.attrib.get('authenticationToken', '') userid = answer.attrib.get('id', '') # Write to settings file utils.settings('username', username) utils.settings('userid', userid) utils.settings('accessToken', token) # Get final token to the PMS we've chosen url = 'https://plex.tv/api/resources?includeHttps=1' xml = self.doUtils(url, authenticate=False, type="GET", headerOptions={'X-Plex-Token': token}) try: xml.attrib except: self.logMsg('Answer from plex.tv not as excepted', -1) # Set to empty iterable list for loop xml = [] found = 0 self.logMsg('Our machineIdentifier is %s' % machineIdentifier, 0) for device in xml: identifier = device.attrib.get('clientIdentifier') self.logMsg('Found a Plex machineIdentifier: %s' % identifier, 0) if (identifier in machineIdentifier or machineIdentifier in identifier): found += 1 token = device.attrib.get('accessToken') result = { 'username': username, } if found == 0: self.logMsg('No tokens found for your server!', 0) self.logMsg('Using empty string as token', 0) result['usertoken'] = '' else: result['usertoken'] = token self.logMsg('Plex.tv switch HomeUser change successfull for user %s' % username, 0) return result def MyPlexListHomeUsers(self, token): """ Returns a list for myPlex home users for the current plex.tv account. Input: token for plex.tv Output: List of users, where one entry is of the form: "id": userId, "admin": '1'/'0', "guest": '1'/'0', "restricted": '1'/'0', "protected": '1'/'0', "email": email, "title": title, "username": username, "thumb": thumb_url } If any value is missing, None is returned instead (or "" from plex.tv) If an error is encountered, False is returned """ xml = self.doUtils('https://plex.tv/api/home/users/', authenticate=False, headerOptions={'X-Plex-Token': token}) try: xml.attrib except: self.logMsg('Download of Plex home users failed.', -1) return False users = [] for user in xml: users.append(user.attrib) return users def getDirectVideoPath(self, key, AuthToken): """ Direct Video Play support parameters: path AuthToken Indirect - media indirect specified, grab child XML to gain real path options result: final path to media file """ if key.startswith('http://') or key.startswith('https://'): # external address - keep path = key else: if AuthToken=='': path = key else: xargs = dict() xargs['X-Plex-Token'] = AuthToken if key.find('?')==-1: path = key + '?' + urlencode(xargs) else: path = key + '&' + urlencode(xargs) return path def getTranscodeImagePath(self, key, AuthToken, path, width, height): """ Transcode Image support parameters: key AuthToken path - source path of current XML: path[srcXML] width height result: final path to image file """ if key.startswith('http://') or key.startswith('https://'): # external address - can we get a transcoding request for external images? path = key elif key.startswith('/'): # internal full path. path = 'http://127.0.0.1:32400' + key else: # internal path, add-on path = 'http://127.0.0.1:32400' + path + '/' + key path = path.encode('utf8') # This is bogus (note the extra path component) but ATV is stupid when it comes to caching images, it doesn't use querystrings. # Fortunately PMS is lenient... transcodePath = '/photo/:/transcode/' +str(width)+'x'+str(height)+ '/' + quote_plus(path) args = dict() args['width'] = width args['height'] = height args['url'] = path if not AuthToken=='': args['X-Plex-Token'] = AuthToken return transcodePath + '?' + urlencode(args) def getDirectImagePath(self, path, AuthToken): """ Direct Image support parameters: path AuthToken result: final path to image file """ if not AuthToken=='': xargs = dict() xargs['X-Plex-Token'] = AuthToken if path.find('?')==-1: path = path + '?' + urlencode(xargs) else: path = path + '&' + urlencode(xargs) return path def getTranscodeAudioPath(self, path, AuthToken, options, maxAudioBitrate): """ Transcode Audio support parameters: path AuthToken options - dict() of PlexConnect-options as received from aTV maxAudioBitrate - [kbps] result: final path to pull in PMS transcoder """ UDID = options['PlexConnectUDID'] transcodePath = '/music/:/transcode/universal/start.mp3?' args = dict() args['path'] = path args['session'] = UDID args['protocol'] = 'http' args['maxAudioBitrate'] = maxAudioBitrate xargs = clientinfo.ClientInfo().getXArgsDeviceInfo(options) if not AuthToken=='': xargs['X-Plex-Token'] = AuthToken return transcodePath + urlencode(args) + '&' + urlencode(xargs) def getDirectAudioPath(self, path, AuthToken): """ Direct Audio support parameters: path AuthToken result: final path to audio file """ if not AuthToken=='': xargs = dict() xargs['X-Plex-Token'] = AuthToken if path.find('?')==-1: path = path + '?' + urlencode(xargs) else: path = path + '&' + urlencode(xargs) return path def returnServerList(self, ATV_udid, data): """ Returns a nicer list of all servers found in data, where data is in g_PMS format, for the client device with unique ID ATV_udid Input: ATV_udid Unique client ID data e.g. self.g_PMS Output: List of all servers, with an entry of the form: { 'name': friendlyName, the Plex server's name 'address': ip:port 'ip': ip, without http/https 'port': port 'scheme': 'http'/'https', nice for checking for secure connections 'local': '1'/'0', Is the server a local server? 'owned': '1'/'0', Is the server owned by the user? 'machineIdentifier': id, Plex server machine identifier 'accesstoken': token Access token to this server 'baseURL': baseURL scheme://ip:port } """ serverlist = [] for key, value in data[ATV_udid].items(): serverlist.append({ 'name': value['name'], 'address': value['address'], 'ip': value['ip'], 'port': value['port'], 'scheme': value['scheme'], 'local': value['local'], 'owned': value['owned'], 'machineIdentifier': key, 'accesstoken': value['accesstoken'], 'baseURL': value['baseURL'] }) return serverlist @utils.logging class API(): """ API(item) Processes a Plex media server's XML response item: xml.etree.ElementTree element """ def __init__(self, item): self.item = item # which media part in the XML response shall we look at? self.part = 0 self.__language__ = xbmcaddon.Addon().getLocalizedString self.server = utils.window('pms_server') def setPartNumber(self, number=None): """ Sets the part number to work with (used to deal with Movie with several parts). """ self.part = number or 0 def getPartNumber(self): """ Returns the current media part number we're dealing with. """ return self.part def getType(self): """ Returns the type of media, e.g. 'movie' or 'clip' for trailers """ return self.item.attrib.get('type') def getChecksum(self): """ Returns a string, not int. WATCH OUT - time in Plex, not Kodi ;-) """ # Include a letter to prohibit saving as an int! checksum = "K%s%s" % (self.getRatingKey(), self.item.attrib.get('updatedAt', '')) return checksum def getRatingKey(self): """ Returns the Plex key such as '246922' as a string """ return self.item.attrib.get('ratingKey') def getKey(self): """ Returns the Plex key such as '/library/metadata/246922' """ return self.item.attrib.get('key') def getFilePath(self): """ Returns the direct path to this item, e.g. '\\NAS\movies\movie.mkv' or None """ try: res = self.item[0][0].attrib.get('file') except: res = None if res: res = unquote(res).decode('utf-8') return res def getTVShowPath(self): """ Returns the direct path to the TV show, e.g. '\\NAS\tv\series' or None """ res = None for child in self.item: if child.tag == 'Location': res = child.attrib.get('path') return res def getIndex(self): """ Returns the 'index' of an PMS XML reply. Depicts e.g. season number. """ return self.item.attrib.get('index') def getDateCreated(self): """ Returns the date when this library item was created or None """ res = self.item.attrib.get('addedAt') if res is not None: res = utils.DateToKodi(res) return res def getUserData(self): """ Returns a dict with None if a value is missing { 'Favorite': favorite, # False, because n/a in Plex 'PlayCount': playcount, 'Played': played, # True/False 'LastPlayedDate': lastPlayedDate, 'Resume': resume, # Resume time in seconds 'Runtime': runtime, 'Rating': rating } """ item = self.item.attrib # Default - attributes not found with Plex favorite = False try: playcount = int(item['viewCount']) except: playcount = 0 if playcount: played = True else: played = False try: lastPlayedDate = utils.DateToKodi(int(item['lastViewedAt'])) except: lastPlayedDate = None try: userrating = float(item['userRating']) except: userrating = 0.0 try: rating = float(item['audienceRating']) except: try: rating = float(item['rating']) except: rating = 0.0 resume, runtime = self.getRuntime() return { 'Favorite': favorite, 'PlayCount': playcount, 'Played': played, 'LastPlayedDate': lastPlayedDate, 'Resume': resume, 'Runtime': runtime, 'Rating': rating, 'UserRating': userrating } def getCollections(self): """ Returns a list of PMS collection tags or an empty list """ collections = [] for child in self.item: if child.tag == 'Collection': collections.append(child.attrib['tag']) return collections def getPeople(self): """ Returns a dict of lists of people found. { 'Director': list, 'Writer': list, 'Cast': list, 'Producer': list } """ director = [] writer = [] cast = [] producer = [] for child in self.item: if child.tag == 'Director': director.append(child.attrib['tag']) elif child.tag == 'Writer': writer.append(child.attrib['tag']) elif child.tag == 'Role': cast.append(child.attrib['tag']) elif child.tag == 'Producer': producer.append(child.attrib['tag']) return { 'Director': director, 'Writer': writer, 'Cast': cast, 'Producer': producer } def getPeopleList(self): """ Returns a list of people from item, with a list item of the form { 'Name': xxx, 'Type': xxx, 'Id': xxx 'imageurl': url to picture, None otherwise ('Role': xxx for cast/actors only, None if not found) } """ people = [] # Key of library: Plex-identifier. Value represents the Kodi/emby side people_of_interest = { 'Director': 'Director', 'Writer': 'Writer', 'Role': 'Actor', 'Producer': 'Producer' } for child in self.item: if child.tag in people_of_interest.keys(): name = child.attrib['tag'] name_id = child.attrib['id'] Type = child.tag Type = people_of_interest[Type] url = child.attrib.get('thumb') Role = child.attrib.get('role') people.append({ 'Name': name, 'Type': Type, 'Id': name_id, 'imageurl': url }) if url: people[-1].update({'imageurl': url}) if Role: people[-1].update({'Role': Role}) return people def getGenres(self): """ Returns a list of genres found. (Not a string) """ genre = [] for child in self.item: if child.tag == 'Genre': genre.append(child.attrib['tag']) return genre def getGuid(self): return self.item.attrib.get('guid') def getProvider(self, providername=None): """ providername: e.g. 'imdb', 'tvdb' Return IMDB, e.g. "tt0903624". Returns None if not found """ item = self.item.attrib try: item = item['guid'] except KeyError: return None if providername == 'imdb': regex = re.compile(r'''/(tt\d+)''') elif providername == 'tvdb': # originally e.g. com.plexapp.agents.thetvdb://276564?lang=en regex = re.compile(r'''tvdb://(\d+)''') else: return None provider = regex.findall(item) try: provider = provider[0] except IndexError: provider = None return provider def getTitle(self): """ Returns an item's name/title or "Missing Title Name". Output: title, sorttitle sorttitle = title, if no sorttitle is found """ title = self.item.attrib.get('title', 'Missing Title Name') sorttitle = self.item.attrib.get('titleSort', title) return title, sorttitle def getPlot(self): """ Returns the plot or None. """ return self.item.attrib.get('summary', None) def getTagline(self): """ Returns a shorter tagline or None """ return self.item.attrib.get('tagline', None) def getAudienceRating(self): """ Returns the audience rating, 'rating' itself or 0.0 """ res = self.item.attrib.get('audienceRating') if res is None: res = self.item.attrib.get('rating', 0.0) res = float(res) return res def getYear(self): """ Returns the production(?) year ("year") or None """ return self.item.attrib.get('year', None) def getRuntime(self): """ Resume point of time and runtime/totaltime in rounded to seconds. Time from Plex server is measured in milliseconds. Kodi: seconds Output: resume, runtime as ints. 0 if not found """ item = self.item.attrib try: runtime = float(item['duration']) except KeyError: runtime = 0.0 try: resume = float(item['viewOffset']) except KeyError: resume = 0.0 runtime = int(runtime * PlexToKodiTimefactor()) resume = int(resume * PlexToKodiTimefactor()) return resume, runtime def getMpaa(self): """ Get the content rating or None """ mpaa = self.item.attrib.get('contentRating', None) # Convert more complex cases if mpaa in ("NR", "UR"): # Kodi seems to not like NR, but will accept Rated Not Rated mpaa = "Rated Not Rated" return mpaa def getCountry(self): """ Returns a list of all countries found in item. """ country = [] for child in self.item: if child.tag == 'Country': country.append(child.attrib['tag']) return country def getPremiereDate(self): """ Returns the "originallyAvailableAt" or None """ return self.item.attrib.get('originallyAvailableAt', None) def getMusicStudio(self): return self.item.attrib.get('studio', '') def getStudios(self): """ Returns a list with a single entry for the studio, or an empty list """ studio = [] try: studio.append(self.getStudio(self.item.attrib['studio'])) except KeyError: pass return studio def getStudio(self, studioName): """ Convert studio for Kodi to properly detect them """ studios = { 'abc (us)': "ABC", 'fox (us)': "FOX", 'mtv (us)': "MTV", 'showcase (ca)': "Showcase", 'wgn america': "WGN" } return studios.get(studioName.lower(), studioName) def joinList(self, listobject): """ Smart-joins the listobject into a single string using a " / " separator. If the list is empty, smart_join returns an empty string. """ string = " / ".join(listobject) return string def getParentRatingKey(self): return self.item.attrib.get('parentRatingKey', '') def getEpisodeDetails(self): """ Call on a single episode. Output: for the corresponding the TV show and season: [ TV show key, Plex: 'grandparentRatingKey' TV show title, Plex: 'grandparentTitle' TV show season, Plex: 'parentIndex' Episode number, Plex: 'index' ] """ item = self.item.attrib key = item.get('grandparentRatingKey') title = item.get('grandparentTitle') season = item.get('parentIndex') episode = item.get('index') return key, title, season, episode def addPlexHeadersToUrl(self, url, arguments={}): """ Takes an URL and optional arguments (also to be URL-encoded); returns an extended URL with e.g. the Plex token included. arguments overrule everything """ xargs = clientinfo.ClientInfo().getXArgsDeviceInfo() xargs.update(arguments) if '?' not in url: url = "%s?%s" % (url, urlencode(xargs)) else: url = "%s&%s" % (url, urlencode(xargs)) return url def addPlexCredentialsToUrl(self, url): """ Returns an extended URL with the Plex token included as 'X-Plex-Token=' url may or may not already contain a '?' """ if utils.window('pms_token') == '': return url if '?' not in url: url = "%s?X-Plex-Token=%s" % (url, utils.window('pms_token')) else: url = "%s&X-Plex-Token=%s" % (url, utils.window('pms_token')) return url def GetPlayQueueItemID(self): """ Returns current playQueueItemID for the item. If not found, empty str is returned """ return self.item.attrib.get('playQueueItemID', '') def getDataFromPartOrMedia(self, key): """ Retrieves XML data 'key' first from the active part. If unsuccessful, tries to retrieve the data from the Media response part. If all fails, None is returned. """ media = self.item[0].attrib part = self.item[0][self.part].attrib try: try: value = part[key] except KeyError: value = media[key] except KeyError: value = None return value def getVideoCodec(self): """ Returns the video codec and resolution for the child and part selected. If any data is not found on a part-level, the Media-level data is returned. If that also fails (e.g. for old trailers, None is returned) Output: { 'videocodec': xxx, e.g. 'h264' 'resolution': xxx, e.g. '720' or '1080' 'height': xxx, e.g. '816' 'width': xxx, e.g. '1920' 'aspectratio': xxx, e.g. '1.78' 'bitrate': xxx, e.g. 10642 (an int!) 'container': xxx e.g. 'mkv' } """ videocodec = self.getDataFromPartOrMedia('videoCodec') resolution = self.getDataFromPartOrMedia('videoResolution') height = self.getDataFromPartOrMedia('height') width = self.getDataFromPartOrMedia('width') aspectratio = self.getDataFromPartOrMedia('aspectratio') bitrate = self.getDataFromPartOrMedia('bitrate') container = self.getDataFromPartOrMedia('container') videoCodec = { 'videocodec': videocodec, 'resolution': resolution, 'height': height, 'width': width, 'aspectratio': aspectratio, 'bitrate': bitrate, 'container': container } return videoCodec def getExtras(self): """ Returns a list of trailer and extras from PMS XML. Returns [] if no extras are found. Extratypes: '1': Trailer '5': Behind the scenes Output: list of dicts with one entry of the form: 'key': e.g. /library/metadata/xxxx 'title': 'thumb': artwork 'duration': 'extraType': 'originallyAvailableAt': 'year': """ elements = [] for extra in self.item.find('Extras'): # Trailer: key = extra.attrib.get('key', None) title = extra.attrib.get('title', None) thumb = extra.attrib.get('thumb', None) duration = float(extra.attrib.get('duration', 0.0)) year = extra.attrib.get('year', None) extraType = extra.attrib.get('extraType', None) originallyAvailableAt = extra.attrib.get( 'originallyAvailableAt', None) elements.append( {'key': key, 'title': title, 'thumb': thumb, 'duration': int(duration * PlexToKodiTimefactor()), 'extraType': extraType, 'originallyAvailableAt': originallyAvailableAt, 'year': year}) return elements def getMediaStreams(self): """ Returns the media streams for metadata purposes Output: each track contains a dictionaries { 'video': videotrack-list, 'codec', 'height', 'width', 'aspect', 'video3DFormat' 'audio': audiotrack-list, 'codec', 'channels', 'language' 'subtitle': list of subtitle languages (or "Unknown") } """ videotracks = [] audiotracks = [] subtitlelanguages = [] # Sometimes, aspectratio is on the "toplevel" aspectratio = self.item[0].attrib.get('aspectRatio', None) # TODO: what if several Media tags exist?!? # Loop over parts for child in self.item[0]: container = child.attrib.get('container', None) # Loop over Streams for grandchild in child: mediaStream = grandchild.attrib mediaType = int(mediaStream.get('streamType', 999)) if mediaType == 1: # Video streams videotrack = {} videotrack['codec'] = mediaStream['codec'].lower() if "msmpeg4" in videotrack['codec']: videotrack['codec'] = "divx" elif "mpeg4" in videotrack['codec']: # if "simple profile" in profile or profile == "": # videotrack['codec'] = "xvid" pass elif "h264" in videotrack['codec']: if container in ("mp4", "mov", "m4v"): videotrack['codec'] = "avc1" videotrack['height'] = mediaStream.get('height', None) videotrack['width'] = mediaStream.get('width', None) # TODO: 3d Movies?!? # videotrack['Video3DFormat'] = item.get('Video3DFormat') aspectratio = mediaStream.get('aspectRatio', aspectratio) videotrack['aspect'] = aspectratio # TODO: Video 3d format videotrack['video3DFormat'] = None videotracks.append(videotrack) elif mediaType == 2: # Audio streams audiotrack = {} audiotrack['codec'] = mediaStream['codec'].lower() profile = mediaStream.get('codecID', '').lower() if "dca" in audiotrack['codec'] and "dts-hd ma" in profile: audiotrack['codec'] = "dtshd_ma" audiotrack['channels'] = mediaStream.get('channels') # 'unknown' if we cannot get language audiotrack['language'] = mediaStream.get( 'language', self.__language__(39310)) audiotracks.append(audiotrack) elif mediaType == 3: # Subtitle streams # 'unknown' if we cannot get language subtitlelanguages.append( mediaStream.get('language', self.__language__(39310))) return { 'video': videotracks, 'audio': audiotracks, 'subtitle': subtitlelanguages } def getAllArtwork(self, parentInfo=False): """ Gets the URLs to the Plex artwork, or empty string if not found. Output: { 'Primary': Plex key: "thumb". Only 1 pix 'Art':, 'Banner':, 'Logo':, 'Thumb':, 'Disc':, 'Backdrop': [] Plex key: "art". Only 1 pix } """ item = self.item.attrib # maxHeight = 10000 # maxWidth = 10000 # customquery = "" # if utils.settings('compressArt') == "true": # customquery = "&Quality=90" # if utils.settings('enableCoverArt') == "false": # customquery += "&EnableImageEnhancers=false" allartworks = { 'Primary': "", 'Art': "", 'Banner': "", 'Logo': "", 'Thumb': "", 'Disc': "", 'Backdrop': [] } # Process backdrops # Get background artwork URL try: background = item['art'] background = "%s%s" % (self.server, background) background = self.addPlexCredentialsToUrl(background) except KeyError: background = "" allartworks['Backdrop'].append(background) # Get primary "thumb" pictures: try: primary = item['thumb'] primary = "%s%s" % (self.server, primary) primary = self.addPlexCredentialsToUrl(primary) except KeyError: primary = "" allartworks['Primary'] = primary # Process parent items if the main item is missing artwork if parentInfo: # Process parent backdrops if not allartworks['Backdrop']: background = item.get('parentArt') if background: background = "%s%s" % (self.server, background) background = self.addPlexCredentialsToUrl(background) allartworks['Backdrop'].append(background) if not allartworks['Primary']: primary = item.get('parentThumb') if primary: primary = "%s%s" % (self.server, primary) primary = self.addPlexCredentialsToUrl(primary) allartworks['Primary'] = primary return allartworks def getTranscodeVideoPath(self, action, quality={}): """ To be called on a VIDEO level of PMS xml response! Transcode Video support; returns the URL to get a media started Input: action 'DirectPlay', 'DirectStream' or 'Transcode' quality: { 'videoResolution': e.g. '1024x768', 'videoQuality': e.g. '60', 'maxVideoBitrate': e.g. '2000' (in kbits) } (one or several of these options) Output: final URL to pull in PMS transcoder TODO: mediaIndex """ xargs = clientinfo.ClientInfo().getXArgsDeviceInfo() # For DirectPlay, path/key of PART is needed if action == "DirectPlay": path = self.item[0][self.part].attrib['key'] url = self.server + path # e.g. Trailers already feature an '?'! if '?' in url: url += '&' + urlencode(xargs) else: url += '?' + urlencode(xargs) return url # For Direct Streaming or Transcoding # Path/key to VIDEO item of xml PMS response is needed, not part path = self.item.attrib['key'] transcodePath = self.server + \ '/video/:/transcode/universal/start.m3u8?' args = { 'protocol': 'hls', # seen in the wild: 'dash', 'http', 'hls' 'session': str(uuid4()), 'fastSeek': 1, 'path': path, 'mediaIndex': 0, # Probably refering to XML reply sheme 'partIndex': self.part, # 'copyts': 1, # 'offset': 0, # Resume point } # Seem like PHT to let the PMS use the transcoding profile xargs['X-Plex-Device'] = 'Plex Home Theater' # Currently not used! if action == "DirectStream": argsUpdate = { 'directPlay': '0', 'directStream': '1', } args.update(argsUpdate) elif action == 'Transcode': argsUpdate = { 'directPlay': '0', 'directStream': '0' } self.logMsg("Setting transcode quality to: %s" % quality, 1) args.update(quality) args.update(argsUpdate) url = transcodePath + urlencode(xargs) + '&' + urlencode(args) return url def externalSubs(self, playurl): externalsubs = [] mapping = {} item = self.item try: mediastreams = item[0][self.part] except (TypeError, KeyError, IndexError): return kodiindex = 0 for stream in mediastreams: index = stream.attrib['id'] # Since Emby returns all possible tracks together, have to pull only external subtitles. key = stream.attrib.get('key') # IsTextSubtitleStream if true, is available to download from emby. if stream.attrib.get('streamType') == "3" and key: # Direct stream url = ("%s%s" % (self.server, key)) url = self.addPlexCredentialsToUrl(url) # map external subtitles for mapping mapping[kodiindex] = index externalsubs.append(url) kodiindex += 1 mapping = json.dumps(mapping) utils.window('emby_%s.indexMapping' % playurl, value=mapping) self.logMsg('Found external subs: %s' % externalsubs) return externalsubs def CreateListItemFromPlexItem(self, listItem=None): """ Call on a child level of PMS xml response (e.g. in a for loop) listItem: existing xbmcgui.ListItem to work with otherwise, a new one is created Returns XBMC listitem for this PMS library item """ people = self.getPeople() userdata = self.getUserData() title, sorttitle = self.getTitle() if listItem is None: listItem = xbmcgui.ListItem() metadata = { 'genre': self.joinList(self.getGenres()), 'year': self.getYear(), 'rating': self.getAudienceRating(), 'playcount': userdata['PlayCount'], 'cast': people['Cast'], 'director': self.joinList(people.get('Director')), 'plot': self.getPlot(), 'title': title, 'sorttitle': sorttitle, 'duration': userdata['Runtime'], 'studio': self.joinList(self.getStudios()), 'tagline': self.getTagline(), 'writer': self.joinList(people.get('Writer')), 'premiered': self.getPremiereDate(), 'dateadded': self.getDateCreated(), 'lastplayed': userdata['LastPlayedDate'], 'mpaa': self.getMpaa(), 'aired': self.getPremiereDate() } if "episode" in self.getType(): # Only for tv shows key, show, season, episode = self.getEpisodeDetails() metadata['episode'] = episode metadata['season'] = season metadata['tvshowtitle'] = show listItem.setProperty('IsPlayable', 'true') listItem.setProperty('IsFolder', 'false') listItem.setProperty('embyid', self.getRatingKey()) listItem.setLabel(title) listItem.setInfo('video', infoLabels=metadata) return listItem def AddStreamInfo(self, listItem): """ Add media stream information to xbmcgui.ListItem """ mediastreams = self.getMediaStreams() videostreamFound = False if mediastreams: for key, value in mediastreams.iteritems(): if key == "video" and value: videostreamFound = True if value: listItem.addStreamInfo(key, value) if not videostreamFound: # just set empty streamdetails to prevent errors in the logs listItem.addStreamInfo( "video", {'duration': self.getRuntime()[1]}) def validatePlayurl(self, playurl, typus): """ Returns a valid url for Kodi, e.g. with substituted path """ if utils.window('remapSMB') == 'true': playurl = playurl.replace(utils.window('remapSMB%sOrg' % typus), utils.window('remapSMB%sNew' % typus)) # There might be backslashes left over: playurl = playurl.replace('\\', '/') elif utils.window('replaceSMB') == 'true': if playurl.startswith('\\\\'): playurl = 'smb:' + playurl.replace('\\', '/') if (utils.window('emby_pathverified') != "true" and not xbmcvfs.exists(playurl.encode('utf-8'))): # Validate the path is correct with user intervention if self.askToValidate(playurl): utils.window('emby_shouldStop', value="true") playurl = False utils.window('emby_pathverified', value='true') utils.settings('emby_pathverified', value='true') return playurl def askToValidate(self, url): """ Displays a YESNO dialog box: Kodi can't locate file: . Please verify the path. You may need to verify your network credentials in the add-on settings or use different Plex paths. Stop syncing? Returns True if sync should stop, else False """ self.logMsg('Cannot access file: %s' % url, -1) import xbmcaddon string = xbmcaddon.Addon().getLocalizedString resp = xbmcgui.Dialog().yesno( heading=self.addonName, line1=string(39031) + url, line2=string(39032)) return resp