Right now all passwords that showed up via AddPerson/UpdatePerson are

[plcapi.git] / PLC / Method.py

diff --git a/PLC/Method.py b/PLC/Method.py
index 3f58f1f..ed03974 100644 (file)
--- a/PLC/Method.py
+++ b/PLC/Method.py
@@ -4,7 +4,8 @@
 # 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 $
+# $Id$
+# $URL$
 #
 
 import xmlrpclib
@@ -24,7 +25,8 @@ 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:
@@ -80,31 +82,44 @@ class Method:
 
         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 
         """    
@@ -112,29 +127,42 @@ class Method:
        # 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'] = self.name + pprint.saferepr(newargs)
        event['call_name'] = self.name
 
         # Both users and nodes can call some methods
@@ -152,7 +180,9 @@ class Method:
        
 
        # 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
@@ -239,7 +269,7 @@ class Method:
         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