OrderRule.py 10.9 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 33 34 35 36 37 38 39 40 41 42 43 44 45
#
# 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'
46
    add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
    isPortalContent = 1
    isRADContent = 1

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

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

    # CMF Factory Type Information
    factory_type_information = \
      {    'id'             : portal_type
         , 'meta_type'      : meta_type
         , 'description'    : """\
An ERP5 Rule..."""
         , 'icon'           : 'rule_icon.gif'
         , 'product'        : 'ERP5'
         , 'factory'        : 'addOrderRule'
         , 'immediate_view' : 'rule_view'
         , 'allow_discussion'     : 1
         , 'allowed_content_types': ()
         , 'filter_content_types' : 1
         , 'global_allow'   : 1
         , 'actions'        :
        ( { 'id'            : 'view'
          , 'name'          : 'View'
          , 'category'      : 'object_view'
          , 'action'        : 'rule_view'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'list'
          , 'name'          : 'Object Contents'
          , 'category'      : 'object_action'
          , 'action'        : 'folder_contents'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'print'
          , 'name'          : 'Print'
          , 'category'      : 'object_print'
          , 'action'        : 'rule_print'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'metadata'
          , 'name'          : 'Metadata'
          , 'category'      : 'object_view'
          , 'action'        : 'metadata_edit'
          , 'permissions'   : (
              Permissions.View, )
          }
        , { 'id'            : 'translate'
          , 'name'          : 'Translate'
          , 'category'      : 'object_action'
          , 'action'        : 'translation_template_view'
          , 'permissions'   : (
              Permissions.TranslateContent, )
          }
        )
      }

    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')
123
    def expand(self, applied_rule, force=0, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
      """
        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:
139 140
        # Only expand order rule if order not yet confirmed (This is consistent
        # with the fact that once simulation is launched, we stick to it)
141
        if force or \
142 143
           (applied_rule.getLastExpandSimulationState() not in applied_rule.getPortalReservedInventoryStateList() and \
           applied_rule.getLastExpandSimulationState() not in applied_rule.getPortalCurrentInventoryStateList()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144 145 146 147
          # 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 = []
148
          for movement in applied_rule.contentValues(filter={'portal_type':applied_rule.getPortalMovementTypeList()}):
149
            LOG('Movement', 0, str(movement))
150
            order_value = movement.getOrderValue(portal_type=applied_rule.getPortalOrderMovementTypeList())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
151 152
            if order_value is None:
              movement.flushActivity(invoke=0)
153
              applied_rule._delObject(movement.getId())  # XXXX Make sur this is not deleted if already in delivery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
154 155 156 157 158
            else:
              if getattr(order_value, 'isCell', 0):
                existing_uid_list += [order_value.getUid()]
              elif order_value.hasCellContent():
                # Do not keep head of cells
159
                LOG('INFO', 0, 'Order Rule Deleting Simulatino Movement %s' % movement.getRelativeUrl())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160
                order_value.flushActivity(invoke=0)
161
                applied_rule._delObject(movement.getId())  # XXXX Make sur this is not deleted if already in delivery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
162 163 164 165
              else:
                existing_uid_list += [order_value.getUid()]

          # Copy each movement (line or cell) from the order
166
          for order_line_object in my_order.contentValues(filter={'portal_type':applied_rule.getPortalMovementTypeList()}):
167
            LOG('OrderRule.expand, examining:',0,order_line_object.getPhysicalPath())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
168 169 170
            try:
              if order_line_object.hasCellContent():
                for c in order_line_object.getCellValueList():
171
                  LOG('Cell  in', 0, '%s %s' % (c.getUid(), existing_uid_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
172 173
                  if c.getUid() not in existing_uid_list:
                    new_id = order_line_object.getId() + '_' + c.getId()
174
                    LOG('Create Cell', 0, str(new_id))
175
                    new_line = applied_rule.newContent(type_name=delivery_line_type,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
176
                        id=new_id,
177
                        order_value = c,
178 179 180 181 182
                        quantity = c.getQuantity(),
                        source = c.getSource(),
                        destination = c.getDestination(),
                        source_section = c.getSourceSection(),
                        destination_section = c.getDestinationSection(),
183
                        deliverable = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184
                    )
185 186
                    LOG('OrderRule.expand, object created:',0,new_line.getPhysicalPath())
                    new_line.immediateReindexObject()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
187 188 189 190
                    #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()
191
                  LOG('Line', 0, str(new_id))
192
                  new_line = applied_rule.newContent(type_name=delivery_line_type,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
193 194
                      container=applied_rule,
                      id=new_id,
195
                      order_value = order_line_object,
196 197 198 199 200
                      quantity = order_line_object.getQuantity(),
                      source = order_line_object.getSource(),
                      destination = order_line_object.getDestination(),
                      source_section = order_line_object.getSourceSection(),
                      destination_section = order_line_object.getDestinationSection(),
201
                      deliverable = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
202
                  )
203 204
                  LOG('OrderRule.expand, object created:',0,new_line.getPhysicalPath())
                  new_line.immediateReindexObject()
205
                  LOG('After Create Cell', 0, str(new_id))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
206 207 208 209 210 211
                  # Source, Destination, Quantity, Date, etc. are
                  # acquired from the order and need not to be copied.
            except AttributeError:
              LOG('ERP5: WARNING', 0, 'AttributeError during expand on order line %s'
                                                      % order_line_object.absolute_url())

212 213 214
          # Now we can set the last expand simulation state to the current state
          applied_rule.setLastExpandSimulationState(my_order.getSimulationState())

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

    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
      """
259 260 261 262 263 264

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

    def isDeliverable(self, m):
265
      if m.getSimulationState() in m.getPortalDraftOrderStateList():
266 267
        return 0
      return 1