OrderRule.py 9.79 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 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
#
# 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
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5.Document.Rule import Rule

from zLOG import LOG

class OrderRule(Rule):
    """
      Order Rule object make sure an Order in the similation
      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.View)

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      )

    def test(self, movement):
      """
        Tests if the rule (still) applies
      """
      # An order rule never applies since it is always explicitely instanciated
      return 0

    # Simulation workflow
    security.declareProtected(Permissions.ModifyPortalContent, 'expand')
68
    def expand(self, applied_rule, force=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
      """
        Expands the current movement downward.

        -> new status -> expanded

        An applied rule can be expanded only if its parent movement
        is expanded.
      """
      delivery_line_type = 'Simulation Movement'

      # Get the order when we come from
      my_order = applied_rule.getDefaultCausalityValue()

      # Only expand if my_order is not None and state is not 'confirmed'
      if my_order is not None:
84 85
        # Only expand order rule if order not yet confirmed (This is consistent
        # with the fact that once simulation is launched, we stick to it)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
86
        state = applied_rule.getLastExpandSimulationState()
87
        if force or \
Yoshinori Okuji's avatar
Yoshinori Okuji committed
88
           (state not in \
89
                applied_rule.getPortalReservedInventoryStateList() and \
Yoshinori Okuji's avatar
Yoshinori Okuji committed
90
            state not in \
91
                applied_rule.getPortalCurrentInventoryStateList()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
92 93 94 95
          # First, check each contained movement and make
          # a list of order ids which do not need to be copied
          # eventually delete movement which do not exist anylonger
          existing_uid_list = []
Yoshinori Okuji's avatar
Yoshinori Okuji committed
96 97
          append = existing_uid_list.append
          movement_type_list = applied_rule.getPortalMovementTypeList()
98
          for movement in applied_rule.contentValues(filter={'portal_type': \
Yoshinori Okuji's avatar
Yoshinori Okuji committed
99
                                    movement_type_list}):
100
            order_value = movement.getOrderValue(\
Yoshinori Okuji's avatar
Yoshinori Okuji committed
101
                     portal_type=movement_type_list)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102 103
            if order_value is None:
              movement.flushActivity(invoke=0)
104 105
              applied_rule._delObject(movement.getId())  
              # XXX Make sur this is not deleted if already in delivery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
106 107
            else:
              if getattr(order_value, 'isCell', 0):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
108
                append(order_value.getUid())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110
              elif order_value.hasCellContent():
                # Do not keep head of cells
111 112
                LOG('INFO', 0, 'Order Rule Deleting Simulatino Movement %s' \
                                            % movement.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
113
                order_value.flushActivity(invoke=0)
114 115
                applied_rule._delObject(movement.getId())  
                # XXX Make sur this is not deleted if already in delivery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
116
              else:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
117
                append(order_value.getUid())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
118 119

          # Copy each movement (line or cell) from the order
120
          for order_line_object in my_order.contentValues(filter={ \
Yoshinori Okuji's avatar
Yoshinori Okuji committed
121
                    'portal_type':movement_type_list}):
122 123
            LOG('OrderRule.expand, examining:',0, \
                          order_line_object.getPhysicalPath())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124 125 126
            try:
              if order_line_object.hasCellContent():
                for c in order_line_object.getCellValueList():
127
                  LOG('Cell  in', 0, '%s %s' % (c.getUid(), existing_uid_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
128 129
                  if c.getUid() not in existing_uid_list:
                    new_id = order_line_object.getId() + '_' + c.getId()
130
                    LOG('Create Cell', 0, str(new_id))
131 132
                    new_line = applied_rule.newContent(
                        type_name=delivery_line_type,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
133
                        id=new_id,
134
                        order_value = c,
135
                        quantity = c.getQuantity(),
136 137 138 139
#                         source = c.getSource(),
#                         destination = c.getDestination(),
#                         source_section = c.getSourceSection(),
#                         destination_section = c.getDestinationSection(),
140
                        deliverable = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
141
                    )
142 143
                    LOG('OrderRule.expand, object created:',0, \
                        new_line.getPhysicalPath())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144 145 146 147
                    #LOG('After Create Cell', 0, str(new_id))
              else:
                if order_line_object.getUid() not in existing_uid_list:
                  new_id = order_line_object.getId()
148
                  LOG('Line', 0, str(new_id))
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
                  if order_line_object.getVariationCategoryList() == []:
                    new_line = applied_rule.newContent(
                        type_name=delivery_line_type,
                        container=applied_rule,
                        id=new_id,
                        order_value = order_line_object,
                        quantity = order_line_object.getQuantity(),
                        # No acquisition on variation_category_list in this case,
                        # to prevent user failure
                        variation_category_list = [],
  #                       source = order_line_object.getSource(),
  #                       destination = order_line_object.getDestination(),
  #                       source_section = order_line_object.getSourceSection(),
  #                       destination_section = \
  #                           order_line_object.getDestinationSection(),
                        deliverable = 1
                    )
                    LOG('OrderRule.expand, object created:',0, \
                        new_line.getPhysicalPath())
                    LOG('After Create Cell', 0, str(new_id))
                    # Source, Destination, Quantity, Date, etc. are
                    # acquired from the order and need not to be copied.
                  else:
                    raise 'Error', 'VariationCategoryList is defined on\
                          OrderLine %s and no cell exists.' %\
                          order_line_object.getRelativeUrl()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
175
            except AttributeError:
176 177 178 179 180 181 182 183
              LOG('ERP5: WARNING', 0, \
                  'AttributeError during expand on order line %s' \
                  % order_line_object.absolute_url())

          # Now we can set the last expand simulation state 
          # to the current state
          applied_rule.setLastExpandSimulationState( \
              my_order.getSimulationState())
184

Jean-Paul Smets's avatar
Jean-Paul Smets committed
185
      # Pass to base class
186
      Rule.expand(self, applied_rule, force=force, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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

    security.declareProtected(Permissions.ModifyPortalContent, 'solve')
    def solve(self, applied_rule, solution_list):
      """
        Solve inconsitency 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.
      """

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

        This basically sets the rule to "diverged"
        and blocks expansion process
      """

    # Solvers
    security.declareProtected(Permissions.View, 'isDivergent')
    def isDivergent(self, applied_rule):
      """
        Returns 1 if divergent rule
      """

    security.declareProtected(Permissions.View, 'getDivergenceList')
    def getDivergenceList(self, applied_rule):
      """
        Returns a list Divergence descriptors
      """

    security.declareProtected(Permissions.View, 'getSolverList')
    def getSolverList(self, applied_rule):
      """
        Returns a list Divergence solvers
      """
229 230 231 232 233 234

    # Deliverability / orderability
    def isOrderable(self, m):
      return 1

    def isDeliverable(self, m):
235
      if m.getSimulationState() in m.getPortalDraftOrderStateList():
236 237
        return 0
      return 1