X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=PLC%2FMethod.py;h=81a17479c51892396a0937252690667e9a947279;hb=6e915d8a9ac5474c20482751ab6d24e6ce13aec9;hp=a7f070efbf37c85141dffbe16e45e3446a044aed;hpb=8be4547f4c0fee6209d65fcdd759b6ff07e83013;p=plcapi.git diff --git a/PLC/Method.py b/PLC/Method.py index a7f070e..81a1747 100644 --- a/PLC/Method.py +++ b/PLC/Method.py @@ -4,22 +4,17 @@ # Mark Huang # Copyright (C) 2006 The Trustees of Princeton University # -# $Id$ -# - -import xmlrpclib +import xmlrpc.client from types import * import textwrap import os import time import pprint -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.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 @@ -62,17 +57,22 @@ class Method (object): 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 @@ -80,78 +80,90 @@ class Method (object): """ try: - start = time.time() + start = time.time() # 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() - + # 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'): - self.log(None, runtime, *args) - - return result - - except PLCFault, fault: - - caller = "" - if isinstance(self.caller, Person): - caller = 'person_id %s' % self.caller['person_id'] + self.log(None, runtime, *args) + + return result + + except PLCFault as fault: + + 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 + runtime = time.time() - start + + if self.api.config.PLC_API_DEBUG: + self.log(fault, runtime, *args) + + raise fault 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'] = 0 - if fault: + 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() - 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 'AuthMethod' in arg: + 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 password in arg: + 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): @@ -162,17 +174,17 @@ class Method (object): event.sync(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]: + for key in list(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 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() @@ -226,7 +238,7 @@ class Method (object): # Indent struct fields and mixed types if isinstance(param, dict): - for name, subparam in param.iteritems(): + for name, subparam in param.items(): text += param_text(name, subparam, indent + step, step) elif isinstance(param, Mixed): for subparam in param: @@ -257,16 +269,16 @@ class Method (object): 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 + max_args = self.call.__code__.co_varnames[1:self.call.__code__.co_argcount] + defaults = self.call.__defaults__ if defaults is None: 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): @@ -275,7 +287,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. - + 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, @@ -291,7 +303,7 @@ class Method (object): try: self.type_check(name, value, item, args) return - except PLCInvalidArgument, fault: + except PLCInvalidArgument as fault: pass raise fault @@ -321,7 +333,7 @@ class Method (object): # Strings are a special case. Accept either unicode or str # types if a string is expected. - if expected_type in StringTypes and isinstance(value, StringTypes): + if expected_type is str and isinstance(value, str): pass # Integers and long integers are also special types. Accept @@ -336,23 +348,23 @@ class Method (object): name) # If a minimum or maximum (length, value) has been specified - if expected_type in StringTypes: + if expected_type is str: if min is not None and \ len(value.encode(self.api.encoding)) < min: - raise PLCInvalidArgument, "%s must be at least %d bytes long" % (name, min) + raise PLCInvalidArgument("%s must be at least %d bytes long" % (name, min)) if max is not None and \ len(value.encode(self.api.encoding)) > max: - raise PLCInvalidArgument, "%s must be at most %d bytes long" % (name, max) + raise PLCInvalidArgument("%s must be at most %d bytes long" % (name, max)) elif expected_type in (list, tuple, set): if min is not None and len(value) < min: - raise PLCInvalidArgument, "%s must contain at least %d items" % (name, min) + raise PLCInvalidArgument("%s must contain at least %d items" % (name, min)) if max is not None and len(value) > max: - raise PLCInvalidArgument, "%s must contain at most %d items" % (name, max) + raise PLCInvalidArgument("%s must contain at most %d items" % (name, max)) else: if min is not None and value < min: - raise PLCInvalidArgument, "%s must be > %s" % (name, str(min)) + raise PLCInvalidArgument("%s must be > %s" % (name, str(min))) if max is not None and value > max: - raise PLCInvalidArgument, "%s must be < %s" % (name, str(max)) + raise PLCInvalidArgument("%s must be < %s" % (name, str(max))) # If a list with particular types of items is expected if isinstance(expected, (list, tuple, set)): @@ -366,13 +378,13 @@ class Method (object): # If a struct with particular (or required) types of items is # expected. elif isinstance(expected, dict): - for key in value.keys(): + for key in list(value.keys()): if key in expected: self.type_check(name + "['%s']" % key, value[key], expected[key], args) - for key, subparam in expected.iteritems(): + for key, subparam in expected.items(): if isinstance(subparam, Parameter) and \ subparam.optional is not None and \ - not subparam.optional and key not in value.keys(): + not subparam.optional and key not in list(value.keys()): raise PLCInvalidArgument("'%s' not specified" % key, name) if auth is not None: