1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL 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.
#
##############################################################################
import zope.interface
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
from Products.ERP5Type.XMLObject import XMLObject
from Products.ERP5Type.PsycoWrapper import psyco
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod
from zLOG import LOG
TREE_DELIVERED_CACHE_KEY = 'AppliedRule._isTreeDelivered_cache'
TREE_DELIVERED_CACHE_ENABLED = 'TREE_DELIVERED_CACHE_ENABLED'
class AppliedRule(XMLObject):
"""
An applied rule holds a list of simulation movements.
An applied rule points to an instance of Rule (which defines the actual
rule to apply with its parameters) through the specialise relation.
An applied rule can expand itself (look at its direct parent and take
conclusions on what should be inside).
An applied rule can tell if it is stable (if its children are consistent
with what would be expanded from its direct parent).
An applied rule can tell if any of his direct children is divergent (not
consistent with the delivery).
All algorithms are implemented by the rule.
"""
# CMF Type Definition
meta_type = 'ERP5 Applied Rule'
portal_type = 'Applied Rule'
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Default Properties
property_sheets = ( PropertySheet.Base
, PropertySheet.XMLObject
, PropertySheet.SimpleItem
, PropertySheet.CategoryCore
, PropertySheet.AppliedRule
)
# Declarative interfaces
zope.interface.implements(interfaces.IMovementCollection,)
def tpValues(self) :
""" show the content in the left pane of the ZMI """
return self.objectValues()
security.declareProtected(Permissions.AccessContentsInformation,
'isAccountable')
def isAccountable(self, movement):
"""Tells whether generated movement needs to be accounted or not."""
return self.getSpecialiseValue().isAccountable(movement)
security.declareProtected(Permissions.ModifyPortalContent, 'expand')
@UnrestrictedMethod
def expand(self, **kw):
"""
Expands the current movement downward.
-> new status -> expanded
An applied rule can be expanded only if its parent movement
is expanded.
"""
tv = getTransactionalVariable(self)
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
# enable cache
if not cache_enabled:
cache[TREE_DELIVERED_CACHE_ENABLED] = 1
rule = self.getSpecialiseValue()
if rule is not None:
rule.expand(self,**kw)
# disable and clear cache
if not cache_enabled:
try:
del tv[TREE_DELIVERED_CACHE_KEY]
except KeyError:
pass
security.declareProtected(Permissions.ModifyPortalContent, 'solve')
def solve(self, solution_list):
"""
Solve inconsistency according to a certain number of solutions
templates. This updates the
-> new status -> solved
This applies a solution to an applied rule. Once
the solution is applied, the parent movement is checked.
If it does not diverge, the rule is reexpanded. If not,
diverge is called on the parent movement.
"""
rule = self.getSpecialiseValue()
if rule is not None:
rule.solve(self)
security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
def diverge(self):
"""
-> new status -> diverged
This basically sets the rule to "diverged"
and blocks expansion process
"""
rule = self.getSpecialiseValue()
if rule is not None:
rule.diverge(self)
# Solvers
security.declareProtected(Permissions.AccessContentsInformation,
'isStable')
def isStable(self):
"""
Tells whether the rule is stable or not.
"""
return self.getSpecialiseValue().isStable(self)
security.declareProtected(Permissions.AccessContentsInformation,
'isDivergent')
def isDivergent(self, sim_mvt):
"""
Tells whether generated sim_mvt is divergent or not.
"""
return self.getSpecialiseValue().isDivergent(sim_mvt)
security.declareProtected(Permissions.AccessContentsInformation,
'getDivergenceList')
def getDivergenceList(self, sim_mvt):
"""
Returns a list Divergence descriptors
"""
return self.getSpecialiseValue().getDivergenceList(sim_mvt)
security.declareProtected(Permissions.AccessContentsInformation,
'getSolverList')
def getSolverList(self, movement):
"""
Returns a list Divergence solvers
"""
return self.getSpecialiseValue().getSolverList(movement)
security.declareProtected(Permissions.AccessContentsInformation,
'isRootAppliedRule')
def isRootAppliedRule(self):
"""
Returns 1 is this is a root applied rule
"""
return self.getParentValue().getMetaType() == "ERP5 Simulation Tool"
security.declareProtected(Permissions.AccessContentsInformation,
'getRootAppliedRule')
def getRootAppliedRule(self):
"""Return the root applied rule.
useful if some reindexing is needed from inside
"""
if self.getParentValue().getMetaType() == "ERP5 Simulation Tool":
return self
return self.getParentValue().getRootAppliedRule()
def _getExplanationSpecialiseValue(self, portal_type_list):
"""Returns first found specialise value of delivery or order
In case if self is root Applied Rule uses causality
Otherwise uses delivery, than order of parent movements
Recurses to parents"""
def findSpecialiseValueBySimulation(movement):
specialise_value = None
if movement.getPortalType() != 'Simulation Movement':
return None
delivery, order = movement.getDeliveryValue(), movement.getOrderValue()
if delivery is not None:
specialise_value = delivery.getExplanationValue() \
.getRootSpecialiseValue(portal_type_list)
if specialise_value is not None:
return specialise_value
if order is not None:
specialise_value = order.getExplanationValue() \
.getRootSpecialiseValue(portal_type_list)
if specialise_value is not None:
return specialise_value
return findSpecialiseValueBySimulation(movement.getParentValue() \
.getParentValue())
if self.getRootAppliedRule() == self:
return self.getCausalityValue() \
.getRootSpecialiseValue(portal_type_list)
movement = self.getParentValue()
return findSpecialiseValueBySimulation(movement)
security.declareProtected(Permissions.AccessContentsInformation,
'getTradeConditionValue')
def getTradeConditionValue(self):
"""Return the trade condition that has been used in this
simulation, or None if none has been used.
"""
return self._getExplanationSpecialiseValue(
('Purchase Trade Condition', 'Sale Trade Condition'))
security.declareProtected(Permissions.AccessContentsInformation,
'getBusinessProcessValue')
def getBusinessProcessValue(self):
"""Return the business process model that has been used in this
simulation, or None if none has been used.
"""
return self._getExplanationSpecialiseValue(
('Business Process',))
def _isTreeDelivered(self):
"""
Checks if submovements of this applied rule (going down the complete
simulation tree) have a delivery relation.
Returns True if at least one is delivered, False if none of them are.
see SimulationMovement._isTreeDelivered
"""
tv = getTransactionalVariable(self)
cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)
def getTreeDelivered(applied_rule):
for movement in applied_rule.objectValues():
if movement._isTreeDelivered():
return True
return False
rule_key = self.getRelativeUrl()
if cache_enabled:
try:
return cache[rule_key]
except:
result = getTreeDelivered(self)
cache[rule_key] = result
return result
else:
return getTreeDelivered(self)