OrderRule.py 8.05 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
5
#                    Romain Courteaud <romain@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 30
#
# 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 AccessControl import ClassSecurityInfo
31
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32
from Products.ERP5.Document.Rule import Rule
33
from Products.ERP5.Document.DeliveryRule import DeliveryRule
34
from zLOG import LOG, WARNING
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

36
class OrderRule(DeliveryRule):
37
  """
38
  Order Rule object make sure an Order in the simulation
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
  is consistent with the real order

  WARNING: what to do with movement split ?
  """
  # CMF Type Definition
  meta_type = 'ERP5 Order Rule'
  portal_type = 'Order Rule'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Simulation workflow
  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
  def expand(self, applied_rule, force=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54
    """
55 56 57
      Expands the Order to a new simulation tree.
      expand is only allowed to modify a simulation movement if it doesn't
      have a delivery relation yet.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58

59 60 61 62 63
      If the movement is in ordered or planned state, has no delivered
      child, and is not in order, it can be deleted.
      Else, if the movement is in ordered or planned state, has no
      delivered child, and is in order, it can be modified.
      Else, it cannot be modified.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64
    """
65 66 67 68
    if self._isBPM():
      DeliveryRule.expand(self, applied_rule, force=force, **kw)
      return

69 70 71 72
    existing_movement_list = []
    immutable_movement_list = []
    order = applied_rule.getDefaultCausalityValue()
    if order is not None:
73
      order_movement_list = order.getMovementList(
Jérome Perrin's avatar
typo  
Jérome Perrin committed
74
                     portal_type=order.getPortalOrderMovementTypeList())
75
      # check existing movements
76
      for movement in applied_rule.contentValues(portal_type=self.movement_type):
77 78 79 80
        if (not movement.getLastExpandSimulationState() in
            order.getPortalReservedInventoryStateList() and
            not movement.getLastExpandSimulationState() in
            order.getPortalCurrentInventoryStateList()) and \
81
            not movement._isTreeDelivered():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
82

83 84 85 86 87 88 89 90
          movement_order = movement.getOrderValue()
          if movement_order in order_movement_list:
            existing_movement_list.append(movement)
          else:
            applied_rule._delObject(movement.getId())
        else:
          existing_movement_list.append(movement)
          immutable_movement_list.append(movement)
91
       
92 93 94 95 96 97 98
      # this dict simulates getOrderRelatedValue, but it will not work if an
      # order was generated from multiple applied rules
      order_movement_dict = {}
      for s_m in applied_rule.objectValues():
        order_movement = s_m.getOrderValue()
        if order_movement is not None:
          order_movement_dict[order_movement.getPath()] = s_m
99 100
      # Create or modify movements
      for movement in order_movement_list:
101 102 103
        related_order = order_movement_dict.get(movement.getPath(), None)
        if related_order is None:
          related_order = movement.getOrderRelatedValue()
104 105
        property_dict = self._getExpandablePropertyDict(
                                            applied_rule, movement)
106 107
        if related_order is None:
          # Generate a simulation movement
108 109
          # Do not try to create meaningfull IDs, as order movement can be
          # hierarchicals
110
          applied_rule.newContent(
111
              portal_type=self.movement_type,
112 113 114
              order_value=movement,
              order_ratio=1,
              delivery_ratio=1,
115 116
              **property_dict )
          
117 118 119 120 121
        elif related_order in existing_movement_list:
          if related_order not in immutable_movement_list:
            # modification allowed
            related_order.edit(
              order_value=movement,
122 123
                **property_dict)
            
124 125 126 127 128
            #related_order.setLastExpandSimulationState(order.getSimulationState())
            
          else:
            # modification disallowed, must compensate
            pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
129

130 131 132 133
          # Now we can set the last expand simulation state to the current state
          applied_rule.setLastExpandSimulationState(order.getSimulationState())
    # Pass to base class
    Rule.expand(self, applied_rule, force=force, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134

135 136 137 138 139 140 141
  security.declareProtected(Permissions.AccessContentsInformation, 'isStable')
  def isStable(self, applied_rule):
    """
    Checks that the applied_rule is stable
    """
    LOG('OrderRule.isStable', WARNING, 'Not Implemented')
    return 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
142

143 144 145 146 147 148 149
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isDivergent')
  def isDivergent(self, movement):
    """
    Checks that the movement is divergent
    """
    return Rule.isDivergent(self, movement)
150 151 152

  security.declareProtected(Permissions.AccessContentsInformation,
                            '_getExpandablePropertyDict')
153 154
  def _getExpandablePropertyDict(self, applied_rule, movement,
      business_path=None, **kw):
155 156 157 158
    """
    Return a Dictionary with the Properties used to edit 
    the simulation movement
    """
159 160 161
    if self._isBPM():
      return DeliveryRule._getExpandablePropertyDict(self, applied_rule,
          movement, business_path, **kw)
162 163
    property_dict = {}

164 165 166 167 168 169 170
    default_property_list = self.getExpandablePropertyList()
    # For backward compatibility, we keep for some time the list
    # of hardcoded properties. Theses properties should now be
    # defined on the rule itself
    if len(default_property_list) == 0:
      LOG("Order Rule , _getExpandablePropertyDict", WARNING,
                 "Hardcoded properties set, please define your rule correctly")
171
      default_property_list = (
172
        'source',
173
        'source_section',
174
        'source_function',
175
        'source_account',
176 177
        'destination',
        'destination_section',
178
        'destination_function',
179
        'destination_account',
180
        'start_date',
181
        'stop_date',
182
        'description',
183
        'resource',
184
        'variation_category_list',
185
        'variation_property_dict',
186
        'base_contribution_list',
187 188
        'aggregate_list',
        'price',
189
        'price_currency',
190 191
        'quantity',
        'quantity_unit',
192
      )
193
  
194 195
    for prop in default_property_list:
       property_dict[prop] = movement.getProperty(prop)
196 197
       
    return property_dict
198

199 200 201 202 203 204 205 206 207 208 209 210 211 212
  def _getInputMovementList(self, applied_rule):
    """Input movement list comes from order"""
    order = applied_rule.getDefaultCausalityValue()
    if order is not None:
      return order.getMovementList(
                     portal_type=order.getPortalOrderMovementTypeList())
    return []

  def _getExpandablePropertyUpdateDict(self, applied_rule, movement,
      business_path, current_property_dict):
    """Order rule specific update dictionary"""
    return {
      'order_list': [movement.getRelativeUrl()],
    }