1 # XMLRPC-specific code for SFA Client
4 #from sfa.util.httpsProtocol import HTTPS, HTTPSConnection
5 from httplib import HTTPS, HTTPSConnection
6 from sfa.util.sfalogging import logger
8 # ServerException, ExceptionUnmarshaller
10 # Used to convert server exception strings back to an exception.
11 # from usenet, Raghuram Devarakonda
13 class ServerException(Exception):
16 class ExceptionUnmarshaller(xmlrpclib.Unmarshaller):
19 return xmlrpclib.Unmarshaller.close(self)
20 except xmlrpclib.Fault, e:
21 raise ServerException(e.faultString)
26 # A transport for XMLRPC that works on top of HTTPS
28 # python 2.7 xmlrpclib has changed its internal code
29 # it now calls 'getresponse' on the obj returned by make_connection
30 # while it used to call 'getreply'
31 # regardless of the version, httplib.HTTPS does implement getreply,
32 # while httplib.HTTPSConnection has getresponse
33 # so we create a dummy instance to check what's expected
34 need_HTTPSConnection=hasattr(xmlrpclib.Transport().make_connection('localhost'),'getresponse')
36 class XMLRPCTransport(xmlrpclib.Transport):
38 def __init__(self, key_file=None, cert_file=None, timeout=None):
39 xmlrpclib.Transport.__init__(self)
41 self.key_file = key_file
42 self.cert_file = cert_file
44 def make_connection(self, host):
45 # create a HTTPS connection object from a host descriptor
46 # host may be a string, or a (host, x509-dict) tuple
47 host, extra_headers, x509 = self.get_host_info(host)
48 if need_HTTPSConnection:
49 #conn = HTTPSConnection(host, None, key_file=self.key_file, cert_file=self.cert_file, timeout=self.timeout) #**(x509 or {}))
50 conn = HTTPSConnection(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
53 conn = HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file, timeout=self.timeout) #**(x509 or {}))
55 # some versions don't have a timeout argument
56 conn = HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
58 if hasattr(conn, 'set_timeout'):
59 conn.set_timeout(self.timeout)
61 # Some logic to deal with timeouts. It appears that some (or all) versions
62 # of python don't set the timeout after the socket is created. We'll do it
63 # ourselves by forcing the connection to connect, finding the socket, and
64 # calling settimeout() on it. (tested with python 2.6)
66 if hasattr(conn, "_conn"):
67 # HTTPS is a wrapper around HTTPSConnection
68 real_conn = conn._conn
72 if hasattr(real_conn, "sock") and hasattr(real_conn.sock, "settimeout"):
73 real_conn.sock.settimeout(self.timeout)
78 unmarshaller = ExceptionUnmarshaller()
79 parser = xmlrpclib.ExpatParser(unmarshaller)
80 return parser, unmarshaller
82 class XMLRPCServerProxy(xmlrpclib.ServerProxy):
83 def __init__(self, url, transport, allow_none=True, verbose=False):
84 # remember url for GetVersion
86 xmlrpclib.ServerProxy.__init__(self, url, transport, allow_none=allow_none, verbose=verbose)
88 def __getattr__(self, attr):
89 logger.debug ("xml-rpc %s method:%s"%(self.url,attr))
90 return xmlrpclib.ServerProxy.__getattr__(self, attr)
92 def get_server(url, key_file, cert_file, timeout=None, verbose=False):
93 transport = XMLRPCTransport(key_file, cert_file, timeout)
94 return XMLRPCServerProxy(url, transport, allow_none=True, verbose=verbose)