remove PLC.Debug.log, use PLC.Logger.logger instead

[plcapi.git] / PLC / Method.py

diff --git a/PLC/Method.py b/PLC/Method.py
index a422b96..571c3eb 100644 (file)
--- a/PLC/Method.py
+++ b/PLC/Method.py
@@ -4,10 +4,6 @@
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #
 # Mark Huang <mlhuang@cs.princeton.edu>
 # Copyright (C) 2006 The Trustees of Princeton University
 #

-# $Id$
-# $URL$
-#
-

 import xmlrpclib
 from types import *
 import textwrap
 import xmlrpclib
 from types import *
 import textwrap


@@ -20,7 +16,7 @@ from types import StringTypes
 from PLC.Faults import *
 from PLC.Parameter import Parameter, Mixed, python_type, xmlrpc_type
 from PLC.Auth import Auth
 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
 from PLC.Events import Event, Events
 from PLC.Nodes import Node, Nodes
 from PLC.Persons import Person, Persons


@@ -63,17 +59,22 @@ class Method (object):
 
         return True
 
 
         return True
 

-    def __init__(self, api):
+    def __init__(self, api,caller=None):

         self.name = self.__class__.__name__
         self.api = api
 
         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
 
         # 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
     def __call__(self, *args, **kwds):
         """
         Main entry point for all PLCAPI functions. Type checks


@@ -81,81 +82,90 @@ class Method (object):
         """
 
         try:
         """
 
         try:

-           start = time.time()
+            start = time.time()

 
             # legacy code cannot be type-checked, due to the way Method.args() works
 
             # legacy code cannot be type-checked, due to the way Method.args() works

-            if not hasattr(self,"skip_typecheck"):
+            # 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()
                 (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)
                 # 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
-       
+
+            result = self.call(*args, **kwds)
+            runtime = time.time() - start
+

             if self.api.config.PLC_API_DEBUG or hasattr(self, 'message'):
             if self.api.config.PLC_API_DEBUG or hasattr(self, 'message'):

-               self.log(None, runtime, *args)
-               
-           return result
+                self.log(None, runtime, *args)
+
+            return result

 
         except PLCFault, fault:
 
         except PLCFault, fault:

-       
-           caller = ""
-           if isinstance(self.caller, Person):
-               caller = 'person_id %s'  % self.caller['person_id']
+
+            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
             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
+            runtime = time.time() - start
+
+            if self.api.config.PLC_API_DEBUG:
+                self.log(fault, runtime, *args)
+
+            raise fault

 
     def log(self, fault, 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
         #if self.name.startswith('system') or self.name.startswith('Get'):
         #    return False

-        # Do not log ReportRunlevel 
+        # 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)
         if self.name.startswith('ReportRunlevel'):
             return False
 
         # Create a new event
         event = Event(self.api)

-       event['fault_code'] = 0
-       if fault:
+        event['fault_code'] = 0
+        if fault:

             event['fault_code'] = fault.faultCode
         event['runtime'] = runtime
 
         # Redact passwords and sessions
             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()
-                    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
 
         # 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):
 
         # Both users and nodes can call some methods
         if isinstance(self.caller, Person):


@@ -167,16 +177,16 @@ class Method (object):
 
         if hasattr(self, 'event_objects') and isinstance(self.event_objects, dict):
             for key in self.event_objects.keys():
 
         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)
                     event.add_object(key, object_id, commit = False)

-       
-
-       # Set the message for this event
-       if fault:
-           event['message'] = fault.faultString
-       elif 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()
 
         # Commit
         event.sync()
 


@@ -261,7 +271,7 @@ class Method (object):
         That represents the minimum and maximum sets of arguments that
         this function accepts and the defaults for the optional arguments.
         """
         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
         # 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


@@ -270,7 +280,7 @@ class Method (object):
 
         min_args = max_args[0:len(max_args) - len(defaults)]
         defaults = tuple([None for arg in min_args]) + defaults
 
         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):
         return (min_args, max_args, defaults)
 
     def type_check(self, name, value, expected, args):


@@ -279,7 +289,7 @@ class Method (object):
         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.
         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,
         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,