# Mark Huang <mlhuang@cs.princeton.edu>
# Copyright (C) 2006 The Trustees of Princeton University
#
-# $Id: Method.py,v 1.20 2006/12/20 14:08:40 tmack Exp $
+# $Id$
#
import xmlrpclib
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:
try:
start = time.time()
- (min_args, max_args, defaults) = self.args()
+
+ # legacy code cannot be type-checked, due to the way Method.args() works
+ if not hasattr(self,"skip_typecheck"):
+ (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))
+ # 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)
+ 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)
+ self.log(None, runtime, *args)
return result
except PLCFault, fault:
- # Prepend method name to expected faults
- fault.faultString = self.name + ": " + fault.faultString
+
+ 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
- self.log(fault.faultCode, runtime, *args)
- raise fault
+
+ 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
"""
# Do not log system or Get calls
- if self.name.startswith('system') or self.name.startswith('Get'):
- return False
+ #if self.name.startswith('system') or self.name.startswith('Get'):
+ # 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_type'] = auth_method
for password in 'AuthString', 'session':
if args[0].has_key(password):
auth = args[0].copy()
event.sync(commit = False)
- if hasattr(self, 'object_ids'):
- for object_id in self.object_ids:
- event.add_object(object_id, commit = False)
+ 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]:
+ event.add_object(key, object_id, commit = False)
+
# Set the message for this event
- if hasattr(self, 'message'):
+ if fault:
+ event['message'] = fault.faultString
+ elif hasattr(self, 'message'):
event['message'] = self.message
# Commit
That represents the minimum and maximum sets of arguments that
this function accepts and the defaults for the optional arguments.
"""
-
+
# Inspect call. Remove self from the argument list.
max_args = self.call.func_code.co_varnames[1:self.call.func_code.co_argcount]
defaults = self.call.func_defaults