workflow: support old data using legacy WorkflowHistoryList on Python 3 where...

workflow: support old data using legacy WorkflowHistoryList on Python 3 where WITH_LEGACY_WORKFLOW is False.

product/ERP5Type/ZopePatch.py

@@ -37,8 +37,7 @@ if WITH_LEGACY_WORKFLOW:
   from Products.ERP5Type.patches import DCWorkflow
   from Products.ERP5Type.patches import Worklists
 from Products.ERP5Type.patches import BTreeFolder2
-if WITH_LEGACY_WORKFLOW:
-  from Products.ERP5Type.patches import WorkflowTool
+from Products.ERP5Type.patches import WorkflowTool
 from Products.ERP5Type.patches import DynamicType
 from Products.ERP5Type.patches import Expression
 from Products.ERP5Type.patches import sqltest

product/ERP5Type/patches/WorkflowTool.py

@@ -13,41 +13,7 @@
 #
 ##############################################################################
 
-from Products.ERP5Type import WITH_LEGACY_WORKFLOW
-assert WITH_LEGACY_WORKFLOW
-
-from zLOG import LOG, WARNING
-from types import StringTypes
-
-# Make sure Interaction Workflows are called even if method not wrapped
-
-from AccessControl import ClassSecurityInfo, Unauthorized
-from Products.ERP5Type.Globals import InitializeClass
-from Products.CMFCore.WorkflowTool import WorkflowTool
-from Products.CMFCore.WorkflowCore import ObjectDeleted
-from Products.CMFCore.WorkflowCore import WorkflowException
-from Products.DCWorkflow.DCWorkflow import DCWorkflowDefinition
-from Products.DCWorkflow.Transitions import TRIGGER_WORKFLOW_METHOD
-from Products.DCWorkflow.utils import Message as _
-from Products.DCWorkflow.Transitions import TRIGGER_USER_ACTION
-
-from Products.CMFCore.utils import getToolByName
-from Products.ZSQLCatalog.SQLCatalog import SimpleQuery, AutoQuery, ComplexQuery, NegatedQuery
-from Products.CMFCore.utils import _getAuthenticatedUser
-from Products.ERP5Type import Permissions
-from Products.ERP5Type.Cache import CachingMethod
 from Products.ERP5Type.Workflow import WorkflowHistoryList as NewWorkflowHistoryList
-from sets import ImmutableSet
-from Acquisition import aq_base
-from Products.ERP5Type.Globals import PersistentMapping
-from MySQLdb import ProgrammingError, OperationalError
-from DateTime import DateTime
-
-security = ClassSecurityInfo()
-WorkflowTool.security = security
-
-WORKLIST_METADATA_KEY = 'metadata'
-SECURITY_PARAMETER_ID = 'local_roles'
 
 class WorkflowHistoryList(NewWorkflowHistoryList):
 
@@ -105,21 +71,56 @@ class WorkflowHistoryList(NewWorkflowHistoryList):
 # BBB: A production instance used a temporary patch to speed up.
 WorkflowHistoryBucketList = WorkflowHistoryList
 
-def WorkflowTool_getChainDict(self):
+from Products.ERP5Type import WITH_LEGACY_WORKFLOW
+if WITH_LEGACY_WORKFLOW:
+  import six
+  from zLOG import LOG, WARNING
+  from types import StringTypes
+
+  # Make sure Interaction Workflows are called even if method not wrapped
+
+  from AccessControl import ClassSecurityInfo, Unauthorized
+  from Products.ERP5Type.Globals import InitializeClass
+  from Products.CMFCore.WorkflowTool import WorkflowTool
+  from Products.CMFCore.WorkflowCore import ObjectDeleted
+  from Products.CMFCore.WorkflowCore import WorkflowException
+  from Products.DCWorkflow.DCWorkflow import DCWorkflowDefinition
+  from Products.DCWorkflow.Transitions import TRIGGER_WORKFLOW_METHOD
+  from Products.DCWorkflow.utils import Message as _
+  from Products.DCWorkflow.Transitions import TRIGGER_USER_ACTION
+
+  from Products.CMFCore.utils import getToolByName
+  from Products.ZSQLCatalog.SQLCatalog import SimpleQuery, AutoQuery, ComplexQuery, NegatedQuery
+  from Products.CMFCore.utils import _getAuthenticatedUser
+  from Products.ERP5Type import Permissions
+  from Products.ERP5Type.Cache import CachingMethod
+  from sets import ImmutableSet
+  from Acquisition import aq_base
+  from Products.ERP5Type.Globals import PersistentMapping
+  from MySQLdb import ProgrammingError, OperationalError
+  from DateTime import DateTime
+
+  security = ClassSecurityInfo()
+  WorkflowTool.security = security
+
+  WORKLIST_METADATA_KEY = 'metadata'
+  SECURITY_PARAMETER_ID = 'local_roles'
+
+  def WorkflowTool_getChainDict(self):
       """Test if the given transition exist from the current state.
       """
       chain_dict = {}
-    for portal_type, wf_id_list in self._chains_by_type.iteritems():
+      for portal_type, wf_id_list in six.iteritems(self._chains_by_type):
           for wf_id in wf_id_list:
               chain_dict.setdefault(wf_id, []).append(portal_type)
       return chain_dict
 
-security.declareProtected(Permissions.ManagePortal, 'getChainDict')
-WorkflowTool.getChainDict = WorkflowTool_getChainDict
+  security.declareProtected(Permissions.ManagePortal, 'getChainDict')
+  WorkflowTool.getChainDict = WorkflowTool_getChainDict
 
-# Backward compatibility, as WorkflowMethod has been removed in CMFCore 2.2
-from MethodObject import Method
-class WorkflowMethod( Method ):
+  # Backward compatibility, as WorkflowMethod has been removed in CMFCore 2.2
+  from MethodObject import Method
+  class WorkflowMethod( Method ):
 
       """ Wrap a method to workflow-enable it.
       """
@@ -150,14 +151,14 @@ class WorkflowMethod( Method ):
               res = wf.wrapWorkflowMethod(instance, self._id, self._m,
                                           (instance,) + args, kw)
 
-from Products.CMFCore import WorkflowCore
-# BBB: WorkflowMethod has been removed from CMFCore 2
-WorkflowCore.WorkflowAction = WorkflowMethod
+  from Products.CMFCore import WorkflowCore
+  # BBB: WorkflowMethod has been removed from CMFCore 2
+  WorkflowCore.WorkflowAction = WorkflowMethod
 
-# XXX: Kept here instead of ERP5Type.Tool.WorkflowTool because not used in
-# erp5.git: is it used in projects?
-security.declarePublic('canDoActionFor')
-def canDoActionFor(self, ob, action, wf_id=None, guard_kw={}):
+  # XXX: Kept here instead of ERP5Type.Tool.WorkflowTool because not used in
+  # erp5.git: is it used in projects?
+  security.declarePublic('canDoActionFor')
+  def canDoActionFor(self, ob, action, wf_id=None, guard_kw={}):
     """ Check we can perform the given workflow action on 'ob'.
     """
     if wf_id is None:
@@ -180,10 +181,10 @@ def canDoActionFor(self, ob, action, wf_id=None, guard_kw={}):
 
     raise WorkflowException(_(u"No workflow provides the '${action_id}' action.",
             mapping={'action_id': action}))
-WorkflowTool.canDoActionFor = canDoActionFor
+  WorkflowTool.canDoActionFor = canDoActionFor
 
-security.declarePrivate('_listTypeInfo')
-def _listTypeInfo(self):
+  security.declarePrivate('_listTypeInfo')
+  def _listTypeInfo(self):
       """ List the portal types which are available.
       """
       # <patch>
@@ -193,17 +194,17 @@ def _listTypeInfo(self):
           return ttool.listTypeInfo()
       return ()
 
-WorkflowTool._listTypeInfo = _listTypeInfo
+  WorkflowTool._listTypeInfo = _listTypeInfo
 
-## From here on: migration/compatibility code DCWorkflow => ERP5 Workflow
+  ## From here on: migration/compatibility code DCWorkflow => ERP5 Workflow
 
-# The following 2 functions are necessary for workflow tool dynamic migration
-def WorkflowTool_isBootstrapRequired(self):
+  # The following 2 functions are necessary for workflow tool dynamic migration
+  def WorkflowTool_isBootstrapRequired(self):
     # migration is required if the tool is not the new one from ERP5 Workflow
     # in case of old workflow tool, it acquires the portal type from ERP5 Site
     return self.getPortalType() != "Workflow Tool"
 
-def WorkflowTool_bootstrap(self):
+  def WorkflowTool_bootstrap(self):
     """
     Migrate portal_workflow from CMFCore to ERP5 Workflow. Also migrate
     Workflow Chains not defined anymore on portal_workflow but on the Portal
@@ -244,20 +245,20 @@ def WorkflowTool_bootstrap(self):
       if getattr(new_tool, '_chains_by_type', None) is not None:
         new_tool.reassignWorkflowWithoutConversion()
 
-WorkflowTool._isBootstrapRequired = WorkflowTool_isBootstrapRequired
-WorkflowTool._bootstrap = WorkflowTool_bootstrap
-WorkflowTool.getWorkflowValueListFor = WorkflowTool.getWorkflowsFor
+  WorkflowTool._isBootstrapRequired = WorkflowTool_isBootstrapRequired
+  WorkflowTool._bootstrap = WorkflowTool_bootstrap
+  WorkflowTool.getWorkflowValueListFor = WorkflowTool.getWorkflowsFor
 
-def _deleteChainsByType(self, pt, wf_id):
+  def _deleteChainsByType(self, pt, wf_id):
     self._chains_by_type[pt] = tuple(wf for wf in self._chains_by_type[pt] if wf!=wf_id)
-def getChainsByType(self):
+  def getChainsByType(self):
     # XXX(WORKFLOW): compatibility code
     # get old workflow tool's chains_by_type
     if self._chains_by_type is None:
       return {}
     return self._chains_by_type.copy()
-WorkflowTool.getChainsByType = getChainsByType
-def reassignWorkflow(self, workflow_id):
+  WorkflowTool.getChainsByType = getChainsByType
+  def reassignWorkflow(self, workflow_id):
     # type-workflow reassignment
     type_workflow_dict = self.getChainsByType()
     type_tool = self.getPortalObject().portal_types
@@ -274,8 +275,8 @@ def reassignWorkflow(self, workflow_id):
           portal_type.setTypeWorkflowList(
             type_workflow_list + [workflow_id]
           )
-WorkflowTool.reassignWorkflow = reassignWorkflow
-def reassignWorkflowWithoutConversion(self):
+  WorkflowTool.reassignWorkflow = reassignWorkflow
+  def reassignWorkflowWithoutConversion(self):
     # This function should be called when a new template installed and add
     # portal_types assignment with converted and non-converted workflows into
     # portal_type's workflow list.
@@ -305,10 +306,10 @@ def reassignWorkflowWithoutConversion(self):
               portal_type.setTypeWorkflowList(
                 type_workflow_list + [workflow_id]
               )
-WorkflowTool.reassignWorkflowWithoutConversion = reassignWorkflowWithoutConversion
-WorkflowTool.security.declareProtected(Permissions.AccessContentsInformation,
+  WorkflowTool.reassignWorkflowWithoutConversion = reassignWorkflowWithoutConversion
+  WorkflowTool.security.declareProtected(Permissions.AccessContentsInformation,
                                         'getWorkflowTempObjectList')
-def getWorkflowTempObjectList(self, temp_object=1, **kw):
+  def getWorkflowTempObjectList(self, temp_object=1, **kw):
     """ Return a list of converted temporary workflows. Only necessary in
         Workflow Tool to get temporarilly converted DCWorkflow.
     """
@@ -320,6 +321,6 @@ def getWorkflowTempObjectList(self, temp_object=1, **kw):
       temp_workflow = dc_workflow.convertToERP5Workflow(temp_object=temp_object)
       temp_workflow_list.append(temp_workflow)
     return temp_workflow_list
-WorkflowTool.getWorkflowTempObjectList = getWorkflowTempObjectList
+  WorkflowTool.getWorkflowTempObjectList = getWorkflowTempObjectList
 
-InitializeClass(WorkflowTool)
+  InitializeClass(WorkflowTool)