# Mark Huang <mlhuang@cs.princeton.edu>
# Copyright (C) 2006 The Trustees of Princeton University
#
-# $Id: Method.py,v 1.12 2006/10/25 14:26:08 mlhuang Exp $
+# $Id: Method.py,v 1.21 2007/01/16 17:04:08 mlhuang Exp $
#
import xmlrpclib
import textwrap
import os
import time
+import pprint
+
+from types import StringTypes
from PLC.Faults import *
-from PLC.Parameter import Parameter, Mixed
+from PLC.Parameter import Parameter, Mixed, python_type, xmlrpc_type
from PLC.Auth import Auth
from PLC.Debug import profile, log
+from PLC.Events import Event, Events
+from PLC.Nodes import Node, Nodes
+from PLC.Persons import Person, Persons
class Method:
"""
# API may set this to a (addr, port) tuple if known
self.source = None
-
def __call__(self, *args, **kwds):
"""
result = self.call(*args, **kwds)
runtime = time.time() - start
- if self.api.config.PLC_API_DEBUG:
+ if self.api.config.PLC_API_DEBUG or hasattr(self, 'message'):
self.log(0, runtime, *args)
return result
self.log(fault.faultCode, runtime, *args)
raise fault
-
def log(self, fault_code, runtime, *args):
"""
Log the transaction
"""
- # Gather necessary logging variables
- event_type = 'Unknown'
- object_type = 'Unknown'
- person_id = None
- object_ids = []
- call_name = self.name
- call_args = ", ".join([unicode(arg) for arg in list(args)[1:]])
- call = "%s(%s)" % (call_name, call_args)
-
- if hasattr(self, 'event_type'):
- event_type = self.event_type
- if hasattr(self, 'object_type'):
- object_type = self.object_type
- if self.caller:
- person_id = self.caller['person_id']
- if hasattr(self, 'object_ids'):
- object_ids = self.object_ids
-
- # do not log system calls
- if call_name.startswith('system'):
- return False
- # do not log get calls
- if call_name.startswith('Get'):
- return False
-
- sql_event = "INSERT INTO events " \
- " (person_id, event_type, object_type, fault_code, call, runtime) VALUES" \
- " (%(person_id)s, %(event_type)s, %(object_type)s," \
- " %(fault_code)d, %(call)s, %(runtime)f)"
- self.api.db.do(sql_event, locals())
-
- # log objects affected
- event_id = self.api.db.last_insert_id('events', 'event_id')
- for object_id in object_ids:
- sql_objects = "INSERT INTO event_object (event_id, object_id) VALUES" \
- " (%(event_id)d, %(object_id)d) "
- self.api.db.do(sql_objects, locals())
-
- self.api.db.commit()
+
+ # Do not log system or Get calls
+ 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['runtime'] = runtime
+
+ # Redact passwords and sessions
+ if args and isinstance(args[0], dict):
+ for password in 'AuthString', 'session':
+ if args[0].has_key(password):
+ auth = args[0].copy()
+ auth[password] = "Removed by API"
+ args = (auth,) + args[1:]
+
+ # Log call representation
+ # XXX Truncate to avoid DoS
+ event['call'] = self.name + pprint.saferepr(args)
+ event['call_name'] = self.name
+
+ # Both users and nodes can call some methods
+ if isinstance(self.caller, Person):
+ event['person_id'] = self.caller['person_id']
+ elif isinstance(self.caller, Node):
+ event['node_id'] = self.caller['node_id']
+
+ event.sync(commit = False)
+
+ if hasattr(self, 'object_ids'):
+ for object_id in self.object_ids:
+ event.add_object(object_id, commit = False)
+
+ # Set the message for this event
+ if hasattr(self, 'message'):
+ event['message'] = self.message
+ if hasattr(self, 'object_type'):
+ event['object_type'] = self.object_type
+
+ # Commit
+ event.sync()
def help(self, indent = " "):
"""
elif isinstance(param, Mixed):
for subparam in param:
text += param_text(name, subparam, indent + step, step)
- elif isinstance(param, (list, tuple)):
+ elif isinstance(param, (list, tuple, set)):
for subparam in param:
text += param_text("", subparam, indent + step, step)
return
except PLCInvalidArgument, fault:
pass
- xmlrpc_types = [xmlrpc_type(item) for item in expected]
- raise PLCInvalidArgument("expected %s, got %s" % \
- (" or ".join(xmlrpc_types),
- xmlrpc_type(type(value))),
- name)
+ raise fault
# If an authentication structure is expected, save it and
# authenticate after basic type checking is done.
if isinstance(expected, Parameter):
min = expected.min
max = expected.max
+ nullok = expected.nullok
expected = expected.type
else:
min = None
max = None
+ nullok = False
expected_type = python_type(expected)
+ # If value can be NULL
+ if value is None and nullok:
+ return
+
# 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 max is not None and \
len(value.encode(self.api.encoding)) > 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)
+ if max is not None and len(value) > 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(max))
# If a list with particular types of items is expected
- if isinstance(expected, (list, tuple)):
+ if isinstance(expected, (list, tuple, set)):
for i in range(len(value)):
if i >= len(expected):
j = len(expected) - 1
if auth is not None:
auth.check(self, *args)
-
-def python_type(arg):
- """
- Returns the Python type of the specified argument, which may be a
- Python type, a typed value, or a Parameter.
- """
-
- if isinstance(arg, Parameter):
- arg = arg.type
-
- if isinstance(arg, type):
- return arg
- else:
- return type(arg)
-
-def xmlrpc_type(arg):
- """
- Returns the XML-RPC type of the specified argument, which may be a
- Python type, a typed value, or a Parameter.
- """
-
- arg_type = python_type(arg)
-
- if arg_type == NoneType:
- return "nil"
- elif arg_type == IntType or arg_type == LongType:
- return "int"
- elif arg_type == bool:
- return "boolean"
- elif arg_type == FloatType:
- return "double"
- elif arg_type in StringTypes:
- return "string"
- elif arg_type == ListType or arg_type == TupleType:
- return "array"
- elif arg_type == DictType:
- return "struct"
- elif arg_type == Mixed:
- # Not really an XML-RPC type but return "mixed" for
- # documentation purposes.
- return "mixed"
- else:
- raise PLCAPIError, "XML-RPC cannot marshal %s objects" % arg_type