X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FAPI.py;h=5c06848540f7da11c21bbda111a4db1a893aba5b;hb=f7128cb26e05a7671a81b9d3940366cb139884e3;hp=4b1929194139f9ab17300b942c056c326ac39932;hpb=24d16d18acab3da7bccc3e09df4927e9cf2d3246;p=plcapi.git diff --git a/PLC/API.py b/PLC/API.py index 4b19291..5c06848 100644 --- a/PLC/API.py +++ b/PLC/API.py @@ -5,41 +5,105 @@ # Mark Huang # # Copyright (C) 2004-2006 The Trustees of Princeton University -# $Id$ +# $Id: API.py,v 1.8 2007/01/05 16:09:09 tmack Exp $ # import sys import traceback +import string import xmlrpclib -import SOAPpy -from SOAPpy.Parser import parseSOAPRPC -from SOAPpy.Types import faultType -from SOAPpy.NS import NS -from SOAPpy.SOAPBuilder import buildSOAP +# See "2.2 Characters" in the XML specification: +# +# #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] +# avoiding +# [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF] + +invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F)) +xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii)) + +def xmlrpclib_escape(s, replace = string.replace): + """ + xmlrpclib does not handle invalid 7-bit control characters. This + function augments xmlrpclib.escape, which by default only replaces + '&', '<', and '>' with entities. + """ + + # This is the standard xmlrpclib.escape function + s = replace(s, "&", "&") + s = replace(s, "<", "<") + s = replace(s, ">", ">",) + + # Replace invalid 7-bit control characters with '?' + return s.translate(xml_escape_table) + +def xmlrpclib_dump(self, value, write): + """ + xmlrpclib cannot marshal instances of subclasses of built-in + types. This function overrides xmlrpclib.Marshaller.__dump so that + any value that is an instance of one of its acceptable types is + marshalled as that type. + + xmlrpclib also cannot handle invalid 7-bit control characters. See + above. + """ + + # Use our escape function + args = [self, value, write] + if isinstance(value, (str, unicode)): + args.append(xmlrpclib_escape) + + try: + # Try for an exact match first + f = self.dispatch[type(value)] + except KeyError: + # Try for an isinstance() match + for Type, f in self.dispatch.iteritems(): + if isinstance(value, Type): + f(*args) + return + raise TypeError, "cannot marshal %s objects" % type(value) + else: + f(*args) + +# You can't hide from me! +xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump + +# SOAP support is optional +try: + import SOAPpy + from SOAPpy.Parser import parseSOAPRPC + from SOAPpy.Types import faultType + from SOAPpy.NS import NS + from SOAPpy.SOAPBuilder import buildSOAP +except ImportError: + SOAPpy = None from PLC.Config import Config -from PLC.PostgreSQL import PostgreSQL from PLC.Faults import * import PLC.Methods class PLCAPI: methods = PLC.Methods.methods - def __init__(self, config = "/etc/planetlab/plc_config"): + def __init__(self, config = "/etc/planetlab/plc_config", encoding = "utf-8"): + self.encoding = encoding + # Better just be documenting the API if config is None: return # Load configuration self.config = Config(config) - - # Initialize database connection + + # Initialize database connection if self.config.PLC_DB_TYPE == "postgresql": + from PLC.PostgreSQL import PostgreSQL self.db = PostgreSQL(self) + else: - raise PLCAPIError, "Unsupported database type " + config.PLC_DB_TYPE + raise PLCAPIError, "Unsupported database type " + self.config.PLC_DB_TYPE def callable(self, method): """ @@ -78,12 +142,15 @@ class PLCAPI: interface = xmlrpclib (args, method) = xmlrpclib.loads(data) methodresponse = True - except: - interface = SOAPpy - (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1) - method = r._name - args = r._aslist() - # XXX Support named arguments + except Exception, e: + if SOAPpy is not None: + interface = SOAPpy + (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1) + method = r._name + args = r._aslist() + # XXX Support named arguments + else: + raise e try: result = self.call(source, method, *args) @@ -100,8 +167,8 @@ class PLCAPI: if interface == xmlrpclib: if not isinstance(result, PLCFault): result = (result,) - data = xmlrpclib.dumps(result, methodresponse = True) + data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1) elif interface == SOAPpy: - data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}) + data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding) return data