PLC/API.py

   1 #
   2 # PLCAPI XML-RPC and SOAP interfaces
   3 #
   4 # Aaron Klingaman <alk@absarokasoft.com>
   5 # Mark Huang <mlhuang@cs.princeton.edu>
   6 #
   7 # Copyright (C) 2004-2006 The Trustees of Princeton University
   8 #
   9
  10 import os
  11 import sys
  12 import traceback
  13 import string
  14 import time
  15 import xmlrpclib
  16 import simplejson
  17 try:
  18     # Try to use jsonlib before using simpljson. This is a hack to get around
  19     # the fact that the version of simplejson avaialble for f8 is slightly
  20     # faster than xmlrpc but not as fast as jsonlib. There is no jsonlib
  21     # pacakge available for f8, so this has to be installed manually and
  22     # is not expected to always be available. Remove this once we move away
  23     # from f8 based MyPLC's
  24     import jsonlib
  25     json = jsonlib
  26 except:
  27     json = simplejson
  28
  29 # See "2.2 Characters" in the XML specification:
  30 #
  31 # #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
  32 # avoiding
  33 # [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
  34
  35 invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F))
  36 xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii))
  37
  38 def xmlrpclib_escape(s, replace = string.replace):
  39     """
  40     xmlrpclib does not handle invalid 7-bit control characters. This
  41     function augments xmlrpclib.escape, which by default only replaces
  42     '&', '<', and '>' with entities.
  43     """
  44
  45     # This is the standard xmlrpclib.escape function
  46     s = replace(s, "&", "&amp;")
  47     s = replace(s, "<", "&lt;")
  48     s = replace(s, ">", "&gt;",)
  49
  50     # Replace invalid 7-bit control characters with '?'
  51     return s.translate(xml_escape_table)
  52
  53 def xmlrpclib_dump(self, value, write):
  54     """
  55     xmlrpclib cannot marshal instances of subclasses of built-in
  56     types. This function overrides xmlrpclib.Marshaller.__dump so that
  57     any value that is an instance of one of its acceptable types is
  58     marshalled as that type.
  59
  60     xmlrpclib also cannot handle invalid 7-bit control characters. See
  61     above.
  62     """
  63
  64     # Use our escape function
  65     args = [self, value, write]
  66     if isinstance(value, (str, unicode)):
  67         args.append(xmlrpclib_escape)
  68
  69     try:
  70         # Try for an exact match first
  71         f = self.dispatch[type(value)]
  72     except KeyError:
  73         # Try for an isinstance() match
  74         for Type, f in self.dispatch.iteritems():
  75             if isinstance(value, Type):
  76                 f(*args)
  77                 return
  78         raise TypeError, "cannot marshal %s objects" % type(value)
  79     else:
  80         f(*args)
  81
  82 # You can't hide from me!
  83 xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
  84
  85 # SOAP support is optional
  86 try:
  87     import SOAPpy
  88     from SOAPpy.Parser import parseSOAPRPC
  89     from SOAPpy.Types import faultType
  90     from SOAPpy.NS import NS
  91     from SOAPpy.SOAPBuilder import buildSOAP
  92 except ImportError:
  93     SOAPpy = None
  94
  95 from PLC.Config import Config
  96 from PLC.Logger import logger
  97 from PLC.Faults import *
  98 import PLC.Methods
  99 import PLC.Accessors
 100
 101 def import_deep(name):
 102     mod = __import__(name)
 103     components = name.split('.')
 104     for comp in components[1:]:
 105         mod = getattr(mod, comp)
 106     return mod
 107
 108 class PLCAPI:
 109
 110     # flat list of method names
 111     native_methods = PLC.Methods.native_methods
 112
 113     # other_methods_map : dict {methodname: fullpath}
 114     # e.g. 'Accessors' -> 'PLC.Accessors.Accessors'
 115     other_methods_map={}
 116     #for subdir in [ 'Accessors' ]:
 117     #    path="PLC."+subdir
 118     #    # scan e.g. PLC.Accessors.__all__
 119     #    pkg = __import__(path).__dict__[subdir]
 120     #    for modulename in getattr(pkg,"__all__"):
 121     #        fullpath=path+"."+modulename
 122     #        for method in getattr(import_deep(fullpath),"methods"):
 123     #            other_methods_map[method] = fullpath
 124
 125     all_methods = native_methods + other_methods_map.keys()
 126
 127     def __init__(self, config = "/etc/planetlab/plcapi_config", encoding = "utf-8"):
 128         self.encoding = encoding
 129
 130         # Better just be documenting the API
 131         if config is None:
 132             return
 133
 134         # Load configuration
 135         self.config = Config(config)
 136
 137         # Aspects modify the API by injecting code before, after or
 138         # around method calls. -- http://github.com/baris/pyaspects/blob/master/README
 139         #
 140         # As of now we only have aspects for OMF integration, that's
 141         # why we enable aspects only if PLC_OMF is set to true.
 142         if self.config.api_omf_enabled:
 143             from aspects import apply_omf_aspect
 144             apply_omf_aspect()
 145
 146         if self.config.api_ratelimit_enabled:
 147             from aspects import apply_ratelimit_aspect
 148             apply_ratelimit_aspect()
 149
 150     def callable(self, method):
 151         """
 152         Return a new instance of the specified method.
 153         """
 154
 155         # Look up method
 156         if method not in self.all_methods:
 157             raise PLCInvalidAPIMethod, method
 158
 159         # Get new instance of method
 160         try:
 161             classname = method.split(".")[-1]
 162             if method in self.native_methods:
 163                 fullpath="PLC.Methods." + method
 164             else:
 165                 fullpath=self.other_methods_map[method]
 166             module = __import__(fullpath, globals(), locals(), [classname])
 167             return getattr(module, classname)(self)
 168         except ImportError, AttributeError:
 169             raise PLCInvalidAPIMethod, "import error %s for %s" % (AttributeError,fullpath)
 170
 171     def call(self, source, method, *args):
 172         """
 173         Call the named method from the specified source with the
 174         specified arguments.
 175         """
 176
 177         function = self.callable(method)
 178         function.source = source
 179         return function(*args)
 180
 181     def handle(self, source, data):
 182         """
 183         Handle an XML-RPC or SOAP request from the specified source.
 184         """
 185
 186         # Parse request into method name and arguments
 187         start = time.time()
 188         try:
 189             interface = xmlrpclib
 190             (args, method) = xmlrpclib.loads(data)
 191             methodresponse = True
 192         except Exception, e:
 193             if SOAPpy is not None:
 194                 interface = SOAPpy
 195                 (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
 196                 method = r._name
 197                 args = r._aslist()
 198                 # XXX Support named arguments
 199             else:
 200                 raise e
 201
 202         try:
 203             result = self.call(source, method, *args)
 204             end = time.time()
 205             logger.info("%s %s %s" % (source, method, end-start))
 206         except PLCFault, fault:
 207             end = time.time()
 208             logger.log_exc("%s %s %s" % (source, method, end-start))
 209             # Handle expected faults
 210             if interface == xmlrpclib:
 211                 result = fault
 212                 methodresponse = None
 213             elif interface == SOAPpy:
 214                 result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
 215                 result._setDetail("Fault %d: %s" % (fault.faultCode, fault.faultString))
 216         except Exception, fault:
 217             end = time.time()
 218             logger.log_exc("%s %s %s" % (source, method, end-start))
 219             if interface == xmlrpclib:
 220                 result = PLCFault(500, str(fault))
 221                 methodresponse = None
 222             elif interface == SOAPpy:
 223                 result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
 224                 result._setDetail("Fault %d: %s" % (500, str(fault)))
 225
 226         # Return result
 227         if interface == xmlrpclib:
 228             if not isinstance(result, PLCFault):
 229                 result = (result,)
 230             data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1)
 231         elif interface == SOAPpy:
 232             data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)
 233
 234         return data
 235
 236     def handle_json(self, source, data):
 237         """
 238         Handle a JSON request
 239         """
 240         method, args = json.loads(data)
 241         try:
 242             result = self.call(source, method, *args)
 243         except Exception, e:
 244             result = str(e)
 245
 246         return json.dumps(result)
 247
 248