first version of refactored interactors

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@29542 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/Interactor/AqDynamicInteractor.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2007-2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from Products.ERP5Type.Interactor.Interactor import Interactor
+from Products.ERP5Type.Base import _aq_reset
+
+class AqDynamicInteractor(Interactor):
+  """
+    This interactor handles all the calls to _aq_dynamic
+    which must be trigerred whenever some parts of ERP5 
+    are modified and require to generate again accessors
+    and dynamic properties.
+  """
+  def install(self):
+    from Products.CMFCore.WorkflowTool import WorkflowTool
+    self.on(WorkflowTool.manage_changeWorkflows).doAfter(self.resetAqDynamic)
+    from Products.DCWorkflow.Transitions import Transitions
+    self.on(Transitions.addTransition).doAfter(self.resetAqDynamic)
+    self.on(Transitions.deleteTransitions).doAfter(self.resetAqDynamic)    
+    from Products.DCWorkflow.Transitions import TransitionDefinition
+    self.on(TransitionDefinition.setProperties).doAfter(self.resetAqDynamic)
+    from Products.DCWorkflow.Variables import Variables
+    self.on(Variables.setStateVar).doAfter(self.resetAqDynamic)
+
+  def resetAqDynamic(self, *args, **kw):
+    """
+      Reset _aq_dynamic
+    """
+    _aq_reset()
\ No newline at end of file

product/ERP5Form/Interactor/FieldValueCacheInteractor.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2007-2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from Products.ERP5Type.Interactor.Interactor import Interactor
+
+class FieldValueCacheInteractor(Interactor):
+
+  def install(self):
+    """
+      Installs interactions
+    """
+    from Products.Formulator.Field import ZMIField
+    from Products.ERP5Form.ProxyField import ProxyField
+    from Products.Formulator.Form import ZMIForm
+    self.on(ZMIField.manage_edit).doAfter(self.purgeFieldValueCache)
+    self.on(ZMIField.manage_edit_xmlrpc).doAfter(self.purgeFieldValueCache)
+    self.on(ZMIField.manage_tales).doAfter(self.purgeFieldValueCache)
+    self.on(ZMIField.manage_tales_xmlrpc).doAfter(self.purgeFieldValueCache)
+    self.on(ProxyField.manage_edit).doAfter(self.purgeFieldValueCache)
+    self.on(ProxyField.manage_edit_target).doAfter(self.purgeFieldValueCache)
+    self.on(ProxyField.manage_tales).doAfter(self.purgeFieldValueCache)
+    self.on(ZMIForm.manage_renameObject).doAfter(self.purgeFieldValueCache)
+
+  def uninstall(self):
+    """
+      Uninstall interactions
+    """
+
+  def purgeFieldValueCache(self, method_call_object):
+    """
+    """
+    from Products.ERP5Form import Form, ProxyField
+    Form.purgeFieldValueCache()
+    ProxyField.purgeFieldValueCache()

product/ERP5Type/Interactor/Interactor.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2007-2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from MethodObject import Method
+from Products.ERP5Type.Base import _aq_reset
+
+"""
+  Current implementation uses callable objects.
+  Using decorator would be more modern and consistent with
+  recent evolution of python. But we have 2.3 ERP5 users
+  so we should, at least, provide both implementations.
+
+  Code structure should be changed so that Interactors
+  because a new "type" of ERP5 class such Document
+  with a modular plugin structure.
+
+  TODO: multiple instances of interactors could
+  use different parameters. This way, interactions
+  can be defined on "instances" or can be
+  made generic.
+"""
+
+class InteractorMethodCall:
+  """
+  Method's wrapper used to keep arguments passed, in order to retrieve them
+  from before and after scripts if needed.
+  """
+
+  def __init__(self, method, instance, *args, **kw):
+    self.instance = instance
+    self.args = args
+    self.kw = kw
+    self.method = method
+
+  def __call__(self):
+    # We use self.__dict__['instance'] to prevent inserting the
+    # InteractorMethodCall instance in the acquisition chain
+    # which has some side effects
+    return self.method(self.__dict__['instance'], *self.args, **self.kw)
+
+class InteractorMethod(Method):
+  """
+  """
+
+  def __init__(self, method):
+    self.after_action_list = []
+    self.before_action_list = []
+    self.method = method
+    self.func_code = method.func_code
+    self.func_defaults = method.func_defaults
+    self.__name__ = method.__name__
+
+  def registerBeforeAction(self, action, args, kw):
+    self.before_action_list.append((action, args, kw))
+  
+  def registerAfterAction(self, action, args, kw):
+    self.after_action_list.append((action, args, kw))
+
+  def __call__(self, instance, *args, **kw):
+    method_call_object = InteractorMethodCall(self.method, instance, *args, **kw)
+    for action, args, kw in self.before_action_list:
+      action(method_call_object, *args, **kw)
+    result = method_call_object()
+    for action, args, kw in self.after_action_list:
+      action(method_call_object, *args, **kw)
+    return result
+
+class InteractorSource:
+  """
+  """
+
+  def __init__(self, method):
+    """
+      Register method
+    """
+    self.method = method
+
+  def doAfter(self, action, *args, **kw):
+    """
+    """
+    im_class = self.method.im_class
+    if not isinstance(self.method, InteractorMethod):
+      # Turn this into an InteractorMethod
+      interactor_method = InteractorMethod(self.method)
+      setattr(im_class, self.method.__name__, interactor_method)
+      self.method = interactor_method
+    # Register the action
+    self.method.registerAfterAction(action, args, kw)
+
+class Interactor:
+  """
+    Interactor base class. 
+  """
+
+  def install(self):
+    raise NotImplementedError
+  
+  def uninstall(self):
+    raise NotImplementedError
+  
+  # Interaction implementation
+  def on(self, method):
+    """
+      Parameters may hold predicates ?
+      no need - use InteractorMethodCall and decide on action
+    """
+    return InteractorSource(method)
\ No newline at end of file