SimulationMovement.py 20.5 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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 Globals import InitializeClass
from AccessControl import ClassSecurityInfo
from Products.CMFCore.utils import getToolByName

33
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
34
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

36
from Products.ERP5.Document.Movement import Movement
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 41
from Acquisition import aq_base

42
from Products.ERP5.Document.AppliedRule import TREE_DELIVERED_CACHE_KEY, TREE_DELIVERED_CACHE_ENABLED
43

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
# 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',
}

class SimulationMovement(Movement):
  """
      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'
  isMovement = 1

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

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
123
  # Price should be acquired
124 125
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getPrice')
126
  def getPrice(self, default=None, context=None, REQUEST=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127 128
    """
    """
129
    return self._baseGetPrice(default) # Call the price method
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130

131 132
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getCausalityState')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
133 134 135 136
  def getCausalityState(self):
    """
      Returns the current state in causality
    """
137
    return getattr(aq_base(self), 'causality_state', 'solved')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
138

139 140
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setCausalityState')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
141 142 143 144 145 146
  def setCausalityState(self, value):
    """
      Change causality state
    """
    self.causality_state = value

147 148
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getSimulationState')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
149 150 151 152
  def getSimulationState(self, id_only=1):
    """
      Returns the current state in simulation

153 154
      Inherit from order or delivery or parent (but use a conversion
      table to make orders planned when parent is confirmed)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
155 156 157 158 159 160 161 162 163 164

      XXX: movements in zero stock rule can not acquire simulation state
    """
    delivery = self.getDeliveryValue()
    if delivery is not None:
      return delivery.getSimulationState()
    order = self.getOrderValue()
    if order is not None:
      return order.getSimulationState()
    try:
165
      parent_state = self.getParentValue().getSimulationState()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
166
      return parent_to_movement_simulation_state[parent_state]
167
    except (KeyError, AttributeError):
168 169 170
      LOG('SimulationMovement.getSimulationState', WARNING,
          'Could not acquire simulation state from %s'
          % self.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
171 172
      return None

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  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()
    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()

191 192 193 194 195 196 197 198
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isCompleted')
  def isCompleted(self):
    """Zope publisher docstring. Documentation in ISimulationMovement"""
    # only available in BPM, so fail totally in case of working without BPM
    return self.getSimulationState() in self.getCausalityValue(
        portal_type='Business Path').getCompletedStateList()

199 200
  security.declareProtected( Permissions.AccessContentsInformation,
                            'isAccountable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201 202 203
  def isAccountable(self):
    """
      Returns 1 if this needs to be accounted
204 205 206
      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
207
    """
208
    return self.getParentValue().isAccountable(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
209 210

  # Ordering / Delivering
211 212
  security.declareProtected( Permissions.AccessContentsInformation,
                             'requiresOrder')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
213 214 215 216 217 218 219 220 221
  def requiresOrder(self):
    """
      Returns 1 if this needs to be ordered
    """
    if isOrderable():
      return len(self.getCategoryMembership('order')) is 0
    else:
      return 0

222 223
  security.declareProtected( Permissions.AccessContentsInformation,
                             'requiresDelivery')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237
  def requiresDelivery(self):
    """
      Returns 1 if this needs to be accounted
    """
    if isDeliverable():
      return len(self.getCategoryMembership('delivery')) is 0
    else:
      return 0


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

  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
238
  def expand(self, force=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 281 282 283 284 285 286 287 288 289 290
    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).

    First get all applicable rules,
    then, delete all applied rules that no longer match and are not linked to
    a delivery,
    finally, apply new rules if no rule with the same type is already applied.
    """
    portal_rules = getToolByName(self, 'portal_rules')

    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

    applied_rule_dict = {}
    applicable_rule_dict = {}
    for rule in portal_rules.searchRuleList(self, sort_on='version',
        sort_order='descending'):
      ref = rule.getReference()
      if ref and ref not in applicable_rule_dict.iterkeys():
        applicable_rule_dict[ref] = rule

    for applied_rule in self.objectValues():
      rule = applied_rule.getSpecialiseValue()
      if not applied_rule._isTreeDelivered() and not rule.test(self):
        self._delObject(applied_rule.getId())
      else:
        applied_rule_dict[rule.getPortalType()] = applied_rule

    for rule in applicable_rule_dict.itervalues():
      rule_type = rule.getPortalType()
      if rule_type not in applied_rule_dict.iterkeys():
        applied_rule = rule.constructNewAppliedRule(self, **kw)
        applied_rule_dict[rule_type] = applied_rule

    self.setCausalityState('expanded')
    # expand
    for applied_rule in applied_rule_dict.itervalues():
      applied_rule.expand(force=force, **kw)

    # disable and clear cache
    if not cache_enabled:
      try:
        del tv[TREE_DELIVERED_CACHE_KEY]
      except KeyError:
        pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
291 292 293 294 295 296 297 298 299 300

  security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
  def diverge(self):
    """
       -> new status -> diverged

       Movements which diverge can not be expanded
    """
    self.setCausalityState('diverged')

301 302 303 304 305
  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
306 307 308 309 310
    """
    if self.getDeliveryValue() is None:
      ra = self.getRootAppliedRule()
      order = ra.getCausalityValue()
      if order is not None:
311
        return order
Jean-Paul Smets's avatar
Jean-Paul Smets committed
312 313
      else:
        # Ex. zero stock rule
314
        return ra
Jean-Paul Smets's avatar
Jean-Paul Smets committed
315
    else:
316
      explanation_value = self.getDeliveryValue()
317 318
      while explanation_value.getPortalType() not in \
              self.getPortalDeliveryTypeList() and \
319
          explanation_value != self.getPortalObject():
320
            explanation_value = explanation_value.getParentValue()
321
      if explanation_value != self.getPortalObject():
322
        return explanation_value
323

Jean-Paul Smets's avatar
Jean-Paul Smets committed
324
  # Deliverability / orderability
325 326
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isOrderable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
327
  def isOrderable(self):
328
    applied_rule = self.getParentValue()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
329 330
    rule = applied_rule.getSpecialiseValue()
    if rule is not None:
331
      return rule.isOrderable(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
332 333
    return 0

334 335
  getOrderable = isOrderable

336 337
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isDeliverable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
338
  def isDeliverable(self):
339
    applied_rule = self.getParentValue()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
340 341
    rule = applied_rule.getSpecialiseValue()
    if rule is not None:
342
      return rule.isDeliverable(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
343 344
    return 0

345
  getDeliverable = isDeliverable
346

347
  # Simulation Dates - acquire target dates
348 349
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStartDate')
350 351 352 353
  def getOrderStartDate(self):
    order_value = self.getOrderValue()
    if order_value is not None:
      return order_value.getStartDate()
354

355 356
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getOrderStopDate')
357 358 359 360
  def getOrderStopDate(self):
    order_value = self.getOrderValue()
    if order_value is not None:
      return order_value.getStopDate()
Romain Courteaud's avatar
Romain Courteaud committed
361

362 363
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStartDateList')
Romain Courteaud's avatar
Romain Courteaud committed
364 365
  def getDeliveryStartDateList(self):
    """
366
      Returns the stop date of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
367 368 369 370 371 372
    """
    start_date_list = []
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      start_date_list.append(delivery_movement.getStartDate())
    return start_date_list
373

374 375
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryStopDateList')
Romain Courteaud's avatar
Romain Courteaud committed
376 377
  def getDeliveryStopDateList(self):
    """
378
      Returns the stop date of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
379 380 381 382 383 384
    """
    stop_date_list = []
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      stop_date_list.append(delivery_movement.getStopDate())
    return stop_date_list
385

386 387
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getDeliveryQuantity')
Romain Courteaud's avatar
Romain Courteaud committed
388 389
  def getDeliveryQuantity(self):
    """
390
      Returns the quantity of related delivery
Romain Courteaud's avatar
Romain Courteaud committed
391
    """
392
    quantity = 0.0
Romain Courteaud's avatar
Romain Courteaud committed
393 394 395 396
    delivery_movement = self.getDeliveryValue()
    if delivery_movement is not None:
      quantity = delivery_movement.getQuantity()
    return quantity
397

398 399
  security.declareProtected( Permissions.AccessContentsInformation,
                             'isConvergent')
400 401
  def isConvergent(self):
    """
402
      Returns true if the Simulation Movement is convergent with the
403
      the delivery value
404 405 406
    """
    return not self.isDivergent()

407
  security.declareProtected( Permissions.AccessContentsInformation,
408
      'isDivergent')
409 410
  def isDivergent(self):
    """
411
      Returns true if the Simulation Movement is divergent from the
412
      the delivery value
413
    """
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
    return self.getParentValue().isDivergent(self)

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

  security.declareProtected( Permissions.AccessContentsInformation,
      'getSolverList')
  def getSolverList(self):
    """
    Returns solvers that can fix the current divergence
    """
    return self.getParentValue().getSolverList(self)

432 433
  security.declareProtected( Permissions.ModifyPortalContent,
                             'setDefaultDeliveryProperties')
434 435
  def setDefaultDeliveryProperties(self):
    """
436 437
    Sets the delivery_ratio and delivery_error properties to the
    calculated value
438 439 440 441 442
    """
    delivery = self.getDeliveryValue()
    if delivery is not None:
      delivery.updateSimulationDeliveryProperties(movement_list = [self])

443 444
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getCorrectedQuantity')
445 446
  def getCorrectedQuantity(self):
    """
447 448
    Returns the quantity property deducted by the possible profit_quantity and
    taking into account delivery error
449 450
    """
    quantity = self.getQuantity()
451 452 453
    profit_quantity = self.getProfitQuantity() or 0
    delivery_error = self.getDeliveryError() or 0
    return quantity - profit_quantity + delivery_error
454

455 456
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRootSimulationMovement')
457 458 459
  def getRootSimulationMovement(self):
    """
      Return the root simulation movement in the simulation tree.
460
      FIXME : this method should be called getRootSimulationMovementValue
461
    """
462
    parent_applied_rule = self.getParentValue()
463 464 465 466 467
    if parent_applied_rule.getRootAppliedRule() == parent_applied_rule:
      return self
    else:
      return parent_applied_rule.getRootSimulationMovement()

468 469
  security.declareProtected( Permissions.AccessContentsInformation,
                             'getRootSimulationMovementUid')
470 471 472 473 474 475 476 477 478
  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

479
  security.declareProtected( Permissions.AccessContentsInformation,
480
                             'getRootCausalityValueList')
481 482 483 484 485 486 487 488
  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()
489

490
  # XXX FIXME Use a interaction workflow instead
491
  # XXX This behavior is now done by simulation_movement_interaction_workflow
492
  # The call to activate() must be done after actual call to
493
  # setDelivery() on the movement,
494
  # but activate() must be called on the previous delivery...
495 496 497 498 499 500 501 502
  #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(
503
  #                activity='SQLQueue',
504
  #                after_path_and_method_id=(
505 506
  #                                        self.getPath(),
  #                                        ['immediateReindexObject',
507 508
  #                                         'recursiveImmediateReindexObject']))
  #    activity.edit()
509

510 511 512 513 514 515 516 517 518 519 520 521 522
  def _isTreeDelivered(self, ignore_first=0):
    """
    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
    """
    tv = getTransactionalVariable(self)
    cache = tv.setdefault(TREE_DELIVERED_CACHE_KEY, {})
    cache_enabled = cache.get(TREE_DELIVERED_CACHE_ENABLED, 0)

    def getTreeDelivered(movement, ignore_first=0):
523
      if not ignore_first:
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
        if len(movement.getDeliveryList()) > 0:
          return True
      for applied_rule in movement.objectValues():
        if applied_rule._isTreeDelivered():
          return True
      return False

    if ignore_first:
      rule_key = (self.getRelativeUrl(), 1)
    else:
      rule_key = self.getRelativeUrl()
    if cache_enabled:
      try:
        return cache[rule_key]
      except:
        result = getTreeDelivered(self, ignore_first=ignore_first)
        cache[rule_key] = result
        return result
    else:
      return getTreeDelivered(self, ignore_first=ignore_first)

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isBuildable')
  def isBuildable(self):
    """Simulation Movement buildable logic"""
    if self.getDeliveryValue() is not None:
      # already delivered
      return False
    # might be buildable - business path depended
    business_path = self.getCausalityValue(portal_type='Business Path')
    explanation_value = self.getExplanationValue()
    if business_path is not None and explanation_value is not None:
      predecessor = business_path.getPredecessorValue()
      if predecessor is None:
        # first one, can be built
        return True
      else:
        for successor_related in predecessor.getSuccessorRelatedValueList():
          for business_path_movement in successor_related \
              .getRelatedSimulationMovementValueList(explanation_value):
564
            if successor_related.isMovementRelatedWithMovement(self, business_path_movement):
565 566 567 568 569 570 571 572 573 574 575 576 577
              business_path_movement_delivery = business_path_movement \
                  .getDeliveryValue()
              if business_path_movement_delivery is None:
                return False # related movement is not delivered yet
              business_path_movement_delivery_document = \
                  business_path_movement_delivery.getParentValue()
              # here we can optimise somehow, as
              # business_path_movement_delivery_document would repeat
              if not successor_related.isCompleted(
                  business_path_movement_delivery_document):
                # related movements delivery is not completed
                return False
    return True