OrderBuilder.py 35.9 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
from Products.ERP5.MovementGroup import MovementGroupNode
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
36
from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod
37
from DateTime import DateTime
38
from Acquisition import aq_parent, aq_inner
Romain Courteaud's avatar
Romain Courteaud committed
39

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

44 45 46
class SelectMethodError(Exception): pass
class SelectMovementError(Exception): pass

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

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

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

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

61 62
    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
63 64
    definition).

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

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

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

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

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

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

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

99 100 101 102
  # XXX it would be better to make the base id configurable at
  # each builder.
  matrix_base_id = 'movement'

103
  security.declarePublic('build')
104
  def build(self, applied_rule_uid=None, movement_relative_url_list=None,
105
            delivery_relative_url_list=None, movement_list=None, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
106 107 108 109 110 111 112
    """
      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
    """
113 114 115 116 117
    # Parameter initialization
    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
118
    # Select
119 120 121 122 123
    if not movement_list:
      # XXX this code below has a problem of inconsistency in that
      # searchMovementList is unrestricted while passing a list of
      # movements is restricted.
      if not movement_relative_url_list:
124 125 126 127
        movement_list = self.searchMovementList(
                                        delivery_relative_url_list=delivery_relative_url_list,
                                        applied_rule_uid=applied_rule_uid,**kw)
      else:
128 129
        restrictedTraverse = self.getPortalObject().restrictedTraverse
        movement_list = [restrictedTraverse(relative_url) for relative_url \
130
                         in movement_relative_url_list]
131
    if not movement_list:
132
      return []
Romain Courteaud's avatar
Romain Courteaud committed
133
    # Collect
134
    root_group_node = self.collectMovement(movement_list)
Romain Courteaud's avatar
Romain Courteaud committed
135 136
    # Build
    delivery_list = self.buildDeliveryList(
137
                       root_group_node,
Romain Courteaud's avatar
Romain Courteaud committed
138
                       delivery_relative_url_list=delivery_relative_url_list,
139
                       movement_list=movement_list, **kw)
140
    # Call a script after building
141
    self.callAfterBuildingScript(delivery_list, movement_list, **kw)
142
    # XXX Returning the delivery list is probably not necessary
Romain Courteaud's avatar
Romain Courteaud committed
143 144
    return delivery_list

145
  def callBeforeBuildingScript(self):
Romain Courteaud's avatar
Romain Courteaud committed
146
    """
147
      Call a script on the module, for example, to remove some
148
      auto_planned Order.
149 150
      This part can only be done with a script, because user may want
      to keep existing auto_planned Order, and only update lines in
151 152 153 154 155 156
      them.
      No activities are used when deleting a object, so, current
      implementation should be OK.
    """
    delivery_module_before_building_script_id = \
        self.getDeliveryModuleBeforeBuildingScriptId()
157
    if delivery_module_before_building_script_id:
158
      delivery_module = getattr(self.getPortalObject(), self.getDeliveryModule())
159
      getattr(delivery_module, delivery_module_before_building_script_id)()
Romain Courteaud's avatar
Romain Courteaud committed
160

161
  def generateMovementListForStockOptimisation(self, **kw):
162
    from Products.ERP5Type.Document import newTempMovement
Romain Courteaud's avatar
Romain Courteaud committed
163
    movement_list = []
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    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
185
        movement = newTempMovement(self.getPortalObject(),
186 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
                                   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(
213
            start_date=DateTime(((stop_date-max_delay).Date())),
214
            stop_date=DateTime(stop_date.Date()),
215 216 217 218 219 220
            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
221
    return movement_list
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

  @UnrestrictedMethod
  def searchMovementList(self, applied_rule_uid=None, **kw):
    """
      Returns a list of simulation movements (or something similar to
      simulation movements) to construct a new delivery.

      For compatibility, if a simulation select method id is not provided,
      a list of movements for predicting future supplies is returned.
      You should define a simulation select method id, then it will be used
      to calculate the result.
    """
    method_id = self.getSimulationSelectMethodId()
    if not method_id:
      # XXX compatibility
      return self.generateMovementListForStockOptimisation(**kw)

    select_method = getattr(self.getPortalObject(), method_id)
    movement_list = select_method(**kw)

    # Make sure that movements are not duplicated.
    movement_set = set()
    for movement in movement_list:
      if movement in movement_set:
        raise SelectMethodError('%s returned %s twice or more' % \
                (method_id, movement.getRelativeUrl()))
      else:
        movement_set.add(movement)

    return movement_list
Romain Courteaud's avatar
Romain Courteaud committed
252 253 254

  def collectMovement(self, movement_list):
    """
255
      group movements in the way we want. Thanks to this method, we are able
Romain Courteaud's avatar
Romain Courteaud committed
256 257
      to retrieve movement classed by order, resource, criterion,....
      movement_list : the list of movement wich we want to group
258
      class_list : the list of classes used to group movements. The order
Romain Courteaud's avatar
Romain Courteaud committed
259 260 261 262 263
                   of the list is important and determines by what we will
                   group movement first
                   Typically, check_list is :
                   [DateMovementGroup,PathMovementGroup,...]
    """
264
    movement_group_list = self.getMovementGroupList()
265 266 267 268 269 270 271 272 273 274 275 276 277 278

    # Need to find the last branch movement group for separate methods.
    last_line_movement_group = None
    previous_collect_order_group = None
    for movement_group in movement_group_list:
      collect_order_group = movement_group.getCollectOrderGroup()
      if collect_order_group == 'line':
        if previous_collect_order_group == 'delivery' \
                or movement_group.isBranch():
          last_line_movement_group = movement_group
      elif collect_order_group == 'cell':
        break
      previous_collect_order_group = collect_order_group
    if last_line_movement_group is None:
279 280 281 282
      # XXX I think this is an error, but there are many tests which
      # fail, so for now I permit falling back to the last one.
      #raise CollectError('No branch movement group found at %r' % (self,))
      last_line_movement_group = movement_group
283

284
    separate_method_name_list = self.getDeliveryCellSeparateOrderList([])
285
    root_group_node = MovementGroupNode(
286 287 288
      separate_method_name_list=separate_method_name_list,
      movement_group_list=movement_group_list,
      last_line_movement_group=last_line_movement_group)
289 290
    root_group_node.append(movement_list)
    return root_group_node
Romain Courteaud's avatar
Romain Courteaud committed
291

292
  def _test(self, instance, movement_group_node_list,
293 294 295
                    divergence_list):
    result = True
    new_property_dict = {}
296 297
    for movement_group_node in movement_group_node_list:
      tmp_result, tmp_property_dict = movement_group_node.test(
298
        instance, divergence_list)
299
      if not tmp_result:
300 301 302 303
        result = tmp_result
      new_property_dict.update(tmp_property_dict)
    return result, new_property_dict

304
  def _findUpdatableObject(self, instance_list, movement_group_node_list,
305
                           divergence_list):
306 307 308 309 310 311 312 313
    # FIXME this code may generate inconsistent results, because
    # MovementGroupNode.test can return anything else but the
    # property dict. So it would be better to use the test method
    # in all cases. It is, however, not so easy to do, because
    # Movement Group classes might not be prepared for receiving
    # None instead of a real document object. So it would be safer
    # to pass a temp object, but generating a temp object is not 
    # very fast.
314 315
    instance = None
    property_dict = {}
Yoshinori Okuji's avatar
Yoshinori Okuji committed
316
    if not instance_list:
317
      for movement_group_node in movement_group_node_list:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
318
        for k, v in movement_group_node.getGroupEditDict().iteritems():
319 320 321 322
          if k in property_dict:
            raise DuplicatedPropertyDictKeysError(k)
          else:
            property_dict[k] = v
323
    else:
324 325
      # we want to check the original delivery first.
      # so sort instance_list by that current is exists or not.
326
      try:
327 328 329
        current = movement_group_node_list[-1].getMovementList()[0].getDeliveryValue()
        portal = self.getPortalObject()
        while current != portal:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
330 331 332 333 334 335
          try:
            instance_list.remove(current)
          except ValueError:
            pass
          else:
            instance_list.insert(0, current)
336 337
            break
          current = current.getParentValue()
338
      except AttributeError:
339
        pass
340
      for instance_to_update in instance_list:
341
        result, property_dict = self._test(
342
          instance_to_update, movement_group_node_list, divergence_list)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
343
        if result:
344
          instance = instance_to_update
Romain Courteaud's avatar
Romain Courteaud committed
345
          break
346
    return instance, property_dict
Romain Courteaud's avatar
Romain Courteaud committed
347

348 349 350
  @UnrestrictedMethod
  def buildDeliveryList(self, movement_group_node,
                        delivery_relative_url_list=None,
351
                        movement_list=None, update=True, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
352 353 354
    """
      Build deliveries from a list of movements
    """
355 356 357
    # Parameter initialization
    if delivery_relative_url_list is None:
      delivery_relative_url_list = []
Jérome Perrin's avatar
Jérome Perrin committed
358 359
    if movement_list is None:
      movement_list = []
Romain Courteaud's avatar
Romain Courteaud committed
360
    # Module where we can create new deliveries
361 362
    portal = self.getPortalObject()
    delivery_module = getattr(portal, self.getDeliveryModule())
363
    if update:
364 365
      unrestrictedTraverse = portal.unrestrictedTraverse
      delivery_to_update_list = [unrestrictedTraverse(relative_url) for \
366 367 368
                                 relative_url in delivery_relative_url_list]
      # Deliveries we are trying to update
      delivery_select_method_id = self.getDeliverySelectMethodId()
369 370 371 372
      if delivery_select_method_id:
        delivery_select_method = getattr(self, delivery_select_method_id)
        for brain in delivery_select_method(movement_list=movement_list):
          delivery_to_update_list.append(brain.getObject())
373 374 375 376 377

      # Make sure that the portal type is good.
      delivery_portal_type = self.getDeliveryPortalType()
      delivery_to_update_list = [x for x in delivery_to_update_list \
              if x.getPortalType() == delivery_portal_type]
378 379
    else:
      delivery_to_update_list = []
380

381
    delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
382
                          delivery_module,
383
                          movement_group_node,
384
                          self.getDeliveryMovementGroupList(),
385 386
                          delivery_to_update_list=delivery_to_update_list,
                          **kw)
Romain Courteaud's avatar
Romain Courteaud committed
387 388
    return delivery_list

389 390 391 392 393 394 395 396 397 398 399 400 401
  def _createDelivery(self, delivery_module, movement_list, activate_kw):
    """
      Create a new delivery in case where a builder may not update
      an existing one.
    """
    new_delivery_id = str(delivery_module.generateNewId())
    delivery = delivery_module.newContent(
      portal_type=self.getDeliveryPortalType(),
      id=new_delivery_id,
      created_by_builder=1,
      activate_kw=activate_kw)
    return delivery

402 403 404 405 406
  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):
407 408 409
    """
      Build delivery from a list of movement
    """
410 411
    # FIXME make sure that activate_kw is used for all active objects
    # generated from this method and methods called from this method.
412 413
    if movement_group_node_list is None:
      movement_group_node_list = []
414 415 416
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
417
    movement_group_node_list = movement_group_node_list + [movement_group_node]
418 419 420
    # Parameter initialization
    if delivery_to_update_list is None:
      delivery_to_update_list = []
Romain Courteaud's avatar
Romain Courteaud committed
421
    delivery_list = []
422

423
    if collect_order_list:
Romain Courteaud's avatar
Romain Courteaud committed
424
      # Get sorted movement for each delivery
425 426
      for grouped_node in movement_group_node.getGroupList():
        new_delivery_list = self._processDeliveryGroup(
Romain Courteaud's avatar
Romain Courteaud committed
427
                              delivery_module,
428
                              grouped_node,
Romain Courteaud's avatar
Romain Courteaud committed
429
                              collect_order_list[1:],
430
                              movement_group_node_list=movement_group_node_list,
431
                              delivery_to_update_list=delivery_to_update_list,
432 433
                              divergence_list=divergence_list,
                              activate_kw=activate_kw,
434
                              force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
435
        delivery_list.extend(new_delivery_list)
436
        force_update = 0
Romain Courteaud's avatar
Romain Courteaud committed
437
    else:
438
      # Test if we can update a existing delivery, or if we need to create
Romain Courteaud's avatar
Romain Courteaud committed
439
      # a new one
440
      delivery, property_dict = self._findUpdatableObject(
441
        delivery_to_update_list, movement_group_node_list,
442 443 444 445
        divergence_list)

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

Romain Courteaud's avatar
Romain Courteaud committed
449
      if delivery is None:
450 451 452
        delivery = self._createDelivery(delivery_module,
                                        movement_group_node.getMovementList(),
                                        activate_kw)
453 454 455 456 457
      else:
        # The same delivery should not be updated more than once.
        # Note that it is important to use a destructive method here.
        delivery_to_update_list.remove(delivery)

458 459
      # Put properties on delivery
      if property_dict:
460
        property_dict.setdefault('edit_order', ('stop_date', 'start_date'))
Romain Courteaud's avatar
Romain Courteaud committed
461 462
        delivery.edit(**property_dict)

463 464 465 466 467
      # Then, create delivery lines
      delivery_line_portal_type = self.getDeliveryLinePortalType()
      delivery_line_to_update_list = []
      for line in delivery.contentValues(portal_type=delivery_line_portal_type):
        delivery_line_to_update_list.append(line)
468 469
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryLineGroup(
Romain Courteaud's avatar
Romain Courteaud committed
470
                                delivery,
471
                                grouped_node,
472 473
                                self.getDeliveryLineMovementGroupList()[1:],
                                divergence_list=divergence_list,
474
                                delivery_line_to_update_list=delivery_line_to_update_list,
475 476
                                activate_kw=activate_kw,
                                force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
477 478
      delivery_list.append(delivery)
    return delivery_list
479

480 481 482 483 484 485 486 487 488 489 490 491 492
  def _createDeliveryLine(self, delivery, movement_list, activate_kw):
    """
      Create a new delivery line in case where a builder may not update
      an existing one.
    """
    new_delivery_line_id = str(delivery.generateNewId())
    delivery_line = delivery.newContent(
      portal_type=self.getDeliveryLinePortalType(),
      id=new_delivery_line_id,
      created_by_builder=1,
      activate_kw=activate_kw)
    return delivery_line

493 494 495
  def _processDeliveryLineGroup(self, delivery, movement_group_node,
                                collect_order_list, movement_group_node_list=None,
                                divergence_list=None,
496
                                delivery_line_to_update_list=None,
497
                                activate_kw=None, force_update=0, **kw):
Romain Courteaud's avatar
Romain Courteaud committed
498 499 500
    """
      Build delivery line from a list of movement on a delivery
    """
501 502
    if movement_group_node_list is None:
      movement_group_node_list = []
503 504
    if divergence_list is None:
      divergence_list = []
505 506
    if delivery_line_to_update_list is None:
      delivery_line_to_update_list = []
507
    # do not use 'append' or '+=' because they are destructive.
508
    movement_group_node_list = movement_group_node_list + [movement_group_node]
509

510
    if collect_order_list and not movement_group_node.getCurrentMovementGroup().isBranch():
Romain Courteaud's avatar
Romain Courteaud committed
511
      # Get sorted movement for each delivery line
512 513 514 515 516 517
      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,
518
          divergence_list=divergence_list,
519
          delivery_line_to_update_list=delivery_line_to_update_list,
520 521
          activate_kw=activate_kw,
          force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
522 523 524
    else:
      # Test if we can update an existing line, or if we need to create a new
      # one
525
      delivery_line, property_dict = self._findUpdatableObject(
526
        delivery_line_to_update_list, movement_group_node_list,
527 528 529
        divergence_list)
      if delivery_line is not None:
        update_existing_line = 1
530
        delivery_line_to_update_list.remove(delivery_line)
531
      else:
Romain Courteaud's avatar
Romain Courteaud committed
532
        # Create delivery line
533
        update_existing_line = 0
534 535 536 537
        delivery_line = self._createDeliveryLine(
                delivery,
                movement_group_node.getMovementList(),
                activate_kw)
538 539
      # Put properties on delivery line
      if property_dict:
540
        property_dict.setdefault('edit_order', ('stop_date', 'start_date'))
541
        delivery_line.edit(force_update=1, **property_dict)
542

543
      if movement_group_node.getCurrentMovementGroup().isBranch():
544 545 546 547
        delivery_line_portal_type = self.getDeliveryLinePortalType()
        nested_delivery_line_to_update_list = []
        for line in delivery_line.contentValues(portal_type=delivery_line_portal_type):
          nested_delivery_line_to_update_list.append(line)
548 549 550 551 552 553 554
        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,
555
            delivery_line_to_update_list=nested_delivery_line_to_update_list,
556 557 558 559
            activate_kw=activate_kw,
            force_update=force_update)
        return

Romain Courteaud's avatar
Romain Courteaud committed
560
      # Update variation category list on line
561
      variation_category_set = set(delivery_line.getVariationCategoryList())
562
      for movement in movement_group_node.getMovementList():
563 564
        variation_category_set.update(movement.getVariationCategoryList())
      variation_category_list = sorted(variation_category_set)
565
      delivery_line.setVariationCategoryList(variation_category_list)
Romain Courteaud's avatar
Romain Courteaud committed
566 567
      # Then, create delivery movement (delivery cell or complete delivery
      # line)
568
      grouped_node_list = movement_group_node.getGroupList()
569
      # If no group is defined for cell, we need to continue, in order to
570
      # save the quantity value
571
      if grouped_node_list:
572 573 574 575 576 577 578
        base_id = self.matrix_base_id
        getCell = delivery_line.getCell
        delivery_movement_to_update_list = []
        for cell_key in delivery_line.getCellKeyList(base_id=base_id):
          cell = getCell(base_id=base_id, *cell_key)
          if cell is not None:
            delivery_movement_to_update_list.append(cell)
579 580
        for grouped_node in grouped_node_list:
          self._processDeliveryCellGroup(
Romain Courteaud's avatar
Romain Courteaud committed
581
                                    delivery_line,
582
                                    grouped_node,
583
                                    self.getDeliveryCellMovementGroupList()[1:],
584
                                    update_existing_line=update_existing_line,
585
                                    divergence_list=divergence_list,
586
                                    delivery_movement_to_update_list=delivery_movement_to_update_list,
587 588
                                    activate_kw=activate_kw,
                                    force_update=force_update)
589
      else:
590
        self._processDeliveryCellGroup(
591
                                  delivery_line,
592 593 594
                                  # FIXME passing current movement group node
                                  # has bad side effect, so the logic must
                                  # be corrected.
595
                                  movement_group_node,
596
                                  [],
597
                                  update_existing_line=update_existing_line,
598
                                  divergence_list=divergence_list,
599
                                  delivery_movement_to_update_list=[delivery_line],
600 601
                                  activate_kw=activate_kw,
                                  force_update=force_update)
602

603 604 605 606 607 608 609 610 611 612 613
  def _createDeliveryCell(self, delivery_line, movement, activate_kw,
                          base_id, cell_key):
    """
      Create a new delivery cell in case where a builder may not update
      an existing one.
    """
    cell = delivery_line.newCell(base_id=base_id,
                                 portal_type=self.getDeliveryCellPortalType(),
                                 activate_kw=activate_kw,
                                 *cell_key)
    return cell
Romain Courteaud's avatar
Romain Courteaud committed
614

615 616 617 618
  def _processDeliveryCellGroup(self, delivery_line, movement_group_node,
                                collect_order_list, movement_group_node_list=None,
                                update_existing_line=0,
                                divergence_list=None,
619
                                delivery_movement_to_update_list=None,
620
                                activate_kw=None, force_update=0):
Romain Courteaud's avatar
Romain Courteaud committed
621 622 623 624
    """
      Build delivery cell from a list of movement on a delivery line
      or complete delivery line
    """
625 626
    if movement_group_node_list is None:
      movement_group_node_list = []
627 628
    if delivery_movement_to_update_list is None:
      delivery_movement_to_update_list = []
629 630 631
    if divergence_list is None:
      divergence_list = []
    # do not use 'append' or '+=' because they are destructive.
632
    movement_group_node_list = movement_group_node_list + [movement_group_node]
633

634
    if collect_order_list:
Romain Courteaud's avatar
Romain Courteaud committed
635
      # Get sorted movement for each delivery line
636 637
      for grouped_node in movement_group_node.getGroupList():
        self._processDeliveryCellGroup(
638
          delivery_line,
639
          grouped_node,
640
          collect_order_list[1:],
641
          movement_group_node_list=movement_group_node_list,
642 643
          update_existing_line=update_existing_line,
          divergence_list=divergence_list,
644
          delivery_movement_to_update_list=delivery_movement_to_update_list,
645 646
          activate_kw=activate_kw,
          force_update=force_update)
Romain Courteaud's avatar
Romain Courteaud committed
647
    else:
648
      movement_list = movement_group_node.getMovementList()
Romain Courteaud's avatar
Romain Courteaud committed
649
      if len(movement_list) != 1:
650
        raise CollectError, "DeliveryBuilder: %s unable to distinct those\
Romain Courteaud's avatar
Romain Courteaud committed
651 652
              movements: %s" % (self.getId(), str(movement_list))
      else:
653
        base_id = self.matrix_base_id
Romain Courteaud's avatar
Romain Courteaud committed
654 655
        object_to_update = None
        # We need to initialize the cell
656
        update_existing_movement = 0
Romain Courteaud's avatar
Romain Courteaud committed
657 658 659 660 661
        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
662
        property_dict = {}
663
        if not delivery_line.getCellKeyList(base_id=base_id):
Romain Courteaud's avatar
Romain Courteaud committed
664
          # update line
665 666
          dummy, property_dict = self._findUpdatableObject(
            delivery_movement_to_update_list, movement_group_node_list,
667
            divergence_list)
668 669 670 671
          if delivery_movement_to_update_list:
            if update_existing_line:
              update_existing_movement = 1
            del delivery_movement_to_update_list[:]
672
          else:
673 674 675
            # XXX probably an exception should be raised here.
            pass
          object_to_update = delivery_line
Romain Courteaud's avatar
Romain Courteaud committed
676
        else:
677
          object_to_update, property_dict = self._findUpdatableObject(
678
            delivery_movement_to_update_list, movement_group_node_list,
679 680 681 682 683 684
            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
685
            delivery_movement_to_update_list.remove(object_to_update)
Romain Courteaud's avatar
Romain Courteaud committed
686
          else:
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
            # create a new cell
            cell_key = movement.getVariationCategoryList(
                    omit_optional_variation=1)
            if not delivery_line.hasCell(base_id=base_id, *cell_key):
              cell = self._createDeliveryCell(delivery_line, movement,
                                              activate_kw, base_id, cell_key)
              vcl = movement.getVariationCategoryList()
              cell._edit(category_list=vcl,
                         # XXX hardcoded value
                         mapped_value_property_list=('quantity', 'price'),
                         membership_criterion_category_list=vcl,
                         membership_criterion_base_category_list=movement.\
                                               getVariationBaseCategoryList())
            else:
              raise MatrixError, 'Cell: %s already exists on %s' % \
                    (str(cell_key), str(delivery_line))
            object_to_update = cell

Romain Courteaud's avatar
Romain Courteaud committed
705 706
        self._setDeliveryMovementProperties(
                            object_to_update, movement, property_dict,
707
                            update_existing_movement=update_existing_movement,
708
                            force_update=force_update, activate_kw=activate_kw)
Romain Courteaud's avatar
Romain Courteaud committed
709 710 711

  def _setDeliveryMovementProperties(self, delivery_movement,
                                     simulation_movement, property_dict,
712
                                     update_existing_movement=0,
713
                                     force_update=0, activate_kw=None):
Romain Courteaud's avatar
Romain Courteaud committed
714 715 716
    """
      Initialize or update delivery movement properties.
    """
717
    if not update_existing_movement or force_update:
Romain Courteaud's avatar
Romain Courteaud committed
718 719
      # Now, only 1 movement is possible, so copy from this movement
      # XXX hardcoded value
720 721 722 723
      if getattr(simulation_movement, 'getMappedProperty', None) is not None:
        property_dict['quantity'] = simulation_movement.getMappedProperty('quantity')
      else:
        property_dict['quantity'] = simulation_movement.getQuantity()
Romain Courteaud's avatar
Romain Courteaud committed
724 725
      property_dict['price'] = simulation_movement.getPrice()
      # Update properties on object (quantity, price...)
726
      delivery_movement._edit(force_update=1, **property_dict)
727

728 729
  @UnrestrictedMethod
  def callAfterBuildingScript(self, delivery_list, movement_list=None, **kw):
730 731
    """
      Call script on each delivery built.
732
    """
733
    if not delivery_list:
734
      return
Jérome Perrin's avatar
Jérome Perrin committed
735 736 737
    # Parameter initialization
    if movement_list is None:
      movement_list = []
738 739
    delivery_after_generation_script_id = \
                              self.getDeliveryAfterGenerationScriptId()
740 741
    related_simulation_movement_path_list = \
                              [x.getPath() for x in movement_list]
742
    if delivery_after_generation_script_id:
743
      for delivery in delivery_list:
744
        script = getattr(delivery, delivery_after_generation_script_id)
745 746 747 748 749
        # 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
750 751 752
        meta_type = getattr(script, 'meta_type', None)
        if meta_type == 'Script (Python)':
          # check if the script accepts related_simulation_movement_path_list
753
          safe_to_pass_parameter = False
754 755
          for param in script.params().split(','):
            param = param.split('=', 1)[0].strip()
756 757 758
            if param == 'related_simulation_movement_path_list' \
                    or param.startswith('**'):
              safe_to_pass_parameter = True
759
              break
760 761

        if safe_to_pass_parameter:
762
          script(related_simulation_movement_path_list=related_simulation_movement_path_list)
763 764
        else:
          script()
765 766 767 768 769 770 771 772

  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.
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
773
    portal = self.getPortalObject()
774
    if portal_type is None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
      portal_type = portal.getPortalMovementGroupTypeList()

    if collect_order_group is None:
      category_index_dict = {}
      for i in portal.portal_categories.collect_order_group.contentValues():
        category_index_dict[i.getId()] = i.getIntIndex()

      def getMovementGroupKey(movement_group):
        return (category_index_dict.get(movement_group.getCollectOrderGroup()),
                movement_group.getIntIndex())

      filter_dict = dict(portal_type=portal_type)
      movement_group_list = self.contentValues(filter=filter_dict)
    else:
      def getMovementGroupKey(movement_group):
        return movement_group.getIntIndex()

      filter_dict = dict(portal_type=portal_type)
      movement_group_list = []
      for movement_group in self.contentValues(filter=filter_dict):
        if movement_group.getCollectOrderGroup() == collect_order_group:
          movement_group_list.append(movement_group)

    return sorted(movement_group_list, key=getMovementGroupKey)
799 800 801 802 803 804 805 806 807 808 809 810 811

  # 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')

812 813
  # XXX this method is not used in OrderBuilder but in DeliveryBuilder.
  # So it should perhaps be moved to DeliveryBuilder.
814 815 816 817 818 819 820 821 822 823 824 825 826
  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

827
  # for backward compatibilities.
828
  _deliveryGroupProcessing = _processDeliveryGroup
829 830
  _deliveryLineGroupProcessing = _processDeliveryLineGroup
  _deliveryCellGroupProcessing = _processDeliveryCellGroup