X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FAPI.py;h=55a034921d36cd5e7a0d4d46411e4554a2e38313;hb=1cda98c34563ed3e90a9d2219730ae81f9705dc6;hp=a42e6c93af42495bd849bd18242112ac41edde9f;hpb=663a5d604bc5e96c77c62e9fdd9da66842d12589;p=plcapi.git

diff --git a/PLC/API.py b/PLC/API.py
index a42e6c9..55a0349 100644
--- a/PLC/API.py
+++ b/PLC/API.py
@@ -5,22 +5,56 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 #
 # Copyright (C) 2004-2006 The Trustees of Princeton University
-# $Id: API.py,v 1.4 2006/10/13 20:00:21 mlhuang Exp $
+# $Id$
+# $URL$
 #
 
 import sys
 import traceback
+import string
 
 import xmlrpclib
 
-def dump(self, value, write):
+# 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, "&", "&amp;")
+    s = replace(s, "<", "&lt;")
+    s = replace(s, ">", "&gt;",)
+
+    # 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)]
@@ -28,14 +62,14 @@ def dump(self, value, write):
         # Try for an isinstance() match
         for Type, f in self.dispatch.iteritems():
             if isinstance(value, Type):
-                f(self, value, write)
+                f(*args)
                 return
         raise TypeError, "cannot marshal %s objects" % type(value)
     else:
-        f(self, value, write)        
+        f(*args)
 
 # You can't hide from me!
-xmlrpclib.Marshaller._Marshaller__dump = dump
+xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
 
 # SOAP support is optional
 try:
@@ -48,13 +82,36 @@ except ImportError:
     SOAPpy = None
 
 from PLC.Config import Config
-from PLC.PostgreSQL import PostgreSQL
 from PLC.Faults import *
 import PLC.Methods
+import PLC.Accessors
+
+def import_deep(name):
+    mod = __import__(name)
+    components = name.split('.')
+    for comp in components[1:]:
+        mod = getattr(mod, comp)
+    return mod
 
 class PLCAPI:
-    methods = PLC.Methods.methods
 
+    # flat list of method names
+    native_methods = PLC.Methods.native_methods
+
+    # other_methods_map : dict {methodname: fullpath}
+    # e.g. 'Accessors' -> 'PLC.Accessors.Accessors'
+    other_methods_map={}
+    for subdir in [ 'Accessors' ]:
+        path="PLC."+subdir
+        # scan e.g. PLC.Accessors.__all__
+        pkg = __import__(path).__dict__[subdir]
+        for modulename in getattr(pkg,"__all__"):
+            fullpath=path+"."+modulename
+            for method in getattr(import_deep(fullpath),"methods"):
+                other_methods_map[method] = fullpath
+
+    all_methods = native_methods + other_methods_map.keys()
+    
     def __init__(self, config = "/etc/planetlab/plc_config", encoding = "utf-8"):
         self.encoding = encoding
 
@@ -64,12 +121,20 @@ class PLCAPI:
 
         # 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
+
+        # 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:
+            from aspects import apply_aspects; apply_aspects()
+
 
     def callable(self, method):
         """
@@ -77,16 +142,20 @@ class PLCAPI:
         """
 
         # Look up method
-        if method not in self.methods:
+        if method not in self.all_methods:
             raise PLCInvalidAPIMethod, method
-
+        
         # Get new instance of method
         try:
             classname = method.split(".")[-1]
-            module = __import__("PLC.Methods." + method, globals(), locals(), [classname])
+            if method in self.native_methods:
+                fullpath="PLC.Methods." + method
+            else:
+                fullpath=self.other_methods_map[method]
+            module = __import__(fullpath, globals(), locals(), [classname])
             return getattr(module, classname)(self)
         except ImportError, AttributeError:
-            raise PLCInvalidAPIMethod, method
+            raise PLCInvalidAPIMethod, "import error %s for %s" % (AttributeError,fullpath)
 
     def call(self, source, method, *args):
         """