persons & tags : allow tags to be passed to AddPerson, and update
[plcapi.git] / PLC / API.py
index 3c825b7..9f13f38 100644 (file)
@@ -5,14 +5,26 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 #
 # Copyright (C) 2004-2006 The Trustees of Princeton University
-# $Id$
 #
 
+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:
 #
@@ -83,8 +95,7 @@ except ImportError:
 from PLC.Config import Config
 from PLC.Faults import *
 import PLC.Methods
-import PLC.Shortcuts
-import PLC.Legacy
+import PLC.Accessors
 
 def import_deep(name):
     mod = __import__(name)
@@ -99,11 +110,11 @@ class PLCAPI:
     native_methods = PLC.Methods.native_methods
 
     # other_methods_map : dict {methodname: fullpath}
-    # e.g. 'Shortcuts' -> 'PLC.Shortcuts.Shortcuts'
+    # e.g. 'Accessors' -> 'PLC.Accessors.Accessors'
     other_methods_map={}
-    for subdir in [ 'Shortcuts', 'Legacy']:
+    for subdir in [ 'Accessors' ]:
         path="PLC."+subdir
-        # scan e.g. PLC.Shortcuts.__all__
+        # scan e.g. PLC.Accessors.__all__
         pkg = __import__(path).__dict__[subdir]
         for modulename in getattr(pkg,"__all__"):
             fullpath=path+"."+modulename
@@ -111,7 +122,7 @@ class PLCAPI:
                 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
 
@@ -121,15 +132,49 @@ 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 " + self.config.PLC_DB_TYPE
 
+        # 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()
+
+
+        # 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):
         """
         Return a new instance of the specified method.
@@ -138,19 +183,18 @@ class PLCAPI:
         # Look up method
         if method not in self.all_methods:
             raise PLCInvalidAPIMethod, method
-        
+
         # Get new instance of method
         try:
             classname = method.split(".")[-1]
             if method in self.native_methods:
-                module = __import__("PLC.Methods." + method, globals(), locals(), [classname])
-                return getattr(module, classname)(self)
+                fullpath="PLC.Methods." + method
             else:
                 fullpath=self.other_methods_map[method]
-                module = __import__(fullpath, globals(), locals(), [classname])
-                return getattr(module, classname)(self)
+            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):
         """
@@ -202,3 +246,17 @@ class PLCAPI:
             data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)
 
         return data
+
+    def handle_json(self, source, data):
+        """
+        Handle a JSON request 
+        """
+        method, args = json.loads(data)
+        try:
+            result = self.call(source, method, *args)
+        except Exception, e:
+            result = str(e)
+       
+        return json.dumps(result) 
+        
+