fix issue with escaping unicode strings for xmlrpc

[plcapi.git] / PLC / API.py

diff --git a/PLC/API.py b/PLC/API.py
index 308fa11..6e59d56 100644 (file)
--- a/PLC/API.py
+++ b/PLC/API.py
@@ -7,23 +7,12 @@
 # Copyright (C) 2004-2006 The Trustees of Princeton University
 #
 
+import os
 import sys
 import traceback
 import string
 
 import xmlrpclib
-import simplejson
-try:
-    # Try to use jsonlib before using simpljson. This is a hack to get around
-    # the fact that the version of simplejson avaialble for f8 is slightly 
-    # faster than xmlrpc but not as fast as jsonlib. There is no jsonlib 
-    # pacakge available for f8, so this has to be installed manually and
-    # is not expected to always be available. Remove this once we move away
-    # from f8 based MyPLC's         
-    import jsonlib
-    json = jsonlib
-except:
-    json = simplejson 
 
 # See "2.2 Characters" in the XML specification:
 #
@@ -31,8 +20,13 @@ except:
 # 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://www.terminally-incoherent.com/blog/2010/05/06/character-mapping-must-return-integer-none-or-unicode/
+unicode_xml_escape_table = { invalid : u"?" for invalid in invalid_codepoints}
 
 def xmlrpclib_escape(s, replace = string.replace):
     """
@@ -47,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):
     """
@@ -142,16 +152,34 @@ class PLCAPI:
         # Aspects modify the API by injecting code before, after or
         # around method calls. -- http://github.com/baris/pyaspects/blob/master/README
         # 
-        # 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_omf_aspect
-            apply_omf_aspect()
-        
         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):
         """
@@ -237,4 +265,6 @@ class PLCAPI:
        
         return json.dumps(result) 
         
-        
+# one simple unit test        
+if __name__ == '__main__':
+    test_xmlrpclib_escape()