From 4dccd2dda08827dc33740227f82d5fbb27cc3bd2 Mon Sep 17 00:00:00 2001
From: Kazuhiko Shiozaki <kazuhiko@nexedi.com>
Date: Wed, 25 Jan 2017 16:49:17 +0100
Subject: [PATCH 1/2] simulation: add 'frozen' state in causality workflow for
 documents that are no longer simulated.

* erp5_base: add 'frozen' state and 'freeze' transition in delivery_causality_workflow.
* ERP5/mixin/rule.py: do nothing in _updateSimulation() if causality_state is 'frozen'.
---
 .../states/building.xml                       |  1 +
 .../states/calculating.xml                    |  1 +
 .../states/diverged.xml                       |  1 +
 .../states/draft.xml                          |  1 +
 .../states/frozen.xml                         | 72 +++++++++++++++++
 .../states/solved.xml                         |  1 +
 .../states/solving.xml                        |  1 +
 .../transitions/freeze.xml                    | 79 +++++++++++++++++++
 product/ERP5/ERP5Defaults.py                  |  1 +
 product/ERP5/ERP5Site.py                      |  8 ++
 product/ERP5/mixin/rule.py                    |  2 +
 11 files changed, 168 insertions(+)
 create mode 100644 bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/frozen.xml
 create mode 100644 bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/transitions/freeze.xml

diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/building.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/building.xml
index 4181ab93443..53266c8a2d7 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/building.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/building.xml
@@ -30,6 +30,7 @@
               <tuple>
                 <string>converge</string>
                 <string>diverge</string>
+                <string>freeze</string>
                 <string>solve_automatically</string>
                 <string>start_building</string>
               </tuple>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/calculating.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/calculating.xml
index 26571da5ec0..a3ab6af5841 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/calculating.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/calculating.xml
@@ -30,6 +30,7 @@
               <tuple>
                 <string>converge</string>
                 <string>diverge</string>
+                <string>freeze</string>
                 <string>solve_automatically</string>
                 <string>solve_divergence</string>
                 <string>solve_divergence_action</string>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/diverged.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/diverged.xml
index 5f766037225..688c00d7080 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/diverged.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/diverged.xml
@@ -31,6 +31,7 @@
                 <string>calculate</string>
                 <string>converge</string>
                 <string>diverge</string>
+                <string>freeze</string>
                 <string>solve_automatically</string>
                 <string>solve_divergence</string>
                 <string>solve_divergence_action</string>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/draft.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/draft.xml
index 29db4dd2abc..c6444fc45ce 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/draft.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/draft.xml
@@ -28,6 +28,7 @@
             <key> <string>transitions</string> </key>
             <value>
               <tuple>
+                <string>freeze</string>
                 <string>start_building</string>
               </tuple>
             </value>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/frozen.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/frozen.xml
new file mode 100644
index 00000000000..b3d62f51690
--- /dev/null
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/frozen.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="StateDefinition" module="Products.DCWorkflow.States"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>description</string> </key>
+            <value> <string>The document is no longer simulated.</string> </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>frozen</string> </value>
+        </item>
+        <item>
+            <key> <string>permission_roles</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+        <item>
+            <key> <string>title</string> </key>
+            <value> <string>Frozen</string> </value>
+        </item>
+        <item>
+            <key> <string>transitions</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>type_list</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>Add portal content</string> </key>
+                    <value>
+                      <tuple/>
+                    </value>
+                </item>
+                <item>
+                    <key> <string>Modify portal content</string> </key>
+                    <value>
+                      <tuple>
+                        <string>Manager</string>
+                      </tuple>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solved.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solved.xml
index 79f1615fb9d..77e75e1876e 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solved.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solved.xml
@@ -31,6 +31,7 @@
                 <string>calculate</string>
                 <string>converge</string>
                 <string>diverge</string>
+                <string>freeze</string>
                 <string>solve_automatically</string>
                 <string>start_building</string>
               </tuple>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solving.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solving.xml
index fe57912c1a4..50e8eaf7b54 100644
--- a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solving.xml
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/states/solving.xml
@@ -30,6 +30,7 @@
               <tuple>
                 <string>converge</string>
                 <string>diverge</string>
+                <string>freeze</string>
               </tuple>
             </value>
         </item>
diff --git a/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/transitions/freeze.xml b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/transitions/freeze.xml
new file mode 100644
index 00000000000..f85abad44f9
--- /dev/null
+++ b/bt5/erp5_base/WorkflowTemplateItem/portal_workflow/delivery_causality_workflow/transitions/freeze.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="TransitionDefinition" module="Products.DCWorkflow.Transitions"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>actbox_category</string> </key>
+            <value> <string>workflow</string> </value>
+        </item>
+        <item>
+            <key> <string>actbox_icon</string> </key>
+            <value> <string></string> </value>
+        </item>
+        <item>
+            <key> <string>actbox_name</string> </key>
+            <value> <string></string> </value>
+        </item>
+        <item>
+            <key> <string>actbox_url</string> </key>
+            <value> <string></string> </value>
+        </item>
+        <item>
+            <key> <string>after_script_name</string> </key>
+            <value> <string></string> </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value> <string>Make the document no longer simulated.</string> </value>
+        </item>
+        <item>
+            <key> <string>guard</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>freeze</string> </value>
+        </item>
+        <item>
+            <key> <string>new_state_id</string> </key>
+            <value> <string>frozen</string> </value>
+        </item>
+        <item>
+            <key> <string>script_name</string> </key>
+            <value> <string></string> </value>
+        </item>
+        <item>
+            <key> <string>title</string> </key>
+            <value> <string>Freeze</string> </value>
+        </item>
+        <item>
+            <key> <string>trigger_type</string> </key>
+            <value> <int>2</int> </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="Guard" module="Products.DCWorkflow.Guard"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>permissions</string> </key>
+            <value>
+              <tuple>
+                <string>Modify portal content</string>
+              </tuple>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>
diff --git a/product/ERP5/ERP5Defaults.py b/product/ERP5/ERP5Defaults.py
index 05c351b7b8f..13a4b0157a4 100644
--- a/product/ERP5/ERP5Defaults.py
+++ b/product/ERP5/ERP5Defaults.py
@@ -224,3 +224,4 @@ portal_current_inventory_state_list = ('delivered', 'started', 'stopped', 'invoi
 
 portal_updatable_amortisation_transaction_state_list = ('draft',)
 
+portal_frozen_causality_state_list = ('frozen',)
diff --git a/product/ERP5/ERP5Site.py b/product/ERP5/ERP5Site.py
index bcaed78514d..af4c966e9a6 100644
--- a/product/ERP5/ERP5Site.py
+++ b/product/ERP5/ERP5Site.py
@@ -1287,6 +1287,14 @@ class ERP5Site(FolderMixIn, CMFSite, CacheCookieMixin):
     return self._getPortalConfiguration(
         'portal_updatable_amortisation_transaction_state_list')
 
+  security.declareProtected(Permissions.AccessContentsInformation,
+                            'getPortalFrozenCausalityStateList')
+  def getPortalFrozenCausalityStateList(self):
+    """
+      Return all causality states where the document is no longer simulated.
+    """
+    return self._getPortalConfiguration('portal_frozen_causality_state_list')
+
   security.declareProtected(Permissions.AccessContentsInformation,
                             'getPortalGroupedSimulationStateList')
   def getPortalGroupedSimulationStateList(self):
diff --git a/product/ERP5/mixin/rule.py b/product/ERP5/mixin/rule.py
index c63c9486519..a823ecca64f 100644
--- a/product/ERP5/mixin/rule.py
+++ b/product/ERP5/mixin/rule.py
@@ -495,6 +495,8 @@ class SimulableMixin(Base):
 
     See _updateSimulation for accepted parameters.
     """
+    if self.getCausalityState() == self.getPortalFrozenCausalityStateList():
+      return
     tv = getTransactionalVariable()
     key = 'SimulableMixin.updateSimulation', self.getUid()
     item_list = kw.items()
-- 
2.30.9


From 9873122a72fa057f83b2576a51173e27d43a0f29 Mon Sep 17 00:00:00 2001
From: Kazuhiko Shiozaki <kazuhiko@nexedi.com>
Date: Thu, 26 Jan 2017 10:00:20 +0100
Subject: [PATCH 2/2] fixup! simulation: add 'frozen' state in causality
 workflow for documents that are no longer simulated.

---
 product/ERP5/mixin/rule.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/product/ERP5/mixin/rule.py b/product/ERP5/mixin/rule.py
index a823ecca64f..e5b814e0af8 100644
--- a/product/ERP5/mixin/rule.py
+++ b/product/ERP5/mixin/rule.py
@@ -495,7 +495,7 @@ class SimulableMixin(Base):
 
     See _updateSimulation for accepted parameters.
     """
-    if self.getCausalityState() == self.getPortalFrozenCausalityStateList():
+    if self.getCausalityState() in self.getPortalFrozenCausalityStateList():
       return
     tv = getTransactionalVariable()
     key = 'SimulableMixin.updateSimulation', self.getUid()
-- 
2.30.9