SimulationMovement.py 29.8 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import zope.interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from AccessControl import ClassSecurityInfo

33
from Products.ERP5Type import Permissions, PropertySheet, interfaces
34
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
35
from Products.ERP5.Document.Movement import Movement
36
from Products.ERP5.ExpandPolicy import policy_dict, TREE_DELIVERED_CACHE_KEY
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37

38
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39

40
from Products.ERP5.mixin.property_recordable import PropertyRecordableMixin
41
from Products.ERP5.mixin.explainable import ExplainableMixin
42

Jean-Paul Smets's avatar
Jean-Paul Smets committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
# XXX Do we need to create groups ? (ie. confirm group include confirmed, getting_ready and ready

parent_to_movement_simulation_state = {
  'cancelled'        : 'cancelled',
  'draft'            : 'draft',
  'auto_planned'     : 'auto_planned',
  'planned'          : 'planned',
  'ordered'          : 'planned',
  'confirmed'        : 'planned',
  'getting_ready'    : 'planned',
  'ready'            : 'planned',
  'started'          : 'planned',
  'stopped'          : 'planned',
  'delivered'        : 'planned',
  'invoiced'         : 'planned',
}

60
class SimulationMovement(PropertyRecordableMixin, Movement, ExplainableMixin):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
  """
      Simulation movements belong to a simulation workflow which includes
      the following steps

      - planned

      - ordered

      - confirmed (the movement is now confirmed in qty or date)

      - started (the movement has started)

      - stopped (the movement is now finished)

      - delivered (the movement is now archived in a delivery)

      The simulation worklow uses some variables, which are
      set by the template

      - is_order_required

      - is_delivery_required


      XX
      - is_problem_checking_required ?

      Other flag
      (forzen flag)

      NEW: we do not use DCWorklow so that the simulation process
      can be as much as possible independent of a Zope / CMF implementation.
  """
  meta_type = 'ERP5 Simulation Movement'
  portal_type = 'Simulation Movement'

  # Declarative security
  security = ClassSecurityInfo()
99
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100 101 102 103 104 105 106 107 108 109

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.SimpleItem
                    , PropertySheet.CategoryCore
                    , PropertySheet.Amount
                    , PropertySheet.Task
                    , PropertySheet.Arrow
                    , PropertySheet.Movement
                    , PropertySheet.Simulation
110 111 112
                    # Need industrial_phase
                    , PropertySheet.TransformedResource
                    , PropertySheet.AppliedRule
113
                    , PropertySheet.ItemAggregation
114
                    , PropertySheet.Reference
Jean-Paul Smets's avatar
Jean-Paul Smets committed
115
                    )
116

117
  # Declarative interfaces
118 119
  zope.interface.implements(interfaces.IExpandable,
                            interfaces.IPropertyRecordable)
120

121 122 123
  def tpValues(self) :
    """ show the content in the left pane of the ZMI """
    return self.objectValues()
124

125 126
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getPrice')
127
  def getPrice(self, default=None, context=None, REQUEST=None, **kw):
128
    """Get the price set locally, without lookup.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
129
    """
130
    return self._baseGetPrice(default) # Call the price method
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131

132 133 134 135 136 137
  security.declareProtected(Permissions.AccessContentsInformation, 'getBaseUnitPrice')
  def getBaseUnitPrice(self, context=None, **kw):
    """Get the base unit price set locally, without lookup.
    """
    return self._baseGetBaseUnitPrice()

138 139
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationState')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
140
  def getSimulationState(self, id_only=1):
141
    """Returns the current state in simulation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
142

143 144 145 146 147
      Inherit from delivery or parent (using a conversion table to make orders
      planned when parent is confirmed).
      
      In the case of simulation coming from an item, the simulation state is
      delegated to the item.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
148 149 150 151 152 153

      XXX: movements in zero stock rule can not acquire simulation state
    """
    delivery = self.getDeliveryValue()
    if delivery is not None:
      return delivery.getSimulationState()
154
    # 'order' category is deprecated. it is kept for compatibility.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
155 156 157
    order = self.getOrderValue()
    if order is not None:
      return order.getSimulationState()
158

159 160
    applied_rule = self.getParentValue()
    parent = applied_rule.getParentValue()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
161
    try:
162 163 164 165 166
      if isinstance(parent, SimulationMovement):
        return parent_to_movement_simulation_state[parent.getSimulationState()]
      getState = applied_rule.getCausalityValue() \
        .aq_explicit.getSimulationMovementSimulationState
    except (AttributeError, KeyError):
167 168
      LOG('SimulationMovement.getSimulationState', WARNING,
          'Could not acquire simulation state from %s'
169
          % self.getRelativeUrl(), error=True)
170 171
    else:
      return getState(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
172

173 174 175 176 177 178 179 180 181
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getTranslatedSimulationStateTitle')
  def getTranslatedSimulationStateTitle(self):
    """Returns translated simulation state title, for user interface, such as
    stock browser.
    """
    delivery = self.getDeliveryValue()
    if delivery is not None:
      return delivery.getTranslatedSimulationStateTitle()
182
    # 'order' category is deprecated. it is kept for compatibility.
183 184 185 186 187 188 189 190 191
    order = self.getOrderValue()
    if order is not None:
      return order.getTranslatedSimulationStateTitle()
    # The simulation_state of a simulation movement is calculated by a
    # mapping, there's no reliable way of getting the translated title from a
    # simulation state ID, so we just return the state ID because we got
    # nothing better to return.
    return self.getSimulationState()

192 193 194
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isCompleted')
  def isCompleted(self):
195 196 197
    """Lookup business path and, if any, return True whenever
    simulation_state is in of completed state list defined on business path
    """
198
    # only available in BPM, so fail totally in case of working without BPM
199 200 201
    business_link =  self.getCausalityValue(
                         portal_type=self.getPortalBusinessLinkTypeList())
    if business_link is None:
202
      return False
203
    return self.getSimulationState() in business_link.getCompletedStateList()
204 205 206 207 208 209 210

  security.declareProtected(Permissions.AccessContentsInformation,
                            'isFrozen')
  def isFrozen(self):
    """Lookup business path and, if any, return True whenever
    simulation_state is in one of the frozen states defined on business path
    """
211 212
    if self._baseGetFrozen():
      return True
213 214 215
    business_link =  self.getCausalityValue(
                         portal_type=self.getPortalBusinessLinkTypeList())
    if business_link is None:
216 217 218 219 220 221
      # Legacy support - this should never happen
      # XXX-JPS ADD WARNING
      if self.getSimulationState() in ('stopped', 'delivered', 'cancelled'):
        return True
      if self._baseIsFrozen() == 0:
        self._baseSetFrozen(None)
222
      return False
223
    return self.getSimulationState() in business_link.getFrozenStateList()
224

225 226
  security.declareProtected( Permissions.AccessContentsInformation,
                            'isAccountable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
227 228 229
  def isAccountable(self):
    """
      Returns 1 if this needs to be accounted
230 231 232
      Some Simulation movement corresponds to non accountable movements,
      the parent applied rule decide wether this movement is accountable
      or not.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
233
    """
234
    return self.getParentValue().isAccountable(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
235 236 237 238 239


  #######################################################
  # Causality Workflow Methods

240 241 242 243 244
  security.declarePrivate('_getApplicableRuleList')
  def _getApplicableRuleList(self):
    """ Search rules that match this movement
    """
    portal_rules = self.getPortalObject().portal_rules
245 246 247
    # XXX-Leo: According to JP, the 'version' search below is wrong and
    # should be replaced by a check that there are not two rules with the
    # same reference that can be returned.
248 249 250
    return portal_rules.searchRuleList(self,
                                       sort_on='version',
                                       sort_order='descending')
251

Jean-Paul Smets's avatar
Jean-Paul Smets committed
252
  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
253 254 255
  def expand(self, expand_policy=None, **kw):
    """Update applied rules inside this simulation movement and expand them

256 257 258
    Checks all existing applied rules and make sure they still apply.
    Checks for other possible rules and starts expansion process (instanciates
    applied rules and calls expand on them).
259 260
    """
    policy_dict[expand_policy](**kw).expand(self)
261

262 263
  def _expandNow(self, maybe_expand):
    """
264 265
    First get all applicable rules,
    then, delete all applied rules that no longer match and are not linked to
266
    a delivery, or expand those that still apply,
267 268
    finally, apply new rules if no rule with the same type is already applied.
    """
269 270 271 272 273 274 275 276 277 278
    # XXX: Although policy is "copy everything required to simulation
    #      movements", we must reindex in case that simulation state has
    #      changed.
    #      Also, if this movement is edited (by 'expand' call on the parent),
    #      there's already a reindexing activity so this does nothing; but if
    #      'expand' was deferred for this movement, this will generate a
    #      second & useless reindexing activity.
    #      All this could be avoided if each simulation movement remembered
    #      the previous state.
    self.reindexObject()
279
    applicable_rule_dict = {}
280
    for rule in self._getApplicableRuleList():
281 282
      reference = rule.getReference()
      if reference:
283 284
        # XXX-Leo: We should complain loudly if there is more than one
        # applicable rule per reference. It indicates a configuration error.
285
        applicable_rule_dict.setdefault(reference, rule)
286

287
    applicable_rule_list = applicable_rule_dict.values()
288
    for applied_rule in list(self.objectValues()):
289
      rule = applied_rule.getSpecialiseValue()
290 291 292 293 294 295 296 297 298 299 300
      try:
        applicable_rule_list.remove(rule)
      except ValueError:
        if applied_rule._isTreeDelivered():
          reference = rule.getReference()
          try:
            applicable_rule_list.remove(applicable_rule_dict.pop(reference))
          except KeyError:
            pass
        else:
          self._delObject(applied_rule.getId())
301
      else:
302
        maybe_expand(rule, applied_rule)
303

304
    for rule in applicable_rule_list:
305
      maybe_expand(rule, rule.constructNewAppliedRule(self))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
306

307 308 309 310 311
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getExplanationValue')
  def getExplanationValue(self):
    """Returns the delivery if any or the order related to the root
    applied rule if any.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
312
    """
313 314
    explanation_value = self.getDeliveryValue()
    if explanation_value is None:
315
      # If the parent is not an Applied Rule, self does not have the method.
316 317
      getRootAppliedRule = getattr(self, 'getRootAppliedRule', None)
      if getRootAppliedRule is None:
318
        return None
319
      ra = getRootAppliedRule()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
320 321
      order = ra.getCausalityValue()
      if order is not None:
322
        return order
Jean-Paul Smets's avatar
Jean-Paul Smets committed
323 324
      else:
        # Ex. zero stock rule
325
        return ra
326 327 328 329 330 331 332 333
    portal = self.getPortalObject()
    delivery_type_list = portal.getPortalDeliveryTypeList() \
                       + portal.getPortalOrderTypeList()
    while explanation_value.getPortalType() not in delivery_type_list:
      explanation_value = explanation_value.getParentValue()
      if explanation_value == portal:
        return
    return explanation_value
334

Jean-Paul Smets's avatar
Jean-Paul Smets committed
335
  # Deliverability / orderability
336 337
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isOrderable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
338
  def isOrderable(self):
339 340
    # the value of this method is no longer used.
    return True
Jean-Paul Smets's avatar
Jean-Paul Smets committed
341

342 343
  getOrderable = isOrderable

344 345
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDeliverable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
346
  def isDeliverable(self):
347 348
    # the value of this method is no longer used.
    return True
Jean-Paul Smets's avatar
Jean-Paul Smets committed
349

350
  getDeliverable = isDeliverable
351

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
352 353 354
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDeletable')
  def isDeletable(self):
Nicolas Dumazet's avatar
Nicolas Dumazet committed
355
    return not self.isFrozen() and not self._isTreeDelivered()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
356

357
  # Simulation Dates - acquire target dates
358 359
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStartDate')
360
  def getOrderStartDate(self):
361
    # 'order' category is deprecated. it is kept for compatibility.
362 363 364
    order_value = self.getOrderValue()
    if order_value is not None:
      return order_value.getStartDate()
365 366 367
    delivery_value = self.getDeliveryValue()
    if delivery_value is not None:
      return delivery_value.getStartDate()
368

369 370
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStopDate')
371
  def getOrderStopDate(self):
372
    # 'order' category is deprecated. it is kept for compatibility.
373 374 375
    order_value = self.getOrderValue()
    if order_value is not None:
      return order_value.getStopDate()
376 377 378
    delivery_value = self.getDeliveryValue()
    if delivery_value is not None:
      return delivery_value.getStopDate()
Romain Courteaud's avatar
Romain Courteaud committed
379

380 381
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStartDateList')
Romain Courteaud's avatar
Romain Courteaud committed
382 383
  def getDeliveryStartDateList(self):
    """
384
      Returns the stop date of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
385 386 387 388 389 390
    """
    start_date_list = []
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      start_date_list.append(delivery_movement.getStartDate())
    return start_date_list
391

392 393
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStopDateList')
Romain Courteaud's avatar
Romain Courteaud committed
394 395
  def getDeliveryStopDateList(self):
    """
396
      Returns the stop date of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
397 398 399 400 401 402
    """
    stop_date_list = []
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      stop_date_list.append(delivery_movement.getStopDate())
    return stop_date_list
403

404 405
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryQuantity')
Romain Courteaud's avatar
Romain Courteaud committed
406 407
  def getDeliveryQuantity(self):
    """
408
      Returns the quantity of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
409
    """
410
    quantity = 0.0
Romain Courteaud's avatar
Romain Courteaud committed
411 412 413 414
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      quantity = delivery_movement.getQuantity()
    return quantity
415

416 417
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isConvergent')
418 419
  def isConvergent(self):
    """
420
      Returns true if the Simulation Movement is convergent with the
421
      the delivery value
422 423 424
    """
    return not self.isDivergent()

425
  security.declareProtected( Permissions.AccessContentsInformation,
426
      'isDivergent')
427 428
  def isDivergent(self):
    """
429
      Returns true if the Simulation Movement is divergent from the
430
      the delivery value
431
    """
432 433 434 435 436 437 438 439 440 441
    return self.getParentValue().isDivergent(self)

  security.declareProtected( Permissions.AccessContentsInformation,
      'getDivergenceList')
  def getDivergenceList(self):
    """
    Returns detailed information about the divergence
    """
    return self.getParentValue().getDivergenceList(self)

442 443
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDefaultDeliveryProperties')
444 445
  def setDefaultDeliveryProperties(self):
    """
446 447
    Sets the delivery_ratio and delivery_error properties to the
    calculated value
448 449 450 451 452
    """
    delivery = self.getDeliveryValue()
    if delivery is not None:
      delivery.updateSimulationDeliveryProperties(movement_list = [self])

453 454
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getCorrectedQuantity')
455 456
  def getCorrectedQuantity(self):
    """
457 458
    Returns the quantity property deducted by the possible profit_quantity and
    taking into account delivery error
459 460 461 462 463

    NOTE: XXX-JPS This method should not use profit_quantity. Profit and loss
          quantities are now only handled through explicit movements.
          Look are invocations of _isProfitAndLossMovement in
          ERP5.mixin.rule to understand how.
464
    """
465
    quantity = self.getQuantity()
466 467 468
    profit_quantity = self.getProfitQuantity() or 0
    delivery_error = self.getDeliveryError() or 0
    return quantity - profit_quantity + delivery_error
469

470 471
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRootSimulationMovement')
472 473 474
  def getRootSimulationMovement(self):
    """
      Return the root simulation movement in the simulation tree.
475
      FIXME : this method should be called getRootSimulationMovementValue
476
    """
477
    parent_applied_rule = self.getParentValue()
478 479 480 481 482
    if parent_applied_rule.getRootAppliedRule() == parent_applied_rule:
      return self
    else:
      return parent_applied_rule.getRootSimulationMovement()

483 484
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRootSimulationMovementUid')
485 486 487 488 489 490 491 492 493
  def getRootSimulationMovementUid(self):
    """
      Return the uid of the root simulation movement in the simulation tree.
    """
    root_simulation_movement = self.getRootSimulationMovement()
    if root_simulation_movement is not None:
      return root_simulation_movement.getUid()
    return None

494
  security.declareProtected( Permissions.AccessContentsInformation,
495
                             'getRootCausalityValueList')
496 497 498 499 500 501 502 503
  def getRootCausalityValueList(self):
    """
      Returns the initial causality value for this movement.
      This method will look at the causality and check if the
      causality has already a causality
    """
    root_rule = self.getRootAppliedRule()
    return root_rule.getCausalityValueList()
504

505
  # XXX FIXME Use a interaction workflow instead
506
  # XXX This behavior is now done by simulation_movement_interaction_workflow
507
  # The call to activate() must be done after actual call to
508
  # setDelivery() on the movement,
509
  # but activate() must be called on the previous delivery...
510 511 512 513 514 515 516 517
  #def _setDelivery(self, value):
  #  LOG('setDelivery before', 0, '')
  #  delivery_value = self.getDeliveryValue()
  #  Movement.setDelivery(value)
  #  LOG('setDelivery', 0, '')
  #  if delivery_value is not None:
  #    LOG('delivery_value = ', 0, repr(delivery_value))
  #    activity = delivery_value.activate(
518
  #                activity='SQLQueue',
519
  #                after_path_and_method_id=(
520 521
  #                                        self.getPath(),
  #                                        ['immediateReindexObject',
522 523
  #                                         'recursiveImmediateReindexObject']))
  #    activity.edit()
524

525
  def _isTreeDelivered(self):
526 527 528 529 530 531 532
    """
    checks if subapplied rules  of this movement (going down the complete
    simulation tree) have a child with a delivery relation.
    Returns True if at least one is delivered, False if none of them are.

    see AppliedRule._isTreeDelivered
    """
533 534 535 536
    def getTreeDelivered():
      if self.getDeliveryList():
        return True
      for applied_rule in self.objectValues():
537 538 539
        if applied_rule._isTreeDelivered():
          return True
      return False
540 541 542 543 544 545 546 547 548 549
    try:
      cache = getTransactionalVariable()[TREE_DELIVERED_CACHE_KEY]
    except KeyError:
      return getTreeDelivered()
    rule_key = self.getRelativeUrl()
    try:
      return cache[rule_key]
    except KeyError:
      cache[rule_key] = result = getTreeDelivered()
      return result
550

551 552 553 554
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isBuildable')
  def isBuildable(self):
    """Simulation Movement buildable logic"""
Jérome Perrin's avatar
Jérome Perrin committed
555
    if self.getDelivery():
556 557
      # already delivered
      return False
558

Sebastien Robin's avatar
Sebastien Robin committed
559
    # might be buildable - business path dependent
560
    business_link = self.getCausalityValue(portal_type='Business Link')
561
    explanation_value = self.getExplanationValue()
562
    if business_link is None or explanation_value is None:
563
      return True
Sebastien Robin's avatar
Sebastien Robin committed
564

Julien Muchembled's avatar
Julien Muchembled committed
565 566 567
    ## XXX Code below following line has been moved to BusinessPath (cf r37116)
    #return len(business_path.filterBuildableMovementList([self])) == 1

568
    predecessor_state = business_link.getPredecessor()
Sebastien Robin's avatar
Sebastien Robin committed
569
    if predecessor_state is None:
570
      # first one, can be built
571
      return True # XXX-JPS wrong cause root is marked
572

Sebastien Robin's avatar
Sebastien Robin committed
573 574
    # movement is not built, and corresponding business path
    # has predecessors: check movements related to those predecessors!
575 576 577
    composed_document = self.asComposedDocument()
    predecessor_link_list = composed_document.getBusinessLinkValueList(
            successor=predecessor_state)
Sebastien Robin's avatar
Sebastien Robin committed
578 579 580 581 582 583 584 585 586 587

    def isBuiltAndCompleted(simulation, path):
      return simulation.getCausalityValue() is not None and \
          simulation.getSimulationState() in path.getCompletedStateList()

    ### Step 1:
    ## Explore ancestors in ZODB (cheap)
    #

    # store a causality -> causality_related_movement_list mapping
Julien Muchembled's avatar
Julien Muchembled committed
588 589 590 591 592 593
    causality_dict = {}
    current = self.getParentValue().getParentValue()
    while current.getPortalType() == "Simulation Movement":
      causality_dict[current.getCausality(portal_type='Business Link')] = \
        current
      current = current.getParentValue().getParentValue()
Sebastien Robin's avatar
Sebastien Robin committed
594 595

    remaining_path_set = set()
596
    for path in predecessor_link_list:
Sebastien Robin's avatar
Sebastien Robin committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
      related_simulation = causality_dict.get(path.getRelativeUrl())
      if related_simulation is None:
        remaining_path_set.add(path)
        continue
      # XXX assumption is made here that if we find ONE completed ancestor
      # movement of self that is related to a predecessor path, then
      # that predecessor path is completed. Is it True? (aka when
      # Business Process goes downwards, is the maximum movements per
      # predecessor 1 or can we have more?)
      if not isBuiltAndCompleted(related_simulation, path):
        return False

    # in 90% of cases, Business Path goes downward and this is enough
    if not remaining_path_set:
      return True

613 614 615
    # XXX(Seb) All the code below is not tested and not documented.
    # Documentation must be written, the code must be reviewed or dropped

Sebastien Robin's avatar
Sebastien Robin committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
    # But sometimes we have to dig deeper

    ### Step 2:
    ## Try catalog to find descendant movements, knowing
    # that it can be incomplete

    class treeNode(dict):
      """
      Used to cache accesses to ZODB objects.
      The idea is to put in visited_movement_dict the objects we've already
      loaded from ZODB in Step #2 to avoid loading them again in Step #3.

      - self represents a single ZODB container c
      - self.visited_movement_dict contains an id->(ZODB obj) cache for
        subobjects of c
      - self[id] contains the treeNode representing c[id]
      """
      def __init__(self):
        dict.__init__(self)
        self.visited_movement_dict = dict()

    path_tree = treeNode()
    def updateTree(simulation_movement, path):
      tree_node = path_tree
      movement_path = simulation_movement.getPhysicalPath()
      simulation_movement_id = movement_path[-1]
      # find container
      for path_id in movement_path[:-1]:
        tree_node = tree_node.setdefault(path_id, treeNode())
      # and mark the object as visited
      tree_node.visited_movement_dict[simulation_movement_id] = (simulation_movement, path)

    portal_catalog = self.getPortalObject().portal_catalog
    catalog_simulation_movement_list = portal_catalog(
      portal_type='Simulation Movement',
      causality_uid=[p.getUid() for p in remaining_path_set],
652
      path='%s/%%' % self.getPath().replace('_', r'\_'))
Sebastien Robin's avatar
Sebastien Robin committed
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719

    for movement in catalog_simulation_movement_list:
      path = movement.getCausalityValue()
      if not isBuiltAndCompleted(movement, path):
        return False
      updateTree(movement, path)

    ### Step 3:
    ## We had no luck, we have to explore descendant movements in ZODB
    #
    def descendantGenerator(document, tree_node, path_set_to_check):
      """
      generator yielding Simulation Movement descendants of document.
      It does _not_ explore the whole subtree if iteration is stopped.

      It uses the tree we built previously to avoid loading again ZODB
      objects that we already loaded during catalog querying

      path_set_to_check contains a set of Business Paths that we are
      interested in. A branch is only explored if this set is not
      empty; a movement is only yielded if its causality value is in this set
      """
      object_id_list = document.objectIds()
      for id in object_id_list:
        if id not in tree_node.visited_movement_dict:
          # we had not visited it in step #2
          subdocument = document._getOb(id)
          if subdocument.getPortalType() == "Simulation Movement":
            path = subdocument.getCausalityValue()
            t = (subdocument, path)
            tree_node.visited_movement_dict[id] = t
            if path in path_set_to_check:
              yield t
          else:
            # it must be an Applied Rule
            subtree = tree_node.get(id, treeNode())
            for d in descendantGenerator(subdocument,
                                         subtree,
                                         path_set_to_check):
              yield d

      for id, t in tree_node.visited_movement_dict.iteritems():
        subdocument, path = t
        to_check = path_set_to_check
        # do we need to change/copy the set?
        if path in to_check:
          if len(to_check) == 1:
            # no more paths to check in this branch
            continue
          to_check = to_check.copy()
          to_check.remove(path)
        subtree = tree_node.get(id, treeNode())
        for d in descendantGenerator(subdocument, subtree, to_check):
          yield d

    # descend in the tree to find self:
    tree_node = path_tree
    for path_id in self.getPhysicalPath():
      tree_node = tree_node.get(path_id, treeNode())

    # explore subobjects of self
    for descendant, path in descendantGenerator(self,
                                                tree_node,
                                                remaining_path_set):
      if not isBuiltAndCompleted(descendant, path):
        return False

720
    return True
721

722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
  def getSolverProcessValueList(self, movement=None, validation_state=None):
    """
    Returns the list of solver processes which are
    are in a given state and which apply to delivery_or_movement.
    This method is useful to find applicable solver processes
    for a delivery.

    movement -- not applicable

    validation_state -- a state of a list of states
                        to filter the result
    """
    raise NotImplementedError

  def getSolverDecisionValueList(self, movement=None, validation_state=None):
    """
    Returns the list of solver decisions which apply
    to a given movement.

    movement -- not applicable

    validation_state -- a state of a list of states
                        to filter the result
    """
    raise NotImplementedError

  def getSolvedPropertyApplicationValueList(self, movement=None, divergence_tester=None):
    """
    Returns the list of documents at which a given divergence resolution
    can be resolved at. For example, in most cases, date divergences can
    only be resolved at delivery level whereas quantities are usually
    resolved at cell level.

    The result of this method is a list of ERP5 documents.

    movement -- not applicable
    """
    raise NotImplementedError
760 761 762 763

  security.declareProtected(Permissions.AccessContentsInformation,
                            'getMappedProperty')
  def getMappedProperty(self, property):
764
    mapping = self.getPropertyMappingValue()
765
    if mapping is not None:
766
      # Special case: corrected quantity is difficult to handle,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
767
      # because, if quantity is inverse in the mapping, other
768
      # parameters, profit quantity (deprecated) and delivery error,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
769
      # must be inverse as well.
770 771 772 773 774 775 776 777 778 779 780
      if property == 'corrected_quantity':
        mapped_quantity_id = mapping.getMappedPropertyId('quantity')
        quantity = mapping.getMappedProperty(self, 'quantity')
        profit_quantity = self.getProfitQuantity() or 0
        delivery_error = self.getDeliveryError() or 0
        if mapped_quantity_id[:1] == '-':
          # XXX what about if "quantity | -something_different" is
          # specified?
          return quantity + profit_quantity - delivery_error
        else:
          return quantity - profit_quantity + delivery_error
781
      return mapping.getMappedProperty(self, property)
Jérome Perrin's avatar
Jérome Perrin committed
782
    return self.getProperty(property)
783 784 785 786 787 788 789

  security.declareProtected(Permissions.ModifyPortalContent,
                            'setMappedProperty')
  def setMappedProperty(self, property, value):
    mapping = self.getPropertyMappingValue()
    if mapping is not None:
      return mapping.setMappedProperty(self, property, value)
Jérome Perrin's avatar
Jérome Perrin committed
790
    return self.setProperty(property, value)