# Mark Huang <mlhuang@cs.princeton.edu>
# Copyright (C) 2006 The Trustees of Princeton University
#
-# $Id: Method.py,v 1.23 2007/02/27 18:46:23 tmack Exp $
-#
-
import xmlrpclib
from types import *
import textwrap
from PLC.Faults import *
from PLC.Parameter import Parameter, Mixed, python_type, xmlrpc_type
from PLC.Auth import Auth
-from PLC.Debug import profile, log
+from PLC.Debug import profile
from PLC.Events import Event, Events
from PLC.Nodes import Node, Nodes
from PLC.Persons import Person, Persons
-class Method:
+# we inherit object because we use new-style classes for legacy methods
+class Method (object):
"""
Base class for all PLCAPI functions. At a minimum, all PLCAPI
functions must define:
return True
- def __init__(self, api):
+ def __init__(self, api,caller=None):
self.name = self.__class__.__name__
self.api = api
- # Auth may set this to a Person instance (if an anonymous
- # method, will remain None).
- self.caller = None
+ if caller:
+ # let a method call another one by propagating its caller
+ self.caller=caller
+ else:
+ # Auth may set this to a Person instance (if an anonymous
+ # method, will remain None).
+ self.caller = None
+
# API may set this to a (addr, port) tuple if known
self.source = None
-
+
def __call__(self, *args, **kwds):
"""
Main entry point for all PLCAPI functions. Type checks
"""
try:
- start = time.time()
- (min_args, max_args, defaults) = self.args()
-
- # Check that the right number of arguments were passed in
- if len(args) < len(min_args) or len(args) > len(max_args):
- raise PLCInvalidArgumentCount(len(args), len(min_args), len(max_args))
-
- for name, value, expected in zip(max_args, args, self.accepts):
- self.type_check(name, value, expected, args)
-
- result = self.call(*args, **kwds)
- runtime = time.time() - start
+ start = time.time()
+
+ # legacy code cannot be type-checked, due to the way Method.args() works
+ # as of 5.0-rc16 we don't use skip_type_check anymore
+ if not hasattr(self,"skip_type_check"):
+ (min_args, max_args, defaults) = self.args()
+
+ # Check that the right number of arguments were passed in
+ if len(args) < len(min_args) or len(args) > len(max_args):
+ raise PLCInvalidArgumentCount(len(args), len(min_args), len(max_args))
+
+ for name, value, expected in zip(max_args, args, self.accepts):
+ self.type_check(name, value, expected, args)
+
+ result = self.call(*args, **kwds)
+ runtime = time.time() - start
if self.api.config.PLC_API_DEBUG or hasattr(self, 'message'):
- self.log(0, runtime, *args)
-
- return result
+ self.log(None, runtime, *args)
+
+ return result
except PLCFault, fault:
- # Prepend method name to expected faults
- fault.faultString = self.name + ": " + fault.faultString
- runtime = time.time() - start
- self.log(fault.faultCode, runtime, *args)
+
+ caller = ""
+ if isinstance(self.caller, Person):
+ caller = 'person_id %s' % self.caller['person_id']
+ elif isinstance(self.caller, Node):
+ caller = 'node_id %s' % self.caller['node_id']
+
+ # Prepend caller and method name to expected faults
+ fault.faultString = caller + ": " + self.name + ": " + fault.faultString
+ runtime = time.time() - start
+
+ if self.api.config.PLC_API_DEBUG:
+ self.log(fault, runtime, *args)
+
raise fault
- def log(self, fault_code, runtime, *args):
+ def log(self, fault, runtime, *args):
+ """
+ Log the transaction
"""
- Log the transaction
- """
- # Do not log system or Get calls
+ # Do not log system or Get calls
#if self.name.startswith('system') or self.name.startswith('Get'):
# return False
+ # Do not log ReportRunlevel
+ if self.name.startswith('system'):
+ return False
+ if self.name.startswith('ReportRunlevel'):
+ return False
# Create a new event
event = Event(self.api)
- event['fault_code'] = fault_code
+ event['fault_code'] = 0
+ if fault:
+ event['fault_code'] = fault.faultCode
event['runtime'] = runtime
# Redact passwords and sessions
- if args and isinstance(args[0], dict):
- # what type of auth this is
- if args[0].has_key('AuthMethod'):
- auth_methods = ['session', 'password', 'capability', 'gpg', 'hmac','anonymous']
- auth_method = args[0]['AuthMethod']
- if auth_method in auth_methods:
- event['auth_method'] = auth_method
- for password in 'AuthString', 'session':
- if args[0].has_key(password):
- auth = args[0].copy()
- auth[password] = "Removed by API"
- args = (auth,) + args[1:]
+ newargs = args
+ if args:
+ newargs = []
+ for arg in args:
+ if not isinstance(arg, dict):
+ newargs.append(arg)
+ continue
+ # what type of auth this is
+ if arg.has_key('AuthMethod'):
+ auth_methods = ['session', 'password', 'capability', 'gpg', 'hmac','anonymous']
+ auth_method = arg['AuthMethod']
+ if auth_method in auth_methods:
+ event['auth_type'] = auth_method
+ for password in 'AuthString', 'session', 'password':
+ if arg.has_key(password):
+ arg = arg.copy()
+ arg[password] = "Removed by API"
+ newargs.append(arg)
# Log call representation
# XXX Truncate to avoid DoS
- event['call'] = self.name + pprint.saferepr(args)
- event['call_name'] = self.name
+ event['call'] = self.name + pprint.saferepr(newargs)
+ event['call_name'] = self.name
# Both users and nodes can call some methods
if isinstance(self.caller, Person):
if hasattr(self, 'event_objects') and isinstance(self.event_objects, dict):
for key in self.event_objects.keys():
- for object_id in self.event_objects[key]:
+ for object_id in self.event_objects[key]:
event.add_object(key, object_id, commit = False)
-
- # Set the message for this event
- if hasattr(self, 'message'):
- event['message'] = self.message
-
+
+ # Set the message for this event
+ if fault:
+ event['message'] = fault.faultString
+ elif hasattr(self, 'message'):
+ event['message'] = self.message
+
# Commit
event.sync()
min_args = max_args[0:len(max_args) - len(defaults)]
defaults = tuple([None for arg in min_args]) + defaults
-
+
return (min_args, max_args, defaults)
def type_check(self, name, value, expected, args):
which may be a Python type, a typed value, a Parameter, a
Mixed type, or a list or dictionary of possibly mixed types,
values, Parameters, or Mixed types.
-
+
Extraneous members of lists must be of the same type as the
last specified type. For example, if the expected argument
type is [int, bool], then [1, False] and [14, True, False,
git://git.onelab.eu / plcapi.git / blobdiff