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 logger
   7 ##
   8 # ServerException, ExceptionUnmarshaller
   9 #
  10 # Used to convert server exception strings back to an exception.
  11 #    from usenet, Raghuram Devarakonda
  12
  13 class ServerException(Exception):
  14     pass
  15
  16 class ExceptionUnmarshaller(xmlrpclib.Unmarshaller):
  17     def close(self):
  18         try:
  19             return xmlrpclib.Unmarshaller.close(self)
  20         except xmlrpclib.Fault, e:
  21             raise ServerException(e.faultString)
  22
  23 ##
  24 # XMLRPCTransport
  25 #
  26 # A transport for XMLRPC that works on top of HTTPS
  27
  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')
  35
  36 class XMLRPCTransport(xmlrpclib.Transport):
  37     key_file = None
  38     cert_file = None
  39     def make_connection(self, host):
  40         # create a HTTPS connection object from a host descriptor
  41         # host may be a string, or a (host, x509-dict) tuple
  42         host, extra_headers, x509 = self.get_host_info(host)
  43         if need_HTTPSConnection:
  44             return httplib.HTTPSConnection(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
  45         else:
  46             return httplib.HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
  47
  48     def getparser(self):
  49         unmarshaller = ExceptionUnmarshaller()
  50         parser = xmlrpclib.ExpatParser(unmarshaller)
  51         return parser, unmarshaller
  52
  53 class XMLRPCServerProxy(xmlrpclib.ServerProxy):
  54     def __init__(self, url, transport, allow_none=True, options=None):
  55         # remember url for GetVersion
  56         self.url=url
  57         verbose = False
  58         if options and options.debug:
  59             verbose = True
  60         xmlrpclib.ServerProxy.__init__(self, url, transport, allow_none=allow_none, verbose=verbose)
  61
  62     def __getattr__(self, attr):
  63         logger.debug ("xml-rpc %s method:%s"%(self.url,attr))
  64         return xmlrpclib.ServerProxy.__getattr__(self, attr)
  65
  66
  67 def get_server(url, key_file, cert_file, options=None):
  68     transport = XMLRPCTransport()
  69     transport.key_file = key_file
  70     transport.cert_file = cert_file
  71
  72     return XMLRPCServerProxy(url, transport, allow_none=True, options=options)
  73