InvoiceRule.py 9.87 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
##############################################################################
#
# 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 AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5.Document.Rule import Rule

from zLOG import LOG

class InvoiceRule(Rule):
    """
      Invoice Rule object make sure an Invoice in the similation
      is consistent with the real invoice

      WARNING: what to do with movement split ?
    """

    # CMF Type Definition
    meta_type = 'ERP5 Invoice Rule'
    portal_type = 'Invoice Rule'
    add_permission = Permissions.AddPortalContent
    isPortalContent = 1
    isRADContent = 1

    # Declarative security
    security = ClassSecurityInfo()
    security.declareObjectProtected(Permissions.View)

    # Default Properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
                      )

    def test(self, movement):
      """
        Tests if the rule (still) applies
      """
      # An invoice rule never applies since it is always explicitely instanciated
      # This will change in the near future : invoice will be generated following a delivery
      return 0

    # Simulation workflow
    security.declareProtected(Permissions.ModifyPortalContent, 'expand')
    def expand(self, applied_rule, force=0, **kw):
      """
        Expands the current movement downward.

        -> new status -> expanded

        An applied rule can be expanded only if its parent movement
        is expanded.
      """
      invoice_line_type = 'Simulation Movement'

      # Get the invoice where we come from
      my_invoice = applied_rule.getDefaultCausalityValue()

      # Only expand if my_invoice is not None and state is not 'confirmed'
      if my_invoice is not None:
        # Only expand invoice rule if invoice not yet confirmed (This is consistent
        # with the fact that once simulation is launched, we stick to it)
        if force or \
           (applied_rule.getLastExpandSimulationState() not in applied_rule.getPortalReservedInventoryStateList() and \
           applied_rule.getLastExpandSimulationState() not in applied_rule.getPortalCurrentInventoryStateList()):
          # First, check each contained movement and make
          # a list of invoice_line ids which do not need to be copied
          # eventually delete movement which do not exist anylonger
          existing_uid_list = []
          for movement in applied_rule.contentValues(filter={'portal_type':applied_rule.getPortalMovementTypeList()}):
            invoice_element = movement.getDeliveryValue(portal_type=applied_rule.getPortalInvoiceMovementTypeList())
            if invoice_element is None:
              # Does not exist any longer
              movement.flushActivity(invoke=0)
              applied_rule._delObject(movement.getId())  # XXXX Make sur this is not deleted if already in delivery
            else:
              if getattr(invoice_element, 'isCell', 0):
                # It is a Cell
                existing_uid_list += [invoice_element.getUid()]
              elif invoice_element.hasCellContent():
                # Do not keep head of cells
                invoice_element.flushActivity(invoke=0)
                applied_rule._delObject(movement.getId())  # XXXX Make sur this is not deleted if already in delivery
              else:
                # It is a Line
                existing_uid_list += [invoice_element.getUid()]

          # Copy each movement (line or cell) from the invoice
          for invoice_line_object in my_invoice.contentValues(filter={'portal_type':applied_rule.getPortalInvoiceMovementTypeList()}):
            try:
              if invoice_line_object.hasCellContent():
                for c in invoice_line_object.getCellValueList():
                  #LOG('Cell  in', 0, '%s %s' % (c.getUid(), existing_uid_list))
                  if c.getUid() not in existing_uid_list:
                    new_id = invoice_line_object.getId() + '_' + c.getId()
                    #LOG('Create Cell', 0, str(new_id))
                    my_invoice.portal_types.constructContent(type_name=invoice_line_type,
                        container=applied_rule,
                        id=new_id,
                        delivery_value = c,
                        deliverable = 1
                    )
                    #LOG('After Create Cell', 0, str(new_id))
              else:
                if invoice_line_object.getUid() not in existing_uid_list:
                  new_id = invoice_line_object.getId()
                  #LOG('Line', 0, str(new_id))
                  my_invoice.portal_types.constructContent(type_name=invoice_line_type,
                      container=applied_rule,
                      id=new_id,
                      delivery_value = invoice_line_object,
                      deliverable = 1,
                  )
                  #LOG('After Create Cell', 0, str(new_id))
                  # Source, Destination, Quantity, Date, etc. are
                  # acquired from the invoice and need not to be copied.
            except AttributeError:
              LOG('ERP5: WARNING', 0, 'AttributeError during expand on invoice line %s'
                                                      % invoice_line_object.absolute_url())

          # Now we can set the last expand simulation state to the current state
          applied_rule.setLastExpandSimulationState(my_invoice.getSimulationState())

      # Pass to base class
      Rule.expand(self, applied_rule, force=force, **kw)

    security.declareProtected(Permissions.ModifyPortalContent, 'solve')
    def solve(self, applied_rule, solution_list):
      """
        Solve inconsitency according to a certain number of solutions
        templates. This updates the

        -> new status -> solved

        This applies a solution to an applied rule. Once
        the solution is applied, the parent movement is checked.
        If it does not diverge, the rule is reexpanded. If not,
        diverge is called on the parent movement.
      """

    security.declareProtected(Permissions.ModifyPortalContent, 'diverge')
    def diverge(self, applied_rule):
      """
        -> new status -> diverged

        This basically sets the rule to "diverged"
        and blocks expansion process
      """

    # Solvers
    security.declareProtected(Permissions.View, 'isDivergent')
    def isDivergent(self, applied_rule):
      """
        Returns 1 if divergent rule
      """

    security.declareProtected(Permissions.View, 'getDivergenceList')
    def getDivergenceList(self, applied_rule):
      """
        Returns a list Divergence descriptors
      """

    security.declareProtected(Permissions.View, 'getSolverList')
    def getSolverList(self, applied_rule):
      """
        Returns a list Divergence solvers
      """

    # Deliverability / orderability
    def isOrderable(self, m):
      return 1

    def isDeliverable(self, m):
      if m.getSimulationState() in draft_order_state:
        return 0
      return 1

    def collectSimulationMovements(self, applied_rule):
      LOG("invoiceRule", 0, "collected")

      # get every movement we want to group
      movement_list = []
      for simulation_movement in applied_rule.contentValues() :
        for rule in simulation_movement() :
          for sub_simulation_movement in rule.contentValues() :
            movement_list += [sub_simulation_movement ]

      # group movements
      root_group = self.portal_simulation.collectMovement(movement_list=movement_list, class_list=[CategoryMovementGroup])

      invoice = applied_rule.getCausalityValue()
      existing_transaction_line_id_list = invoice.contentIds()
      # sum quantities and add lines to invoice
      for group in root_group.group_list :
        orig_group_id = group.movement_list[0].getId()
        quantity = 0
        for movement in group.movement_list :
          quantity += movement.getQuantity()
        # Guess an unused name for the new movement
        if orig_group_id in existing_transaction_line_id_list :
          n = 1
          while '%s_%s' % (orig_group_id, n) in existing_transaction_line_id_list :
            n += 1
          group_id = '%s_%s' % (orig_group_id, n)
        else :
          group_id = orig_group_id
        existing_transaction_line_id_list.append(group_id)

        # add sum of movements to invoice
        invoice.newContent(portal_type = 'Accounting Transaction Line'
          , id = group_id
          , source = group.movement_list[0].getSource()
          , destination = group.movement_list[0].getDestination()
          , quantity = quantity
          )

      return