moved from ERP5 product

git-svn-id: https://svn.erp5.org/repos/public/erp5/sandbox/amount_generator@37490 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5Legacy/Document/AccountingRuleCell.py

+##############################################################################
+#
+# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@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 Products.ERP5Type.Globals import InitializeClass, PersistentMapping
+#from Products.CMFCore.utils import getToolByName
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet
+
+from Products.ERP5.Document.Predicate import Predicate
+from Products.ERP5.Document.Invoice import Invoice
+
+class AccountingRuleCell(Predicate, Invoice):
+    """
+An AccountingRuleCell object allows to add SaleInvoiceTransactionLines into a Matrix
+    """
+
+    # Default Properties
+    property_sheets = ( PropertySheet.Base
+                      , PropertySheet.XMLObject
+                      , PropertySheet.CategoryCore
+                      , PropertySheet.DublinCore
+                      , PropertySheet.Delivery
+                      , PropertySheet.Task
+                      , PropertySheet.Arrow
+                      , PropertySheet.Movement
+                      , PropertySheet.Amount
+                      , PropertySheet.Reference
+                      , PropertySheet.PaymentCondition
+                      , PropertySheet.Predicate
+                      , PropertySheet.MappedValue
+                      )
+
+    # CMF Type Definition
+    meta_type = 'ERP5 Accounting Rule Cell'
+    portal_type = 'Accounting Rule Cell'
+    add_permission = Permissions.AddPortalContent
+
+    # Declarative security
+    security = ClassSecurityInfo()
+    security.declareObjectProtected(Permissions.AccessContentsInformation)

product/ERP5Legacy/Document/AccountingTransactionRootSimulationRule.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SARL and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5.Document.DeliveryRootSimulationRule \
+     import DeliveryRootSimulationRule
+
+class AccountingTransactionRootSimulationRule(DeliveryRootSimulationRule):
+  """
+  Accounting Transaction Root Simulation Rule is a root level rule for
+  Accounting Transaction.
+  """
+  # CMF Type Definition
+  meta_type = 'ERP5 Accounting Transaction Root Simulation Rule'
+  portal_type = 'Accounting Transaction Root Simulation Rule'
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  def _getInputMovementList(self, applied_rule):
+    """Return list of movements from delivery"""
+    delivery = applied_rule.getDefaultCausalityValue()
+    movement_list = []
+    delivery_movement_type_list = self.getPortalAccountingMovementTypeList()
+    if delivery is not None:
+      existing_movement_list = applied_rule.objectValues()
+      for movement in delivery.getMovementList(
+        portal_type=delivery_movement_type_list):
+        simulation_movement = self._getDeliveryRelatedSimulationMovement(
+          movement)
+        if simulation_movement is None or \
+               simulation_movement in existing_movement_list:
+          movement_list.append(movement)
+    return movement_list

product/ERP5Legacy/Document/DeliveryRootSimulationRule.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.DeliveryRule import DeliveryRule
+
+class DeliveryRootSimulationRule(DeliveryRule):
+  """
+  Delivery Root Simulation Rule is a root level rule for Deliveries.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Delivery Root Simulation Rule'
+  portal_type = 'Delivery Root Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  def _getExpandablePropertyUpdateDict(self, applied_rule, movement,
+                                       business_link, current_property_dict):
+    """Order rule specific update dictionary"""
+    return {
+      'delivery': movement.getRelativeUrl(),
+    }

product/ERP5Legacy/Document/DeliverySimulationRule.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.Rule import Rule
+
+class DeliverySimulationRule(Rule):
+  """
+  Delivery Simulation Rule expand simulation created by a order root
+  simulation rule or delivery root simulation rule.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Delivery Simulation Rule'
+  portal_type = 'Delivery Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
+  def expand(self, applied_rule, force=0, **kw):
+    """
+    Expands the rule:
+    - generate a list of previsions
+    - compare the prevision with existing children
+      - get the list of existing movements (immutable, mutable, deletable)
+      - compute the difference between prevision and existing (add,
+        modify, remove)
+    - add/modify/remove child movements to match prevision
+    """
+    return Rule._expand(self, applied_rule, force=force, **kw)
+
+  def isDeliverable(self, movement):
+    return movement.getResource() is not None

product/ERP5Legacy/Document/InvoiceRootSimulationRule.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.InvoiceRule import InvoiceRule
+
+class InvoiceRootSimulationRule(InvoiceRule):
+  """
+  Invoice Root Simulation Rule is a root level rule for Deliveries.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Invoice Root Simulation Rule'
+  portal_type = 'Invoice Root Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  def _getExpandablePropertyUpdateDict(self, applied_rule, movement,
+                                       business_link, current_property_dict):
+    """Order rule specific update dictionary"""
+    return {
+      'delivery': movement.getRelativeUrl(),
+    }

product/ERP5Legacy/Document/InvoiceSimulationRule.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.InvoicingRule import InvoicingRule
+
+class InvoiceSimulationRule(InvoicingRule):
+  """
+    Invoice Simulation Rule expand simulation created by a order or delivery rule.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Invoice Simulation Rule'
+  portal_type = 'Invoice Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)

product/ERP5Legacy/Document/InvoiceTransactionSimulationRule.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.InvoiceTransactionRule import InvoiceTransactionRule
+
+class InvoiceTransactionSimulationRule(InvoiceTransactionRule):
+  """
+  Invoice Transaction Simulation Rule object generates accounting movements for
+  each invoice movement based on category membership and other
+  predicated. Template accounting movements are stored in cells inside
+  an instance of the InvoiceTransactionRule.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Invoice Transaction Simulation Rule'
+  portal_type = 'Invoice Transaction Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)

product/ERP5Legacy/Document/OrderRootSimulationRule.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# 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 AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.OrderRule import OrderRule
+
+class OrderRootSimulationRule(OrderRule):
+  """
+  Order Rule object make sure an Order in the simulation
+  is consistent with the real order
+
+  WARNING: what to do with movement split ?
+  """
+  # CMF Type Definition
+  meta_type = 'ERP5 Order Root Simulation Rule'
+  portal_type = 'Order Root Simulation Rule'
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  def _getExpandablePropertyUpdateDict(self, applied_rule, movement,
+      business_link, current_property_dict):
+    """Order rule specific update dictionary"""
+    return {
+      'delivery': movement.getRelativeUrl(),
+    }

product/ERP5Legacy/Document/PaymentSimulationRule.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions
+from Products.ERP5Legacy.Document.Rule import Rule
+from Products.ERP5.Document.PredicateMatrix import PredicateMatrix
+
+class PaymentSimulationRule(Rule, PredicateMatrix):
+  """
+  Payment Simulation Rule generates payment simulation movements from
+  accounting / invoice transaction simulation movements.
+  """
+
+  # CMF Type Definition
+  meta_type = 'ERP5 Payment Simulation Rule'
+  portal_type = 'Payment Simulation Rule'
+  add_permission = Permissions.AddPortalContent
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  def _generatePrevisionList(self, applied_rule, **kw):
+    """
+    Generate a list of dictionaries, that contain calculated content of
+    current Simulation Movements in applied rule.
+    based on its context (parent movement, delivery, configuration ...)
+
+    These previsions are returned as dictionaries.
+
+    * source and destination (i.e. account) are provided by rule cells.
+    * start_date, stop_date and quantity are calculated according to
+      payment conditions.
+    """
+    # Find an input movement and using Payment Conditions.
+    # XXX we also need to support local Payment Conditions, that are not
+    # provided by BPM.
+    movement_and_tuple_list = self._getInputMovementAndPathTupleList(
+        applied_rule)
+    input_movement = movement_and_tuple_list[0][0]
+
+    payment_condition_list = []
+
+    # try to find local payment conditions from the upper level delivery
+    rule = applied_rule
+    movement = input_movement
+    delivery = movement.getDeliveryValue()
+    while delivery is None and not(rule.isRootAppliedRule()):
+      rule = movement.getParentValue()
+      movement = rule.getParentValue()
+      delivery = movement.getDeliveryValue()
+    if delivery is not None:
+      payment_condition_list = delivery.getPaymentConditionValueList()
+
+    # try to find payment conditions in specialised trade conditions
+    if len(payment_condition_list) == 0:
+      specialise = input_movement.getSpecialiseValue()
+      if specialise is None and delivery is not None:
+        specialise = delivery.getSpecialiseValue()
+      if specialise is not None:
+        payment_condition_list = specialise.getPaymentConditionValueList()
+
+    # try to use payment conditions in BPM configuration
+    if len(payment_condition_list) == 0:
+      payment_condition_list = [x[1] for x in movement_and_tuple_list if x[1] is not None]
+
+    kw = self._getExpandablePropertyDict(applied_rule, input_movement, None)
+    prevision_list = []
+
+    # Find a matching cell
+    cell = self._getMatchingCell(input_movement)
+
+    if cell is not None : # else, we do nothing
+      for payment_condition in payment_condition_list:
+        aggregated_ammount_list = payment_condition.getAggregatedAmountList(
+            input_movement, movement_list=[input_movement])
+        assert len(aggregated_ammount_list) == 1
+        aggregated_ammount = aggregated_ammount_list[0]
+        start_date = aggregated_ammount.getStartDate()
+        stop_date = aggregated_ammount.getStopDate()
+        quantity = aggregated_ammount.getQuantity()
+        payment_mode = payment_condition.getPaymentMode()
+
+        # one for payable
+        prevision_line = kw.copy()
+        prevision_line.update(
+          start_date=start_date,
+          stop_date=stop_date,
+          source=input_movement.getSource(),
+          destination=input_movement.getDestination(),
+          payment_mode=payment_mode,
+          quantity=-quantity
+          )
+        prevision_list.append(prevision_line)
+        # one for cash, bank etc.
+        payment_rule_cell_line_list = cell.objectValues()
+        assert len(payment_rule_cell_line_list) == 1
+        payment_rule_cell_line = payment_rule_cell_line_list[0]
+        prevision_line = kw.copy()
+        prevision_line.update(
+          start_date=start_date,
+          stop_date=stop_date,
+          source=payment_rule_cell_line.getSource(),
+          destination=payment_rule_cell_line.getDestination(),
+          payment_mode=payment_mode,
+          quantity=quantity
+          )
+        prevision_list.append(prevision_line)
+    return prevision_list
+
+  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
+  def expand(self, applied_rule, **kw):
+    """Expands the current movement downward.
+    """
+    return Rule._expand(self, applied_rule, **kw)
+
+  # Matrix related
+  security.declareProtected( Permissions.ModifyPortalContent,
+                              'newCellContent' )
+  def newCellContent(self, id, portal_type='Accounting Rule Cell', **kw):
+    """Overriden to specify default portal type
+    """
+    return self.newContent(id=id, portal_type=portal_type, **kw)