2 # Geniwrapper XML-RPC and SOAP interfaces
4 ### $Id: api.py 15596 2009-10-31 21:42:05Z anil $
5 ### $URL: https://svn.planet-lab.org/svn/sfa/trunk/sfa/plc/api.py $
14 from sfa.trust.auth import Auth
15 from sfa.util.config import *
16 from sfa.util.faults import *
17 from sfa.util.debug import *
18 from sfa.trust.credential import *
19 from sfa.trust.certificate import *
20 from sfa.util.misc import *
21 from sfa.util.sfalogging import *
23 # See "2.2 Characters" in the XML specification:
25 # #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
27 # [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
29 invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F))
30 xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii))
32 def xmlrpclib_escape(s, replace = string.replace):
34 xmlrpclib does not handle invalid 7-bit control characters. This
35 function augments xmlrpclib.escape, which by default only replaces
36 '&', '<', and '>' with entities.
39 # This is the standard xmlrpclib.escape function
40 s = replace(s, "&", "&")
41 s = replace(s, "<", "<")
42 s = replace(s, ">", ">",)
44 # Replace invalid 7-bit control characters with '?'
45 return s.translate(xml_escape_table)
47 def xmlrpclib_dump(self, value, write):
49 xmlrpclib cannot marshal instances of subclasses of built-in
50 types. This function overrides xmlrpclib.Marshaller.__dump so that
51 any value that is an instance of one of its acceptable types is
52 marshalled as that type.
54 xmlrpclib also cannot handle invalid 7-bit control characters. See
58 # Use our escape function
59 args = [self, value, write]
60 if isinstance(value, (str, unicode)):
61 args.append(xmlrpclib_escape)
64 # Try for an exact match first
65 f = self.dispatch[type(value)]
68 # Try for an isinstance() match
69 for Type, f in self.dispatch.iteritems():
70 if isinstance(value, Type):
73 raise TypeError, "cannot marshal %s objects" % type(value)
77 # You can't hide from me!
78 xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
80 # SOAP support is optional
83 from SOAPpy.Parser import parseSOAPRPC
84 from SOAPpy.Types import faultType
85 from SOAPpy.NS import NS
86 from SOAPpy.SOAPBuilder import buildSOAP
91 def import_deep(name):
92 mod = __import__(name)
93 components = name.split('.')
94 for comp in components[1:]:
95 mod = getattr(mod, comp)
100 def __init__(self, config = "/etc/sfa/sfa_config", encoding = "utf-8", methods='sfa.methods',
101 peer_cert = None, interface = None, key_file = None, cert_file = None):
103 self.encoding = encoding
105 # flat list of method names
106 methods_module = __import__(methods)
107 self.methods = methods_module.methods.all
109 # Better just be documenting the API
114 self.config = Config(config)
115 self.auth = Auth(peer_cert)
116 self.interface = interface
117 self.key_file = key_file
118 self.key = Keypair(filename=self.key_file)
119 self.cert_file = cert_file
120 self.cert = Certificate(filename=self.cert_file)
121 self.credential = None
123 self.time_format = "%Y-%m-%d %H:%M:%S"
124 self.logger=get_sfa_logger()
127 def callable(self, method):
129 Return a new instance of the specified method.
132 if method not in self.methods:
133 raise GeniInvalidAPIMethod, method
135 # Get new instance of method
137 classname = method.split(".")[-1]
138 module = __import__("sfa.methods." + method, globals(), locals(), [classname])
139 callablemethod = getattr(module, classname)(self)
140 return getattr(module, classname)(self)
141 except ImportError, AttributeError:
142 raise GeniInvalidAPIMethod, method
144 def call(self, source, method, *args):
146 Call the named method from the specified source with the
149 function = self.callable(method)
150 function.source = source
151 return function(*args)
153 def handle(self, source, data):
155 Handle an XML-RPC or SOAP request from the specified source.
157 # Parse request into method name and arguments
159 interface = xmlrpclib
160 (args, method) = xmlrpclib.loads(data)
161 methodresponse = True
163 if SOAPpy is not None:
165 (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
168 # XXX Support named arguments
173 result = self.call(source, method, *args)
174 except Exception, fault:
175 traceback.print_exc(file = log)
176 # Handle expected faults
177 if interface == xmlrpclib:
179 methodresponse = None
180 elif interface == SOAPpy:
181 result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
182 result._setDetail("Fault %d: %s" % (fault.faultCode, fault.faultString))
187 if interface == xmlrpclib:
188 if not isinstance(result, GeniFault):
191 data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1)
192 elif interface == SOAPpy:
193 data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)