##############################################################################
#
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#                    Romain Courteaud <romain@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from CopyToTarget import CopyToTarget
from Acquisition import aq_base

class SplitAndDefer(CopyToTarget):
  """
    Split and defer simulation movement.

    Many 'deliverable movements' are created in the Simulation and
    may need to be delivered later. Solver accumulates such movements
    in the solving process and creates a new delivery

    This only works when some movements can not be delivered 
    (excessive qty is not covered)
  """

  def solve(self, simulation_movement):
    """
      Split a simulation movement and accumulate
    """
    movement_quantity = simulation_movement.getQuantity()
    delivery_quantity = simulation_movement.getDeliveryQuantity()
    new_movement_quantity = delivery_quantity * simulation_movement.getDeliveryRatio()
    applied_rule = simulation_movement.getParentValue()
    rule = applied_rule.getSpecialiseValue()
    expandable_property_list = []

    if getattr(rule, 'getExpandablePropertyList', None) is not None:
      expandable_property_list = rule.getExpandablePropertyList()
    if len(expandable_property_list) == 0:
      # hardcoded default for compatibility
      expandable_property_list = (
        'base_application_list',
        'base_contribution_list',
        'description',
        'destination',
        'destination_account',
        'destination_function',
        'destination_section',
        'efficiency',
        'price',
        'price_currency',
        'quantity_unit',
        'resource',
        'source',
        'source_account',
        'source_function',
        'source_section',
        'start_date',
        'stop_date',
        'variation_category_list',
        'variation_property_dict',
        )

    if movement_quantity > new_movement_quantity:
      split_index = 0
      new_id = "%s_split_%s" % (simulation_movement.getId(), split_index)
      while getattr(aq_base(applied_rule), new_id, None) is not None:
        split_index += 1
        new_id = "%s_split_%s" % (simulation_movement.getId(), split_index)
      # Adopt different dates for deferred movements
      movement_dict = {}
      # new properties
      movement_dict.update(
        portal_type="Simulation Movement",
        id=new_id,
        quantity=movement_quantity - new_movement_quantity,
        activate_kw=self.activate_kw,
        # 'order' category is deprecated. it is kept for compatibility.
        order=simulation_movement.getOrder(),
        **self.additional_parameters
      )

      for prop in expandable_property_list:
        if prop not in movement_dict: # XXX: better way to filter out
          movement_dict.update(**{
            prop: simulation_movement.getProperty(prop)})
      new_movement = applied_rule.newContent(**movement_dict)
      start_date = getattr(self, 'start_date', None)
      if start_date is not None:
        new_movement.recordProperty('start_date')
        new_movement.edit(start_date=start_date)
      stop_date = getattr(self, 'stop_date', None)
      if stop_date is not None:
        new_movement.recordProperty('stop_date')
        new_movement.edit(stop_date=stop_date)
      new_movement.activate(**self.additional_parameters).expand()
    # adopt new quantity on original simulation movement
    simulation_movement.edit(quantity=new_movement_quantity)
    simulation_movement.setDefaultActivateParameters(**self.activate_kw)
    simulation_movement.activate(**self.additional_parameters).expand()

    # SplitAndDefer solves the divergence at the current level, no need to
    # backtrack.
