2d2586e8c8eacbb4bd2aeb5021c1211d7391bad9
[sfa.git] / sfa / util / xmlrpcprotocol.py
1 # XMLRPC-specific code for SFA Client
2
3 import httplib
4 import xmlrpclib
5
6 from sfa.util.sfalogging import sfa_logger
7
8 ##
9 # ServerException, ExceptionUnmarshaller
10 #
11 # Used to convert server exception strings back to an exception.
12 #    from usenet, Raghuram Devarakonda
13
14 class ServerException(Exception):
15     pass
16
17 class ExceptionUnmarshaller(xmlrpclib.Unmarshaller):
18     def close(self):
19         try:
20             return xmlrpclib.Unmarshaller.close(self)
21         except xmlrpclib.Fault, e:
22             raise ServerException(e.faultString)
23
24 ##
25 # XMLRPCTransport
26 #
27 # A transport for XMLRPC that works on top of HTTPS
28
29 class XMLRPCTransport(xmlrpclib.Transport):
30     key_file = None
31     cert_file = None
32     def make_connection(self, host):
33         # create a HTTPS connection object from a host descriptor
34         # host may be a string, or a (host, x509-dict) tuple
35         host, extra_headers, x509 = self.get_host_info(host)
36         try:
37 #            return httplib.HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
38             return httplib.HTTPSConnection(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
39         except AttributeError:
40             raise NotImplementedError("your version of httplib doesn't support HTTPSConnection")
41
42     def getparser(self):
43         unmarshaller = ExceptionUnmarshaller()
44         parser = xmlrpclib.ExpatParser(unmarshaller)
45         return parser, unmarshaller
46
47 class XMLRPCServerProxy(xmlrpclib.ServerProxy):
48     def __init__(self, url, transport, allow_none=True, options=None):
49         verbose = False
50         if options and options.debug:
51             verbose = True
52         sfa_logger().info ("Connecting to xmlrpcserver at %s (with verbose=%s)"%(url,verbose))
53         xmlrpclib.ServerProxy.__init__(self, url, transport, allow_none=allow_none, verbose=verbose)
54
55     def __getattr__(self, attr):
56         sfa_logger().info ("Calling xml-rpc method:%s"%attr)
57         return xmlrpclib.ServerProxy.__getattr__(self, attr)
58
59
60 def get_server(url, key_file, cert_file, options=None):
61     transport = XMLRPCTransport()
62     transport.key_file = key_file
63     transport.cert_file = cert_file
64
65     return XMLRPCServerProxy(url, transport, allow_none=True, options=options)
66