OrderBuilder.py 34.7 KB
Newer Older
Romain Courteaud's avatar
Romain Courteaud committed
1 2
##############################################################################
#
3
# Copyright (c) 2005-2008 Nexedi SA and Contributors. All Rights Reserved.
Romain Courteaud's avatar
Romain Courteaud committed
4 5 6
#                    Romain Courteaud <romain@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
7
# programmers who take the whole responsibility of assessing all potential
Romain Courteaud's avatar
Romain Courteaud committed
8 9
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
10
# guarantees and support are strongly adviced to contract a Free Software
Romain Courteaud's avatar
Romain Courteaud committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# 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
30
from Products.ERP5Type import Permissions, PropertySheet
Romain Courteaud's avatar
Romain Courteaud committed
31 32 33
from Products.ERP5Type.XMLObject import XMLObject
from Products.ERP5.Document.Predicate import Predicate
from Products.ERP5.Document.Amount import Amount
34 35 36
from Products.ERP5.MovementGroup import MovementGroupNode
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
from Products.ERP5Type.CopySupport import CopyError, tryMethodCallWithTemporaryPermission
37
from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod
38
from DateTime import DateTime
39
from Acquisition import aq_parent, aq_inner
Romain Courteaud's avatar
Romain Courteaud committed
40

41 42
class CollectError(Exception): pass
class MatrixError(Exception): pass
43
class DuplicatedPropertyDictKeysError(Exception): pass
44

Romain Courteaud's avatar
Romain Courteaud committed
45 46 47
class OrderBuilder(XMLObject, Amount, Predicate):
  """
    Order Builder objects allow to gather multiple Simulation Movements
48
    into a single Delivery.
Romain Courteaud's avatar
Romain Courteaud committed
49 50 51 52

    The initial quantity property of the Delivery Line is calculated by
    summing quantities of related Simulation Movements.

53
    Order Builder objects are provided with a set a parameters to achieve
Romain Courteaud's avatar
Romain Courteaud committed
54 55
    their goal:

56
    A path definition: source, destination, etc. which defines the general
Romain Courteaud's avatar
Romain Courteaud committed
57 58
    kind of movements it applies.

59 60
    simulation_select_method which defines how to query all Simulation
    Movements which meet certain criteria (including the above path path
Romain Courteaud's avatar
Romain Courteaud committed
61 62
    definition).

63
    collect_order_list which defines how to group selected movements
Romain Courteaud's avatar
Romain Courteaud committed
64 65
    according to gathering rules.

66
    delivery_select_method which defines how to select existing Delivery
Romain Courteaud's avatar
Romain Courteaud committed
67 68
    which may eventually be updated with selected simulation movements.

69
    delivery_module, delivery_type and delivery_line_type which define the
Romain Courteaud's avatar
Romain Courteaud committed
70 71
    module and portal types for newly built Deliveries and Delivery Lines.

72
    Order Builders can also be provided with optional parameters to
Romain Courteaud's avatar
Romain Courteaud committed
73
    restrict selection to a given root Applied Rule caused by a single Order
74
    or to Simulation Movements related to a limited set of existing
Romain Courteaud's avatar
Romain Courteaud committed
75 76 77 78 79 80 81 82 83
    Deliveries.
  """

  # CMF Type Definition
  meta_type = 'ERP5 Order Builder'
  portal_type = 'Order Builder'

  # Declarative security
  security = ClassSecurityInfo()
84
  security.declareObjectProtected(Permissions.AccessContentsInformation)
Romain Courteaud's avatar
Romain Courteaud committed
85 86 87 88 89 90 91 92 93 94 95

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.Arrow
                    , PropertySheet.Amount
                    , PropertySheet.Comment
                    , PropertySheet.DeliveryBuilder
                    )
96

97
  security.declarePublic('build')
98
  def build(self, applied_rule_uid=None, movement_relative_url_list=None,
99
            delivery_relative_url_list=None,**kw):
Romain Courteaud's avatar
Romain Courteaud committed
100 101 102 103 104 105 106
    """
      Build deliveries from a list of movements

      Delivery Builders can also be provided with optional parameters to
      restrict selection to a given root Applied Rule caused by a single Order
      or to Simulation Movements related to a limited set of existing
    """
107 108 109 110 111 112 113
    # Parameter initialization
    if movement_relative_url_list is None:
      movement_relative_url_list = []
    if delivery_relative_url_list is None:
      delivery_relative_url_list = []
    # Call a script before building
    self.callBeforeBuildingScript()
Romain Courteaud's avatar
Romain Courteaud committed
114
    # Select
115
    if len(movement_relative_url_list) == 0:
Romain Courteaud's avatar
Romain Courteaud committed
116
      movement_list = self.searchMovementList(
117
                                      applied_rule_uid=applied_rule_uid,**kw)
Romain Courteaud's avatar
Romain Courteaud committed
118
    else:
119
      movement_list = [self.restrictedTraverse(relative_url) for relative_url \
Romain Courteaud's avatar
Romain Courteaud committed
120 121
                       in movement_relative_url_list]
    # Collect
122
    root_group_node = self.collectMovement(movement_list)
Romain Courteaud's avatar
Romain Courteaud committed
123 124
    # Build
    delivery_list = self.buildDeliveryList(
125
                       root_group_node,
Romain Courteaud's avatar
Romain Courteaud committed
126
                       delivery_relative_url_list=delivery_relative_url_list,
127
                       movement_list=movement_list,**kw)
128
    # Call a script after building
129
    self.callAfterBuildingScript(delivery_list, movement_list, **kw)
130
    # XXX Returning the delivery list is probably not necessary
Romain Courteaud's avatar
Romain Courteaud committed
131 132
    return delivery_list

133
  def callBeforeBuildingScript(self):
Romain Courteaud's avatar
Romain Courteaud committed
134
    """
135
      Call a script on the module, for example, to remove some
136
      auto_planned Order.
137 138
      This part can only be done with a script, because user may want
      to keep existing auto_planned Order, and only update lines in
139 140 141 142 143 144 145
      them.
      No activities are used when deleting a object, so, current
      implementation should be OK.
    """
    delivery_module_before_building_script_id = \
        self.getDeliveryModuleBeforeBuildingScriptId()
    if delivery_module_before_building_script_id not in ["", None]:
146
      delivery_module = getattr(self.getPortalObject(), self.getDeliveryModule())
147
      getattr(delivery_module, delivery_module_before_building_script_id)()
Romain Courteaud's avatar
Romain Courteaud committed
148

149
  def searchMovementList(self, *args, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
150
    """
151 152
      Defines how to query all Simulation Movements which meet certain
      criteria (including the above path path definition).
153
      First, select movement matching to criteria define on
154
      DeliveryBuilder.
155
      Then, call script simulation_select_method to restrict
156 157
      movement_list.
    """
158 159 160 161 162
    searchMovementList = UnrestrictedMethod(self._searchMovementList)
    return searchMovementList(*args, **kw)

  def _searchMovementList(self, applied_rule_uid=None,**kw):
    """This method is wrapped by UnrestrictedMethod."""
163
    from Products.ERP5Type.Document import newTempMovement
Romain Courteaud's avatar
Romain Courteaud committed
164
    movement_list = []
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    for attribute, method in [('node_uid', 'getDestinationUid'),
                              ('section_uid', 'getDestinationSectionUid')]:
      if getattr(self, method)() not in ("", None):
        kw[attribute] = getattr(self, method)()
    # We have to check the inventory for each stock movement date.
    # Inventory can be negative in some date, and positive in futur !!
    # This must be done by subclassing OrderBuilder with a new inventory
    # algorithm.
    sql_list = self.portal_simulation.getFutureInventoryList(
                                                   group_by_variation=1,
                                                   group_by_resource=1,
                                                   group_by_node=1,
                                                   group_by_section=0,
                                                   **kw)
    id_count = 0
    for inventory_item in sql_list:
      # XXX FIXME SQL return None inventory...
      # It may be better to return always good values
      if (inventory_item.inventory is not None):
        dumb_movement = inventory_item.getObject()
        # Create temporary movement
186
        movement = newTempMovement(self.getPortalObject(),
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
                                   str(id_count))
        id_count += 1
        movement.edit(
            resource=inventory_item.resource_relative_url,
            variation_category_list=dumb_movement.getVariationCategoryList(),
            destination_value=self.getDestinationValue(),
            destination_section_value=self.getDestinationSectionValue())
        # We can do other test on inventory here
        # XXX It is better if it can be sql parameters
        resource_portal_type = self.getResourcePortalType()
        resource = movement.getResourceValue()
        # FIXME: XXX Those properties are defined on a supply line !!
        # min_flow, max_delay
        min_flow = resource.getMinFlow(0)
        if (resource.getPortalType() == resource_portal_type) and\
           (round(inventory_item.inventory, 5) < min_flow):
          # FIXME XXX getNextNegativeInventoryDate must work
          stop_date = DateTime()+10
#         stop_date = resource.getNextNegativeInventoryDate(
#                               variation_text=movement.getVariationText(),
#                               from_date=DateTime(),
# #                             node_category=node_category,
# #                             section_category=section_category)
#                               node_uid=self.getDestinationUid(),
#                               section_uid=self.getDestinationSectionUid())
          max_delay = resource.getMaxDelay(0)
          movement.edit(
214
            start_date=DateTime(((stop_date-max_delay).Date())),
215
            stop_date=DateTime(stop_date.Date()),
216 217 218 219 220 221
            quantity=min_flow-inventory_item.inventory,
            quantity_unit=resource.getQuantityUnit()
            # XXX FIXME define on a supply line
            # quantity_unit
          )
          movement_list.append(movement)
Romain Courteaud's avatar
Romain Courteaud committed
222 223 224 225
    return movement_list

  def collectMovement(self, movement_list):
    """
226
      group movements in the way we want. Thanks to this method, we are able
Romain Courteaud's avatar
Romain Courteaud committed
227 228
      to retrieve movement classed by order, resource, criterion,....
      movement_list : the list of movement wich we want to group
229
      class_list : the list of classes used to group movements. The order
Romain Courteaud's avatar
Romain Courteaud committed
230 231 232 233 234
                   of the list is important and determines by what we will
                   group movement first
                   Typically, check_list is :
                   [DateMovementGroup,PathMovementGroup,...]
    """
235 236
    movement_group_list = self.getMovementGroupList()
    last_line_movement_group = self.getDeliveryMovementGroupList()[-1]
237
    separate_method_name_list = self.getDeliveryCellSeparateOrderList([])
238
    root_group_node = MovementGroupNode(
239 240 241
      separate_method_name_list=separate_method_name_list,
      movement_group_list=movement_group_list,
      last_line_movement_group=last_line_movement_group)
242 243
    root_group_node.append(movement_list)
    return root_group_node
Romain Courteaud's avatar
Romain Courteaud committed
244

245
  def _test(self, instance, movement_group_node_list,
246 247 248
                    divergence_list):
    result = True
    new_property_dict = {}
249 250
    for movement_group_node in movement_group_node_list:
      tmp_result, tmp_property_dict = movement_group_node.test(
251
        instance, divergence_list)
252
      if not tmp_result:
253 254 255 256
        result = tmp_result
      new_property_dict.update(tmp_property_dict)
    return result, new_property_dict

257
  def _findUpdatableObject(self, instance_list, movement_group_node_list,
258 259 260 261
                           divergence_list):
    instance = None
    property_dict = {}
    if not len(instance_list):
262
      for movement_group_node in movement_group_node_list:
263 264 265 266 267
        for k,v in movement_group_node.getGroupEditDict().iteritems():
          if k in property_dict:
            raise DuplicatedPropertyDictKeysError(k)
          else:
            property_dict[k] = v
268
    else:
269 270
      # we want to check the original delivery first.
      # so sort instance_list by that current is exists or not.
271
      try:
272 273 274 275 276 277 278
        current = movement_group_node_list[-1].getMovementList()[0].getDeliveryValue()
        portal = self.getPortalObject()
        while current != portal:
          if current in instance_list:
            instance_list.sort(key=lambda x: x != current and 1 or 0)
            break
          current = current.getParentValue()
279
      except AttributeError:
280
        pass
281
      for instance_to_update in instance_list:
282
        result, property_dict = self._test(
283
          instance_to_update, movement_group_node_list, divergence_list)
284 285
        if result == True:
          instance = instance_to_update
Romain Courteaud's avatar
Romain Courteaud committed
286
          break
287
    return instance, property_dict
Romain Courteaud's avatar
Romain Courteaud committed
288

289
  def buildDeliveryList(self, *args, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
290 291 292
    """
      Build deliveries from a list of movements
    """
293 294 295
    buildDeliveryList = UnrestrictedMethod(self._buildDeliveryList)
    return buildDeliveryList(*args, **kw)

296
  def _buildDeliveryList(self, movement_group_node, delivery_relative_url_list=None,
297 298
                         movement_list=None,**kw):
    """This method is wrapped by UnrestrictedMethod."""
299 300 301
    # Parameter initialization
    if delivery_relative_url_list is None:
      delivery_relative_url_list = []
Jérome Perrin's avatar
Jérome Perrin committed
302 303
    if movement_list is None:
      movement_list = []
Romain Courteaud's avatar
Romain Courteaud committed
304
    # Module where we can create new deliveries
305 306 307
    portal = self.getPortalObject()
    delivery_module = getattr(portal, self.getDeliveryModule())
    delivery_to_update_list = [portal.restrictedTraverse(relative_url) for \
Romain Courteaud's avatar
Romain Courteaud committed
308 309 310 311
                               relative_url in delivery_relative_url_list]
    # Deliveries we are trying to update
    delivery_select_method_id = self.getDeliverySelectMethodId()
    if delivery_select_method_id not in ["", None]:
312
      to_update_delivery_sql_list = getattr(self, delivery_select_method_id) \
Romain Courteaud's avatar
Romain Courteaud committed
313
                                      (movement_list=movement_list)
314 315
      delivery_to_update_list.extend([sql_delivery.getObject() \
                                     for sql_delivery \
Romain Courteaud's avatar
Romain Courteaud committed
316
                                     in to_update_delivery_sql_list])
317 318 319
    # We do not want to update the same object more than twice in one
    # _deliveryGroupProcessing().
    self._resetUpdated()
320
    delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
321
                          delivery_module,
322
                          movement_group_node,
323
                          self.getDeliveryMovementGroupList(),
324 325
                          delivery_to_update_list=delivery_to_update_list,
                          **kw)
Romain Courteaud's avatar
Romain Courteaud committed
326 327
    return delivery_list

328 329 330 331 332
  def _processDeliveryGroup(self, delivery_module, movement_group_node,
                            collect_order_list, movement_group_node_list=None,
                            delivery_to_update_list=None,
                            divergence_list=None,
                            activate_kw=None, force_update=0, **kw):
333 334 335
    """
      Build delivery from a list of movement
    """
336 337
    if movement_group_node_list is None:
      movement_group_node_list = []
338 339 340
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
341
    movement_group_node_list = movement_group_node_list + [movement_group_node]
342 343 344
    # Parameter initialization
    if delivery_to_update_list is None:
      delivery_to_update_list = []
Romain Courteaud's avatar
Romain Courteaud committed
345
    delivery_list = []
346 347

    if len(collect_order_list):
Romain Courteaud's avatar
Romain Courteaud committed
348
      # Get sorted movement for each delivery
349 350
      for grouped_node in movement_group_node.getGroupList():
        new_delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
351
                              delivery_module,
352
                              grouped_node,
Romain Courteaud's avatar
Romain Courteaud committed
353
                              collect_order_list[1:],
354
                              movement_group_node_list=movement_group_node_list,
355
                              delivery_to_update_list=delivery_to_update_list,
356 357
                              divergence_list=divergence_list,
                              activate_kw=activate_kw,
358
                              force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
359
        delivery_list.extend(new_delivery_list)
360
        force_update = 0
Romain Courteaud's avatar
Romain Courteaud committed
361
    else:
362
      # Test if we can update a existing delivery, or if we need to create
Romain Courteaud's avatar
Romain Courteaud committed
363
      # a new one
364 365 366 367 368
      delivery_to_update_list = [
        x for x in delivery_to_update_list \
        if x.getPortalType() == self.getDeliveryPortalType() and \
        not self._isUpdated(x, 'delivery')]
      delivery, property_dict = self._findUpdatableObject(
369
        delivery_to_update_list, movement_group_node_list,
370 371 372 373 374 375 376
        divergence_list)

      # if all deliveries are rejected in case of update, we update the
      # first one.
      if force_update and delivery is None and len(delivery_to_update_list):
        delivery = delivery_to_update_list[0]

Romain Courteaud's avatar
Romain Courteaud committed
377
      if delivery is None:
Romain Courteaud's avatar
Romain Courteaud committed
378
        # Create delivery
379
        try:
380
          old_delivery = self._searchUpByPortalType(
381
            movement_group_node.getMovementList()[0].getDeliveryValue(),
382
            self.getDeliveryPortalType())
383 384 385 386 387 388 389 390 391
        except AttributeError:
          old_delivery = None
        if old_delivery is None:
          # from scratch
          new_delivery_id = str(delivery_module.generateNewId())
          delivery = delivery_module.newContent(
            portal_type=self.getDeliveryPortalType(),
            id=new_delivery_id,
            created_by_builder=1,
392
            activate_kw=activate_kw)
393 394 395 396 397 398 399 400 401 402
        else:
          # from duplicated original delivery
          cp = tryMethodCallWithTemporaryPermission(
            delivery_module, 'Copy or Move',
            lambda parent, *ids:
            parent._duplicate(parent.manage_copyObjects(ids=ids))[0],
            (delivery_module, old_delivery.getId()), {}, CopyError)
          delivery = delivery_module[cp['new_id']]
          # delete non-split movements
          keep_id_list = [y.getDeliveryValue().getId() for y in \
403
                          movement_group_node.getMovementList()]
404 405 406 407 408 409
          delete_id_list = [x.getId() for x in delivery.contentValues() \
                           if x.getId() not in keep_id_list]
          delivery.deleteContent(delete_id_list)
      # Put properties on delivery
      self._setUpdated(delivery, 'delivery')
      if property_dict:
Romain Courteaud's avatar
Romain Courteaud committed
410 411 412
        delivery.edit(**property_dict)

      # Then, create delivery line
413 414
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryLineGroup(
Romain Courteaud's avatar
Romain Courteaud committed
415
                                delivery,
416
                                grouped_node,
417 418 419 420
                                self.getDeliveryLineMovementGroupList()[1:],
                                divergence_list=divergence_list,
                                activate_kw=activate_kw,
                                force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
421 422
      delivery_list.append(delivery)
    return delivery_list
423

424 425 426 427
  def _processDeliveryLineGroup(self, delivery, movement_group_node,
                                collect_order_list, movement_group_node_list=None,
                                divergence_list=None,
                                activate_kw=None, force_update=0, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
428 429 430
    """
      Build delivery line from a list of movement on a delivery
    """
431 432
    if movement_group_node_list is None:
      movement_group_node_list = []
433 434 435
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
436
    movement_group_node_list = movement_group_node_list + [movement_group_node]
437

438
    if len(collect_order_list) and not movement_group_node.getCurrentMovementGroup().isBranch():
Romain Courteaud's avatar
Romain Courteaud committed
439
      # Get sorted movement for each delivery line
440 441 442 443 444 445
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryLineGroup(
          delivery,
          grouped_node,
          collect_order_list[1:],
          movement_group_node_list=movement_group_node_list,
446
          divergence_list=divergence_list,
447 448
          activate_kw=activate_kw,
          force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
449 450 451
    else:
      # Test if we can update an existing line, or if we need to create a new
      # one
452 453 454 455
      delivery_line_to_update_list = [x for x in delivery.contentValues(
        portal_type=self.getDeliveryLinePortalType()) if \
                                      not self._isUpdated(x, 'line')]
      delivery_line, property_dict = self._findUpdatableObject(
456
        delivery_line_to_update_list, movement_group_node_list,
457 458 459 460
        divergence_list)
      if delivery_line is not None:
        update_existing_line = 1
      else:
Romain Courteaud's avatar
Romain Courteaud committed
461
        # Create delivery line
462 463 464
        update_existing_line = 0
        try:
          old_delivery_line = self._searchUpByPortalType(
465
            movement_group_node.getMovementList()[0].getDeliveryValue(),
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
            self.getDeliveryLinePortalType())
        except AttributeError:
          old_delivery_line = None
        if old_delivery_line is None:
          # from scratch
          new_delivery_line_id = str(delivery.generateNewId())
          delivery_line = delivery.newContent(
            portal_type=self.getDeliveryLinePortalType(),
            id=new_delivery_line_id,
            variation_category_list=[],
            activate_kw=activate_kw)
        else:
          # from duplicated original line
          cp = tryMethodCallWithTemporaryPermission(
            delivery, 'Copy or Move',
            lambda parent, *ids:
            parent._duplicate(parent.manage_copyObjects(ids=ids))[0],
            (delivery, old_delivery_line.getId()), {}, CopyError)
          delivery_line = delivery[cp['new_id']]
485 486
          # reset variation category list
          delivery_line.setVariationCategoryList([])
487 488
          # delete non-split movements
          keep_id_list = [y.getDeliveryValue().getId() for y in \
489
                          movement_group_node.getMovementList()]
490 491 492 493 494 495
          delete_id_list = [x.getId() for x in delivery_line.contentValues() \
                           if x.getId() not in keep_id_list]
          delivery_line.deleteContent(delete_id_list)
      # Put properties on delivery line
      self._setUpdated(delivery_line, 'line')
      if property_dict:
Romain Courteaud's avatar
Romain Courteaud committed
496
        delivery_line.edit(**property_dict)
497

498 499 500 501 502 503 504 505 506 507 508 509
      if movement_group_node.getCurrentMovementGroup().isBranch():
        for grouped_node in movement_group_node.getGroupList():
          self._processDeliveryLineGroup(
            delivery_line,
            grouped_node,
            collect_order_list[1:],
            movement_group_node_list=movement_group_node_list,
            divergence_list=divergence_list,
            activate_kw=activate_kw,
            force_update=force_update)
        return

Romain Courteaud's avatar
Romain Courteaud committed
510
      # Update variation category list on line
511 512 513
      variation_category_dict = dict([(variation_category, True) for
                                      variation_category in
                                      delivery_line.getVariationCategoryList()])
514
      for movement in movement_group_node.getMovementList():
515 516 517 518
        for category in movement.getVariationCategoryList():
          variation_category_dict[category] = True
      variation_category_list = sorted(variation_category_dict.keys())
      delivery_line.setVariationCategoryList(variation_category_list)
Romain Courteaud's avatar
Romain Courteaud committed
519 520
      # Then, create delivery movement (delivery cell or complete delivery
      # line)
521
      grouped_node_list = movement_group_node.getGroupList()
522
      # If no group is defined for cell, we need to continue, in order to
523
      # save the quantity value
524 525 526
      if len(grouped_node_list):
        for grouped_node in grouped_node_list:
          self._processDeliveryCellGroup(
Romain Courteaud's avatar
Romain Courteaud committed
527
                                    delivery_line,
528
                                    grouped_node,
529
                                    self.getDeliveryCellMovementGroupList()[1:],
530
                                    update_existing_line=update_existing_line,
531 532 533
                                    divergence_list=divergence_list,
                                    activate_kw=activate_kw,
                                    force_update=force_update)
534
      else:
535
        self._processDeliveryCellGroup(
536
                                  delivery_line,
537
                                  movement_group_node,
538
                                  [],
539
                                  update_existing_line=update_existing_line,
540 541 542
                                  divergence_list=divergence_list,
                                  activate_kw=activate_kw,
                                  force_update=force_update)
543

Romain Courteaud's avatar
Romain Courteaud committed
544

545 546 547 548 549
  def _processDeliveryCellGroup(self, delivery_line, movement_group_node,
                                collect_order_list, movement_group_node_list=None,
                                update_existing_line=0,
                                divergence_list=None,
                                activate_kw=None, force_update=0):
Romain Courteaud's avatar
Romain Courteaud committed
550 551 552 553
    """
      Build delivery cell from a list of movement on a delivery line
      or complete delivery line
    """
554 555
    if movement_group_node_list is None:
      movement_group_node_list = []
556 557 558
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
559
    movement_group_node_list = movement_group_node_list + [movement_group_node]
560 561

    if len(collect_order_list):
Romain Courteaud's avatar
Romain Courteaud committed
562
      # Get sorted movement for each delivery line
563 564
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryCellGroup(
565
          delivery_line,
566
          grouped_node,
567
          collect_order_list[1:],
568
          movement_group_node_list=movement_group_node_list,
569 570 571 572
          update_existing_line=update_existing_line,
          divergence_list=divergence_list,
          activate_kw=activate_kw,
          force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
573
    else:
574
      movement_list = movement_group_node.getMovementList()
Romain Courteaud's avatar
Romain Courteaud committed
575
      if len(movement_list) != 1:
576
        raise CollectError, "DeliveryBuilder: %s unable to distinct those\
Romain Courteaud's avatar
Romain Courteaud committed
577 578 579 580 581 582
              movements: %s" % (self.getId(), str(movement_list))
      else:
        # XXX Hardcoded value
        base_id = 'movement'
        object_to_update = None
        # We need to initialize the cell
583
        update_existing_movement = 0
Romain Courteaud's avatar
Romain Courteaud committed
584 585 586 587 588
        movement = movement_list[0]
        # decide if we create a cell or if we update the line
        # Decision can only be made with line matrix range:
        # because matrix range can be empty even if line variation category
        # list is not empty
589
        property_dict = {}
590
        if len(delivery_line.getCellKeyList(base_id=base_id)) == 0:
Romain Courteaud's avatar
Romain Courteaud committed
591
          # update line
592 593 594 595 596
          if update_existing_line == 1:
            if self._isUpdated(delivery_line, 'cell'):
              object_to_update_list = []
            else:
              object_to_update_list = [delivery_line]
597 598 599
          else:
            object_to_update_list = []
          object_to_update, property_dict = self._findUpdatableObject(
600
            object_to_update_list, movement_group_node_list,
601
            divergence_list)
602 603 604 605
          if object_to_update is not None:
            update_existing_movement = 1
          else:
            object_to_update = delivery_line
Romain Courteaud's avatar
Romain Courteaud committed
606
        else:
607 608 609 610 611
          object_to_update_list = [
            delivery_line.getCell(base_id=base_id, *cell_key) for cell_key in \
            delivery_line.getCellKeyList(base_id=base_id) \
            if delivery_line.hasCell(base_id=base_id, *cell_key)]
          object_to_update, property_dict = self._findUpdatableObject(
612
            object_to_update_list, movement_group_node_list,
613 614 615 616 617 618 619
            divergence_list)
          if object_to_update is not None:
            # We update a existing cell
            # delivery_ratio of new related movement to this cell
            # must be updated to 0.
            update_existing_movement = 1

Romain Courteaud's avatar
Romain Courteaud committed
620 621
        if object_to_update is None:
          # create a new cell
622
          cell_key = movement.getVariationCategoryList(
623
              omit_optional_variation=1)
Romain Courteaud's avatar
Romain Courteaud committed
624
          if not delivery_line.hasCell(base_id=base_id, *cell_key):
625
            try:
626
              old_cell = movement_group_node.getMovementList()[0].getDeliveryValue()
627 628 629 630 631
            except AttributeError:
              old_cell = None
            if old_cell is None:
              # from scratch
              cell = delivery_line.newCell(base_id=base_id, \
632
                       portal_type=self.getDeliveryCellPortalType(),
633
                       activate_kw=activate_kw,*cell_key)
634 635 636 637 638 639 640 641 642
            else:
              # from duplicated original line
              cp = tryMethodCallWithTemporaryPermission(
                delivery_line, 'Copy or Move',
                lambda parent, *ids:
                parent._duplicate(parent.manage_copyObjects(ids=ids))[0],
                (delivery_line, old_cell.getId()), {}, CopyError)
              cell = delivery_line[cp['new_id']]

643 644
            vcl = movement.getVariationCategoryList()
            cell._edit(category_list=vcl,
Romain Courteaud's avatar
Romain Courteaud committed
645 646
                      # XXX hardcoded value
                      mapped_value_property_list=['quantity', 'price'],
647
                      membership_criterion_category_list=vcl,
Romain Courteaud's avatar
Romain Courteaud committed
648 649 650 651
                      membership_criterion_base_category_list=movement.\
                                             getVariationBaseCategoryList())
            object_to_update = cell
          else:
652
            raise MatrixError, 'Cell: %s already exists on %s' % \
Romain Courteaud's avatar
Romain Courteaud committed
653
                  (str(cell_key), str(delivery_line))
654
        self._setUpdated(object_to_update, 'cell')
Romain Courteaud's avatar
Romain Courteaud committed
655 656
        self._setDeliveryMovementProperties(
                            object_to_update, movement, property_dict,
657
                            update_existing_movement=update_existing_movement,
658
                            force_update=force_update, activate_kw=activate_kw)
Romain Courteaud's avatar
Romain Courteaud committed
659 660 661

  def _setDeliveryMovementProperties(self, delivery_movement,
                                     simulation_movement, property_dict,
662
                                     update_existing_movement=0,
663
                                     force_update=0, activate_kw=None):
Romain Courteaud's avatar
Romain Courteaud committed
664 665 666 667
    """
      Initialize or update delivery movement properties.
      Set delivery ratio on simulation movement.
    """
668
    if update_existing_movement == 1 and not force_update:
Romain Courteaud's avatar
Romain Courteaud committed
669 670 671 672 673 674 675 676 677 678 679 680 681
      # Important.
      # Attributes of object_to_update must not be modified here.
      # Because we can not change values that user modified.
      # Delivery will probably diverge now, but this is not the job of
      # DeliveryBuilder to resolve such problem.
      # Use Solver instead.
      simulation_movement.edit(delivery_ratio=0)
    else:
      # Now, only 1 movement is possible, so copy from this movement
      # XXX hardcoded value
      property_dict['quantity'] = simulation_movement.getQuantity()
      property_dict['price'] = simulation_movement.getPrice()
      # Update properties on object (quantity, price...)
682
      delivery_movement._edit(force_update=1, **property_dict)
Romain Courteaud's avatar
Romain Courteaud committed
683
      simulation_movement.edit(delivery_ratio=1)
684

685
  def callAfterBuildingScript(self, *args, **kw):
686
    """
687 688 689 690 691 692 693 694 695
      Call script on each delivery built.
    """
    callAfterBuildingScript = UnrestrictedMethod(self._callAfterBuildingScript)
    return callAfterBuildingScript(*args, **kw)

  def _callAfterBuildingScript(self, delivery_list, movement_list=None, **kw):
    """
      Call script on each delivery built.
      This method is wrapped by UnrestrictedMethod.
696
    """
697 698
    if not len(delivery_list):
      return
Jérome Perrin's avatar
Jérome Perrin committed
699 700 701
    # Parameter initialization
    if movement_list is None:
      movement_list = []
702 703
    delivery_after_generation_script_id = \
                              self.getDeliveryAfterGenerationScriptId()
704 705
    related_simulation_movement_path_list = \
                              [x.getPath() for x in movement_list]
706 707
    if delivery_after_generation_script_id not in ["", None]:
      for delivery in delivery_list:
708
        script = getattr(delivery, delivery_after_generation_script_id)
709 710 711 712 713
        # BBB: Only Python Scripts were used in the past, and they might not
        # accept an arbitrary argument. So to keep compatibility,
        # check if it can take the new parameter safely, only when
        # the callable object is a Python Script.
        safe_to_pass_parameter = True
714 715 716
        meta_type = getattr(script, 'meta_type', None)
        if meta_type == 'Script (Python)':
          # check if the script accepts related_simulation_movement_path_list
717
          safe_to_pass_parameter = False
718 719
          for param in script.params().split(','):
            param = param.split('=', 1)[0].strip()
720 721 722
            if param == 'related_simulation_movement_path_list' \
                    or param.startswith('**'):
              safe_to_pass_parameter = True
723
              break
724 725

        if safe_to_pass_parameter:
726
          script(related_simulation_movement_path_list=related_simulation_movement_path_list)
727 728
        else:
          script()
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 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789

  security.declareProtected(Permissions.AccessContentsInformation,
                           'getMovementGroupList')
  def getMovementGroupList(self, portal_type=None, collect_order_group=None,
                            **kw):
    """
    Return a list of movement groups sorted by collect order group and index.
    """
    category_index_dict = {}
    for i in self.getPortalObject().portal_categories.collect_order_group.contentValues():
      category_index_dict[i.getId()] = i.getIntIndex()

    def sort_movement_group(a, b):
        return cmp(category_index_dict.get(a.getCollectOrderGroup()),
                   category_index_dict.get(b.getCollectOrderGroup())) or \
               cmp(a.getIntIndex(), b.getIntIndex())
    if portal_type is None:
      portal_type = self.getPortalMovementGroupTypeList()
    movement_group_list = [x for x in self.contentValues(filter={'portal_type': portal_type}) \
                           if collect_order_group is None or collect_order_group == x.getCollectOrderGroup()]
    return sorted(movement_group_list, sort_movement_group)

  # XXX category name is hardcoded.
  def getDeliveryMovementGroupList(self, **kw):
    return self.getMovementGroupList(collect_order_group='delivery')

  # XXX category name is hardcoded.
  def getDeliveryLineMovementGroupList(self, **kw):
    return self.getMovementGroupList(collect_order_group='line')

  # XXX category name is hardcoded.
  def getDeliveryCellMovementGroupList(self, **kw):
    return self.getMovementGroupList(collect_order_group='cell')

  def _searchUpByPortalType(self, obj, portal_type):
    limit_portal_type = self.getPortalObject().getPortalType()
    while obj is not None:
      obj_portal_type = obj.getPortalType()
      if obj_portal_type == portal_type:
        break
      elif obj_portal_type == limit_portal_type:
        obj = None
        break
      else:
        obj = aq_parent(aq_inner(obj))
    return obj

  def _isUpdated(self, obj, level):
    tv = getTransactionalVariable(self)
    return level in tv['builder_processed_list'].get(obj, [])

  def _setUpdated(self, obj, level):
    tv = getTransactionalVariable(self)
    if tv.get('builder_processed_list', None) is None:
      self._resetUpdated()
    tv['builder_processed_list'][obj] = \
       tv['builder_processed_list'].get(obj, []) + [level]

  def _resetUpdated(self):
    tv = getTransactionalVariable(self)
    tv['builder_processed_list'] = {}
790 791

  # for backward compatibilities.
792
  _deliveryGroupProcessing = _processDeliveryGroup
793 794
  _deliveryLineGroupProcessing = _processDeliveryLineGroup
  _deliveryCellGroupProcessing = _processDeliveryCellGroup