X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FAPI.py;h=c40f28e712d132631a1e36d4c7f38db4926fac4f;hb=e70e20fdbececafef842ec7b330fd48db42e614e;hp=8d95f8e36d847eeebbedc4a3c966ed4a14419603;hpb=763c0f2e7bb9b3422f3951dafe7595eb85041b72;p=plcapi.git diff --git a/PLC/API.py b/PLC/API.py index 8d95f8e..c40f28e 100644 --- a/PLC/API.py +++ b/PLC/API.py @@ -5,16 +5,14 @@ # Mark Huang # # Copyright (C) 2004-2006 The Trustees of Princeton University -# $Id$ -# $URL$ # +import os import sys import traceback import string import xmlrpclib -import simplejson # See "2.2 Characters" in the XML specification: # @@ -22,8 +20,13 @@ import simplejson # 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)) +invalid_codepoints = range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F) +# broke with f24, somehow we get a unicode as an incoming string to be translated +str_xml_escape_table = string.maketrans("".join((chr(x) for x in invalid_codepoints)), + "?" * len(invalid_codepoints)) +# loosely inspired from +# http://stackoverflow.com/questions/1324067/how-do-i-get-str-translate-to-work-with-unicode-strings +unicode_xml_escape_table = { invalid : u"?" for invalid in invalid_codepoints} def xmlrpclib_escape(s, replace = string.replace): """ @@ -38,7 +41,23 @@ def xmlrpclib_escape(s, replace = string.replace): s = replace(s, ">", ">",) # Replace invalid 7-bit control characters with '?' - return s.translate(xml_escape_table) + if isinstance(s, str): + return s.translate(str_xml_escape_table) + else: + return s.translate(unicode_xml_escape_table) + +def test_xmlrpclib_escape(): + inputs = [ + # full ASCII + "".join( (chr(x) for x in range(128))), + # likewise but as a unicode string up to 256 + u"".join( (unichr(x) for x in range(256))), + ] + for input in inputs: + print "==================== xmlrpclib_escape INPUT" + print type(input), '->', input + print "==================== xmlrpclib_escape OUTPUT" + print xmlrpclib_escape(input) def xmlrpclib_dump(self, value, write): """ @@ -122,6 +141,8 @@ class PLCAPI: # Load configuration self.config = Config(config) +# print("config has keys {}" +# .format(vars(self.config).keys())) # Initialize database connection if self.config.PLC_DB_TYPE == "postgresql": @@ -130,11 +151,36 @@ class PLCAPI: else: raise PLCAPIError, "Unsupported database type " + self.config.PLC_DB_TYPE - # Aspects modify the API injecting code before/after method - # calls. As of now we only have aspects for OMF integration, - # that's why we enable aspects only if PLC_OMF is set to true. - if self.config.PLC_OMF_ENABLED: - from aspects import apply_aspects; apply_aspects() + # Aspects modify the API by injecting code before, after or + # around method calls. -- http://github.com/baris/pyaspects/blob/master/README + # + if self.config.PLC_RATELIMIT_ENABLED: + from aspects import apply_ratelimit_aspect + apply_ratelimit_aspect() + + if getattr(self.config, "PLC_NETCONFIG_ENABLED", False): + from aspects.netconfigaspects import apply_netconfig_aspect + apply_netconfig_aspect() + + # Enable Caching. Only for GetSlivers for the moment. + # TODO: we may consider to do this in an aspect like the ones above. + try: + if self.config.PLC_GETSLIVERS_CACHE: + getslivers_cache = True + except AttributeError: + getslivers_cache = False + + if getslivers_cache: + os.environ['DJANGO_SETTINGS_MODULE']='plc_django_settings' + from cache_utils.decorators import cached + from PLC.Methods.GetSlivers import GetSlivers + + @cached(7200) + def cacheable_call(cls, auth, node_id_or_hostname): + return cls.raw_call(auth, node_id_or_hostname) + + GetSlivers.call = cacheable_call + def callable(self, method): @@ -213,12 +259,14 @@ class PLCAPI: """ Handle a JSON request """ - method, args = simplejson.loads(data) + method, args = json.loads(data) try: result = self.call(source, method, *args) except Exception, e: result = str(e) - return simplejson.dumps(result) - + return json.dumps(result) +# one simple unit test +if __name__ == '__main__': + test_xmlrpclib_escape()