##############################################################################
#
# 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
from Products.ERP5Type.DivergenceMessage import DivergenceMessage
from Products.ERP5.DivergenceSolutionDecision \
    import DivergenceSolutionDecision

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 = []
    forced_property_list = []

    if getattr(rule, 'getExpandablePropertyList', None) is not None:
      expandable_property_list = rule.getExpandablePropertyList()

    if movement_quantity > new_movement_quantity:
      split_index = 0
      new_id = "%s_split_%s" % (simulation_movement.getId(), split_index)
      applied_rule = simulation_movement.getParentValue()
      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
      if simulation_movement.getCausality() and expandable_property_list:
        # working in BPM enabled system with nicely configured rules
        movement_dict = {}
        # new properties
        movement_dict.update(
          portal_type="Simulation Movement",
          id=new_id,
          start_date=self.start_date,
          stop_date=self.stop_date,
          quantity=movement_quantity - new_movement_quantity,
          activate_kw=self.activate_kw,
          order=simulation_movement.getOrder(),
          **self.additional_parameters
        )

        for prop in applied_rule.getSpecialiseValue().getExpandablePropertyList():
          if prop not in movement_dict: # XXX: better way to filter out
            movement_dict.update(**{
              prop: simulation_movement.getProperty(prop)})
            if simulation_movement.isPropertyForced(prop):
              # set same forcing on fresh movement - XXX might be good,
              # might be wrong
              forced_property_list.append(prop)
        new_movement = applied_rule.newContent(**movement_dict)
        new_movement.activate(**self.additional_parameters).expand()
        # XXX: start and stop date have to be forced on movement too
        forced_property_list.extend(['start_date', 'stop_date'])
        for prop in forced_property_list:
          fake_divergence = DivergenceMessage()
          fake_divergence.tested_property = prop
          decision = DivergenceSolutionDecision(fake_divergence, 'accept', None, None,
              True)
          new_movement.appendDecision(decision)
      else:
        new_movement = applied_rule.newContent(
                        portal_type="Simulation Movement",
                        id=new_id,
                        efficiency=simulation_movement.getEfficiency(),
                        start_date=self.start_date,
                        stop_date=self.stop_date,
                        order=simulation_movement.getOrder(),
                        deliverable=simulation_movement.isDeliverable(),

                        resource=simulation_movement.getResource(),
                        quantity=movement_quantity - new_movement_quantity,
                        quantity_unit=simulation_movement.getQuantityUnit(),

                        price=simulation_movement.getPrice(),
                        price_currency=simulation_movement.getPriceCurrency(),

                        source=simulation_movement.getSource(),
                        destination=simulation_movement.getDestination(),
                        source_section=simulation_movement.getSourceSection(),
                        destination_section=simulation_movement.getDestinationSection(),
                        source_function=simulation_movement.getSourceFunction(),
                        destination_function=simulation_movement.getDestinationFunction(),
                        source_account=simulation_movement.getSourceAccount(),
                        destination_account=simulation_movement.getDestinationAccount(),

                        variation_category_list=simulation_movement.getVariationCategoryList(),
                        variation_property_dict=simulation_movement.getVariationPropertyDict(),

                        base_application_list=simulation_movement.getBaseApplicationList(),
                        base_contribution_list=simulation_movement.getBaseContributionList(),
                        description=simulation_movement.getDescription(),
                        activate_kw=self.activate_kw,
                        **self.additional_parameters
      )
      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.
