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 # python 2.7 xmlrpclib has changed its internal code
  30 # it now calls 'getresponse' on the obj returned by make_connection
  31 # while it used to call 'getreply'
  32 # regardless of the version, httplib.HTTPS does implement getreply,
  33 # while httplib.HTTPSConnection has getresponse
  34 # so we create a dummy instance to check what's expected
  35 need_HTTPSConnection=hasattr(xmlrpclib.Transport().make_connection('localhost'),'getresponse')
  36
  37 class XMLRPCTransport(xmlrpclib.Transport):
  38     key_file = None
  39     cert_file = None
  40     def make_connection(self, host):
  41         # create a HTTPS connection object from a host descriptor
  42         # host may be a string, or a (host, x509-dict) tuple
  43         host, extra_headers, x509 = self.get_host_info(host)
  44         if need_HTTPSConnection:
  45             return httplib.HTTPSConnection(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
  46         else:
  47             return httplib.HTTPS(host, None, key_file=self.key_file, cert_file=self.cert_file) #**(x509 or {}))
  48
  49     def getparser(self):
  50         unmarshaller = ExceptionUnmarshaller()
  51         parser = xmlrpclib.ExpatParser(unmarshaller)
  52         return parser, unmarshaller
  53
  54 class XMLRPCServerProxy(xmlrpclib.ServerProxy):
  55     def __init__(self, url, transport, allow_none=True, options=None):
  56         # remember url for GetVersion
  57         self.url=url
  58         verbose = False
  59         if options and options.debug:
  60             verbose = True
  61 #        sfa_logger().debug ("xmlrpcprotocol.XMLRPCServerProxy.__init__ %s (with verbose=%s)"%(url,verbose))
  62         xmlrpclib.ServerProxy.__init__(self, url, transport, allow_none=allow_none, verbose=verbose)
  63
  64     def __getattr__(self, attr):
  65         sfa_logger().debug ("xml-rpc %s method:%s"%(self.url,attr))
  66         return xmlrpclib.ServerProxy.__getattr__(self, attr)
  67
  68
  69 def get_server(url, key_file, cert_file, options=None):
  70     transport = XMLRPCTransport()
  71     transport.key_file = key_file
  72     transport.cert_file = cert_file
  73
  74     return XMLRPCServerProxy(url, transport, allow_none=True, options=options)
  75