Function getXMLFromPMS

PlexAPI.py:429–479

(baseURL, path, options={}, authtoken='', enableGzip=False)

    returned XML or 'False' in case of error
"""
def getXMLFromPMS(baseURL, path, options={}, authtoken='', enableGzip=False):
    xargs = {}
    if not options==None:
        xargs = getXArgsDeviceInfo(options)
    if not authtoken=='':
        xargs['X-Plex-Token'] = authtoken
    
    dprint(__name__, 1, "URL: {0}{1}", baseURL, path)
    dprint(__name__, 1, "xargs: {0}", xargs)

    method = 'GET'
    if options is not None and 'PlexConnectMethod' in options:
        dprint(__name__, 1, 'Custom method ' + method)
        method = options['PlexConnectMethod']
    
    request = urllib2.Request(baseURL+path , None, xargs)
    request.add_header('User-agent', 'PlexConnect')

    request.get_method = lambda: method
    if enableGzip:
        request.add_header('Accept-encoding', 'gzip')
    
    try:
        response = urllib2.urlopen(request, timeout=20)
    except (urllib2.URLError, httplib.HTTPException) as e:
        dprint(__name__, 1, 'No Response from Plex Media Server')
        if hasattr(e, 'reason'):
            dprint(__name__, 1, "We failed to reach a server. Reason: {0}", e.reason)
        elif hasattr(e, 'code'):
            dprint(__name__, 1, "The server couldn't fulfill the request. Error code: {0}", e.code)
        dprint(__name__, 1, 'Traceback:\n{0}', traceback.format_exc())
        return False
    except IOError:
        dprint(__name__, 0, 'Error loading response XML from Plex Media Server:\n{0}', traceback.format_exc())
        return False
    
    if response.info().get('Content-Encoding') == 'gzip':
        buf = StringIO.StringIO(response.read())
        file = gzip.GzipFile(fileobj=buf)
        XML = etree.parse(file)
    else:
        # parse into etree
        XML = etree.parse(response)
    
    dprint(__name__, 1, "====== received PMS-XML ======")
    dprint(__name__, 1, XML.getroot())
    dprint(__name__, 1, "====== PMS-XML finished ======")
    
    #XMLTree = etree.ElementTree(etree.fromstring(response))
    
    return XML