OrderBuilder.py 34.3 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 43
class CollectError(Exception): pass
class MatrixError(Exception): pass

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

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

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

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

58 59
    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
60 61
    definition).

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

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

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

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

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

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

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

96
  security.declarePublic('build')
97
  def build(self, applied_rule_uid=None, movement_relative_url_list=None,
98
            delivery_relative_url_list=None,**kw):
Romain Courteaud's avatar
Romain Courteaud committed
99 100 101 102 103 104 105
    """
      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
    """
106 107 108 109 110 111 112
    # 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
113
    # Select
114
    if len(movement_relative_url_list) == 0:
Romain Courteaud's avatar
Romain Courteaud committed
115
      movement_list = self.searchMovementList(
116
                                      applied_rule_uid=applied_rule_uid,**kw)
Romain Courteaud's avatar
Romain Courteaud committed
117
    else:
118
      movement_list = [self.restrictedTraverse(relative_url) for relative_url \
Romain Courteaud's avatar
Romain Courteaud committed
119 120
                       in movement_relative_url_list]
    # Collect
121
    root_group_node = self.collectMovement(movement_list)
Romain Courteaud's avatar
Romain Courteaud committed
122 123
    # Build
    delivery_list = self.buildDeliveryList(
124
                       root_group_node,
Romain Courteaud's avatar
Romain Courteaud committed
125
                       delivery_relative_url_list=delivery_relative_url_list,
126
                       movement_list=movement_list,**kw)
127
    # Call a script after building
128
    self.callAfterBuildingScript(delivery_list, movement_list, **kw)
129
    # XXX Returning the delivery list is probably not necessary
Romain Courteaud's avatar
Romain Courteaud committed
130 131
    return delivery_list

132
  def callBeforeBuildingScript(self):
Romain Courteaud's avatar
Romain Courteaud committed
133
    """
134
      Call a script on the module, for example, to remove some
135
      auto_planned Order.
136 137
      This part can only be done with a script, because user may want
      to keep existing auto_planned Order, and only update lines in
138 139 140 141 142 143 144
      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]:
145
      delivery_module = getattr(self.getPortalObject(), self.getDeliveryModule())
146
      getattr(delivery_module, delivery_module_before_building_script_id)()
Romain Courteaud's avatar
Romain Courteaud committed
147

148
  def searchMovementList(self, applied_rule_uid=None,**kw):
Romain Courteaud's avatar
Romain Courteaud committed
149
    """
150 151
      Defines how to query all Simulation Movements which meet certain
      criteria (including the above path path definition).
152
      First, select movement matching to criteria define on
153
      DeliveryBuilder.
154
      Then, call script simulation_select_method to restrict
155 156 157
      movement_list.
    """
    from Products.ERP5Type.Document import newTempMovement
Romain Courteaud's avatar
Romain Courteaud committed
158
    movement_list = []
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    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
180
        movement = newTempMovement(self.getPortalObject(),
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
                                   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(
208
            start_date=DateTime(((stop_date-max_delay).Date())),
209
            stop_date=DateTime(stop_date.Date()),
210 211 212 213 214 215
            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
216 217 218 219
    return movement_list

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

239
  def _test(self, instance, movement_group_node_list,
240 241 242
                    divergence_list):
    result = True
    new_property_dict = {}
243 244
    for movement_group_node in movement_group_node_list:
      tmp_result, tmp_property_dict = movement_group_node.test(
245
        instance, divergence_list)
246
      if not tmp_result:
247 248 249 250
        result = tmp_result
      new_property_dict.update(tmp_property_dict)
    return result, new_property_dict

251
  def _findUpdatableObject(self, instance_list, movement_group_node_list,
252 253 254 255
                           divergence_list):
    instance = None
    property_dict = {}
    if not len(instance_list):
256 257
      for movement_group_node in movement_group_node_list:
        property_dict.update(movement_group_node.getGroupEditDict())
258
    else:
259 260
      # we want to check the original delivery first.
      # so sort instance_list by that current is exists or not.
261
      try:
262 263 264 265 266 267 268
        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()
269
      except AttributeError:
270
        pass
271
      for instance_to_update in instance_list:
272
        result, property_dict = self._test(
273
          instance_to_update, movement_group_node_list, divergence_list)
274 275
        if result == True:
          instance = instance_to_update
Romain Courteaud's avatar
Romain Courteaud committed
276
          break
277
    return instance, property_dict
Romain Courteaud's avatar
Romain Courteaud committed
278

279
  def buildDeliveryList(self, *args, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
280 281 282
    """
      Build deliveries from a list of movements
    """
283 284 285
    buildDeliveryList = UnrestrictedMethod(self._buildDeliveryList)
    return buildDeliveryList(*args, **kw)

286
  def _buildDeliveryList(self, movement_group_node, delivery_relative_url_list=None,
287 288
                         movement_list=None,**kw):
    """This method is wrapped by UnrestrictedMethod."""
289 290 291
    # Parameter initialization
    if delivery_relative_url_list is None:
      delivery_relative_url_list = []
Jérome Perrin's avatar
Jérome Perrin committed
292 293
    if movement_list is None:
      movement_list = []
Romain Courteaud's avatar
Romain Courteaud committed
294
    # Module where we can create new deliveries
295 296 297
    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
298 299 300 301
                               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]:
302
      to_update_delivery_sql_list = getattr(self, delivery_select_method_id) \
Romain Courteaud's avatar
Romain Courteaud committed
303
                                      (movement_list=movement_list)
304 305
      delivery_to_update_list.extend([sql_delivery.getObject() \
                                     for sql_delivery \
Romain Courteaud's avatar
Romain Courteaud committed
306
                                     in to_update_delivery_sql_list])
307 308 309
    # We do not want to update the same object more than twice in one
    # _deliveryGroupProcessing().
    self._resetUpdated()
310
    delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
311
                          delivery_module,
312
                          movement_group_node,
313
                          self.getDeliveryMovementGroupList(),
314 315
                          delivery_to_update_list=delivery_to_update_list,
                          **kw)
Romain Courteaud's avatar
Romain Courteaud committed
316 317
    return delivery_list

318 319 320 321 322
  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):
323 324 325
    """
      Build delivery from a list of movement
    """
326 327
    if movement_group_node_list is None:
      movement_group_node_list = []
328 329 330
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
331
    movement_group_node_list = movement_group_node_list + [movement_group_node]
332 333 334
    # Parameter initialization
    if delivery_to_update_list is None:
      delivery_to_update_list = []
Romain Courteaud's avatar
Romain Courteaud committed
335
    delivery_list = []
336 337

    if len(collect_order_list):
Romain Courteaud's avatar
Romain Courteaud committed
338
      # Get sorted movement for each delivery
339 340
      for grouped_node in movement_group_node.getGroupList():
        new_delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
341
                              delivery_module,
342
                              grouped_node,
Romain Courteaud's avatar
Romain Courteaud committed
343
                              collect_order_list[1:],
344
                              movement_group_node_list=movement_group_node_list,
345
                              delivery_to_update_list=delivery_to_update_list,
346 347
                              divergence_list=divergence_list,
                              activate_kw=activate_kw,
348
                              force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
349
        delivery_list.extend(new_delivery_list)
350
        force_update = 0
Romain Courteaud's avatar
Romain Courteaud committed
351
    else:
352
      # Test if we can update a existing delivery, or if we need to create
Romain Courteaud's avatar
Romain Courteaud committed
353
      # a new one
354 355 356 357 358
      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(
359
        delivery_to_update_list, movement_group_node_list,
360 361 362 363 364 365 366
        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
367
      if delivery is None:
Romain Courteaud's avatar
Romain Courteaud committed
368
        # Create delivery
369
        try:
370
          old_delivery = self._searchUpByPortalType(
371
            movement_group_node.getMovementList()[0].getDeliveryValue(),
372
            self.getDeliveryPortalType())
373 374 375 376 377 378 379 380 381
        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,
382
            activate_kw=activate_kw)
383 384 385 386 387 388 389 390 391 392
        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 \
393
                          movement_group_node.getMovementList()]
394 395 396 397 398 399
          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
400 401 402
        delivery.edit(**property_dict)

      # Then, create delivery line
403 404
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryLineGroup(
Romain Courteaud's avatar
Romain Courteaud committed
405
                                delivery,
406
                                grouped_node,
407 408 409 410
                                self.getDeliveryLineMovementGroupList()[1:],
                                divergence_list=divergence_list,
                                activate_kw=activate_kw,
                                force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
411 412
      delivery_list.append(delivery)
    return delivery_list
413

414 415 416 417
  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
418 419 420
    """
      Build delivery line from a list of movement on a delivery
    """
421 422
    if movement_group_node_list is None:
      movement_group_node_list = []
423 424 425
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
426
    movement_group_node_list = movement_group_node_list + [movement_group_node]
427

428
    if len(collect_order_list) and not movement_group_node.getCurrentMovementGroup().isBranch():
Romain Courteaud's avatar
Romain Courteaud committed
429
      # Get sorted movement for each delivery line
430 431 432 433 434 435
      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,
436
          divergence_list=divergence_list,
437 438
          activate_kw=activate_kw,
          force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
439 440 441
    else:
      # Test if we can update an existing line, or if we need to create a new
      # one
442 443 444 445
      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(
446
        delivery_line_to_update_list, movement_group_node_list,
447 448 449 450
        divergence_list)
      if delivery_line is not None:
        update_existing_line = 1
      else:
Romain Courteaud's avatar
Romain Courteaud committed
451
        # Create delivery line
452 453 454
        update_existing_line = 0
        try:
          old_delivery_line = self._searchUpByPortalType(
455
            movement_group_node.getMovementList()[0].getDeliveryValue(),
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
            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']]
475 476
          # reset variation category list
          delivery_line.setVariationCategoryList([])
477 478
          # delete non-split movements
          keep_id_list = [y.getDeliveryValue().getId() for y in \
479
                          movement_group_node.getMovementList()]
480 481 482 483 484 485
          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
486
        delivery_line.edit(**property_dict)
487

488 489 490 491 492 493 494 495 496 497 498 499
      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
500
      # Update variation category list on line
501 502 503
      variation_category_dict = dict([(variation_category, True) for
                                      variation_category in
                                      delivery_line.getVariationCategoryList()])
504
      for movement in movement_group_node.getMovementList():
505 506 507 508
        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
509 510
      # Then, create delivery movement (delivery cell or complete delivery
      # line)
511
      grouped_node_list = movement_group_node.getGroupList()
512
      # If no group is defined for cell, we need to continue, in order to
513
      # save the quantity value
514 515 516
      if len(grouped_node_list):
        for grouped_node in grouped_node_list:
          self._processDeliveryCellGroup(
Romain Courteaud's avatar
Romain Courteaud committed
517
                                    delivery_line,
518
                                    grouped_node,
519
                                    self.getDeliveryCellMovementGroupList()[1:],
520
                                    update_existing_line=update_existing_line,
521 522 523
                                    divergence_list=divergence_list,
                                    activate_kw=activate_kw,
                                    force_update=force_update)
524
      else:
525
        self._processDeliveryCellGroup(
526
                                  delivery_line,
527
                                  movement_group_node,
528
                                  [],
529
                                  update_existing_line=update_existing_line,
530 531 532
                                  divergence_list=divergence_list,
                                  activate_kw=activate_kw,
                                  force_update=force_update)
533

Romain Courteaud's avatar
Romain Courteaud committed
534

535 536 537 538 539
  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
540 541 542 543
    """
      Build delivery cell from a list of movement on a delivery line
      or complete delivery line
    """
544 545
    if movement_group_node_list is None:
      movement_group_node_list = []
546 547 548
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
549
    movement_group_node_list = movement_group_node_list + [movement_group_node]
550 551

    if len(collect_order_list):
Romain Courteaud's avatar
Romain Courteaud committed
552
      # Get sorted movement for each delivery line
553 554
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryCellGroup(
555
          delivery_line,
556
          grouped_node,
557
          collect_order_list[1:],
558
          movement_group_node_list=movement_group_node_list,
559 560 561 562
          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
563
    else:
564
      movement_list = movement_group_node.getMovementList()
Romain Courteaud's avatar
Romain Courteaud committed
565
      if len(movement_list) != 1:
566
        raise CollectError, "DeliveryBuilder: %s unable to distinct those\
Romain Courteaud's avatar
Romain Courteaud committed
567 568 569 570 571 572
              movements: %s" % (self.getId(), str(movement_list))
      else:
        # XXX Hardcoded value
        base_id = 'movement'
        object_to_update = None
        # We need to initialize the cell
573
        update_existing_movement = 0
Romain Courteaud's avatar
Romain Courteaud committed
574 575 576 577 578
        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
579
        property_dict = {}
580
        if len(delivery_line.getCellKeyList(base_id=base_id)) == 0:
Romain Courteaud's avatar
Romain Courteaud committed
581
          # update line
582 583 584 585 586
          if update_existing_line == 1:
            if self._isUpdated(delivery_line, 'cell'):
              object_to_update_list = []
            else:
              object_to_update_list = [delivery_line]
587 588 589
          else:
            object_to_update_list = []
          object_to_update, property_dict = self._findUpdatableObject(
590
            object_to_update_list, movement_group_node_list,
591
            divergence_list)
592 593 594 595
          if object_to_update is not None:
            update_existing_movement = 1
          else:
            object_to_update = delivery_line
Romain Courteaud's avatar
Romain Courteaud committed
596
        else:
597 598 599 600 601
          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(
602
            object_to_update_list, movement_group_node_list,
603 604 605 606 607 608 609
            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
610 611
        if object_to_update is None:
          # create a new cell
612
          cell_key = movement.getVariationCategoryList(
613
              omit_optional_variation=1)
Romain Courteaud's avatar
Romain Courteaud committed
614
          if not delivery_line.hasCell(base_id=base_id, *cell_key):
615
            try:
616
              old_cell = movement_group_node.getMovementList()[0].getDeliveryValue()
617 618 619 620 621
            except AttributeError:
              old_cell = None
            if old_cell is None:
              # from scratch
              cell = delivery_line.newCell(base_id=base_id, \
622
                       portal_type=self.getDeliveryCellPortalType(),
623
                       activate_kw=activate_kw,*cell_key)
624 625 626 627 628 629 630 631 632
            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']]

633 634
            vcl = movement.getVariationCategoryList()
            cell._edit(category_list=vcl,
Romain Courteaud's avatar
Romain Courteaud committed
635 636
                      # XXX hardcoded value
                      mapped_value_property_list=['quantity', 'price'],
637
                      membership_criterion_category_list=vcl,
Romain Courteaud's avatar
Romain Courteaud committed
638 639 640 641
                      membership_criterion_base_category_list=movement.\
                                             getVariationBaseCategoryList())
            object_to_update = cell
          else:
642
            raise MatrixError, 'Cell: %s already exists on %s' % \
Romain Courteaud's avatar
Romain Courteaud committed
643
                  (str(cell_key), str(delivery_line))
644
        self._setUpdated(object_to_update, 'cell')
Romain Courteaud's avatar
Romain Courteaud committed
645 646
        self._setDeliveryMovementProperties(
                            object_to_update, movement, property_dict,
647
                            update_existing_movement=update_existing_movement,
648
                            force_update=force_update, activate_kw=activate_kw)
Romain Courteaud's avatar
Romain Courteaud committed
649 650 651

  def _setDeliveryMovementProperties(self, delivery_movement,
                                     simulation_movement, property_dict,
652
                                     update_existing_movement=0,
653
                                     force_update=0, activate_kw=None):
Romain Courteaud's avatar
Romain Courteaud committed
654 655 656 657
    """
      Initialize or update delivery movement properties.
      Set delivery ratio on simulation movement.
    """
658
    if update_existing_movement == 1 and not force_update:
Romain Courteaud's avatar
Romain Courteaud committed
659 660 661 662 663 664 665 666 667 668 669 670 671
      # 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...)
672
      delivery_movement._edit(force_update=1, **property_dict)
Romain Courteaud's avatar
Romain Courteaud committed
673
      simulation_movement.edit(delivery_ratio=1)
674

675
  def callAfterBuildingScript(self, *args, **kw):
676
    """
677 678 679 680 681 682 683 684 685
      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.
686
    """
687 688
    if not len(delivery_list):
      return
Jérome Perrin's avatar
Jérome Perrin committed
689 690 691
    # Parameter initialization
    if movement_list is None:
      movement_list = []
692 693
    delivery_after_generation_script_id = \
                              self.getDeliveryAfterGenerationScriptId()
694 695
    related_simulation_movement_path_list = \
                              [x.getPath() for x in movement_list]
696 697
    if delivery_after_generation_script_id not in ["", None]:
      for delivery in delivery_list:
698
        script = getattr(delivery, delivery_after_generation_script_id)
699 700 701 702 703
        # 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
704 705 706
        meta_type = getattr(script, 'meta_type', None)
        if meta_type == 'Script (Python)':
          # check if the script accepts related_simulation_movement_path_list
707
          safe_to_pass_parameter = False
708 709
          for param in script.params().split(','):
            param = param.split('=', 1)[0].strip()
710 711 712
            if param == 'related_simulation_movement_path_list' \
                    or param.startswith('**'):
              safe_to_pass_parameter = True
713
              break
714 715

        if safe_to_pass_parameter:
716
          script(related_simulation_movement_path_list=related_simulation_movement_path_list)
717 718
        else:
          script()
719 720 721 722 723 724 725 726 727 728 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

  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'] = {}
780 781

  # for backward compatibilities.
782
  _deliveryGroupProcessing = _processDeliveryGroup
783 784
  _deliveryLineGroupProcessing = _processDeliveryLineGroup
  _deliveryCellGroupProcessing = _processDeliveryCellGroup