InvoiceTransactionRule.py 12.8 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
##############################################################################
#
# 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
32
from Products.ERP5.Document.PredicateMatrix import PredicateMatrix
33

34
from zLOG import LOG, BLATHER, INFO, PROBLEM
35

36
class InvoiceTransactionRule(Rule, PredicateMatrix):
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
  """
    Invoice Transaction 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 Rule'
  portal_type = 'Invoice Transaction Rule'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  __implements__ = ( Interface.Predicate,
                     Interface.Rule )

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
63
                    , PropertySheet.Task
64 65 66 67
                    )
  
#### Helper method for expand
  def _generatePrevisionList(self, applied_rule, **kw):
68
    """
69 70
    Generate a list of movements, that should be children of this rule,
    based on its context (parent movement, delivery, configuration ...)
71

72 73 74 75
    These previsions are acrually returned as dictionaries.
    """
    prevision_list = []
    context_movement = applied_rule.getParentValue()
76

77 78 79 80
    # Find a matching cell
    cell = self._getMatchingCell(context_movement)

    if cell is not None : # else, we do nothing
81
      for accounting_rule_cell_line in cell.objectValues() :
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
        # get the resource (in that order):
        #  * resource from the invoice (using deliveryValue)
        #  * price_currency from the invoice
        #  * price_currency from the parents simulation movement's
        # deliveryValue
        #  * price_currency from the top level simulation movement's
        # orderValue
        resource = None
        invoice_line = context_movement.getDeliveryValue()
        if invoice_line is not None :
          invoice = invoice_line.getExplanationValue()
          resource = invoice.getProperty('resource',
                     invoice.getProperty('price_currency', None))
        if resource is None :
          # search the resource on parents simulation movement's deliveries
          simulation_movement = applied_rule.getParentValue()
          portal_simulation = self.getPortalObject().portal_simulation
          while resource is None and \
                      simulation_movement != portal_simulation :
            delivery = simulation_movement.getDeliveryValue()
            if delivery is not None:
              resource = delivery.getProperty('price_currency', None)
104
            if (resource is None) and \
105 106
               (simulation_movement.getParentValue().getParentValue() \
                                      == portal_simulation) :
107 108 109
              # we are on the first simulation movement, we'll try
              # to get the resource from it's order price currency.
              order = simulation_movement.getOrderValue()
110 111
              if order is not None:
                resource = order.getProperty('price_currency', None)
112 113 114 115
            simulation_movement = simulation_movement\
                                        .getParentValue().getParentValue()
        if resource is None :
          # last resort : get the resource from the rule
116
          resource = accounting_rule_cell_line.getResource() or cell.getResource()
117 118 119 120
          if resource in (None, '') :
            # XXX this happen in many order, so this log is probably useless
            LOG("InvoiceTransactionRule", PROBLEM,
                "expanding %s: without resource" % applied_rule.getPath())
121
        # XXX Harcoded list
122
        prevision_line = {
123 124
            'id': accounting_rule_cell_line.getId(),
            'source': accounting_rule_cell_line.getSource(),
125
            'source_section': context_movement.getSourceSection(),
126 127 128 129 130
            'source_decision': context_movement.getSourceDecision(),
            'source_administration': context_movement.getSourceAdministration(),
            'source_project': context_movement.getSourceProject(),
            'source_function': context_movement.getSourceFunction(),
            'source_payment': context_movement.getSourcePayment(),
131
            'destination': accounting_rule_cell_line.getDestination(),
132
            'destination_section': context_movement.getDestinationSection(),
133 134 135 136 137
            'destination_decision': context_movement.getDestinationDecision(),
            'destination_administration': context_movement.getDestinationAdministration(),
            'destination_project': context_movement.getDestinationProject(),
            'destination_function': context_movement.getDestinationFunction(),
            'destination_payment': context_movement.getDestinationPayment(),
138 139
            'start_date': context_movement.getStartDate(),
            'stop_date': context_movement.getStopDate(),
140
            'resource': resource,
141
#               'variation_category_list': \
142
#                   accounting_rule_cell_line.getVariationCategoryList(),
143
#               'variation_property_dict': \
144 145 146 147
#                   accounting_rule_cell_line.getVariationPropertyDict(),
#               'aggregate_list': accounting_rule_cell_line.getAggregateList(),
#               'price': accounting_rule_cell_line.getPrice(),
#               'price_currency': accounting_rule_cell_line.getPriceCurrency(),
148
            # calculate (quantity * price) * cell_quantity
149
            'quantity': (context_movement.getCorrectedQuantity() *
150 151
              context_movement.getPrice(0.0)) * accounting_rule_cell_line.getQuantity(),
#               'quantity_unit': accounting_rule_cell_line.getQuantityUnit(),
152 153
            'force_update': 1,
            }
154 155 156 157 158 159

        if accounting_rule_cell_line.hasProperty('generate_prevision_script_id'):
          generate_prevision_script_id = \
                accounting_rule_cell_line.getGeneratePrevisionScriptId()
          prevision_line.update(getattr(context_movement,
                                        generate_prevision_script_id)(prevision_line))
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
        prevision_list.append(prevision_line)
    return prevision_list

  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
    """
    add_list, modify_dict, \
        delete_list = self._getCompensatedMovementList(applied_rule,
176 177 178
        matching_property_list=['resource', 'source',
               'destination','destination_total_asset_price',
              'source_total_asset_price'],**kw)
179 180 181 182 183 184

    if len(add_list) or len(modify_dict):
      pass#import pdb; pdb.set_trace()

    for movement_id in delete_list:
      applied_rule._delObject(movement_id)
185
      
186 187 188 189 190 191 192 193 194 195 196
    for movement, prop_dict in modify_dict.items():
      applied_rule[movement].edit(**prop_dict)

    for movement_dict in add_list:
      if 'id' in movement_dict.keys():
        mvmt_id = applied_rule._get_id(movement_dict.pop('id'))
        new_mvmt = applied_rule.newContent(id=mvmt_id,
            portal_type=self.movement_type)
      else:
        new_mvmt = applied_rule.newContent(portal_type=self.movement_type)
      new_mvmt.edit(**movement_dict)
197 198 199
      #set asset_price on movement when resource is different from price
      #currency of the source/destination section
      currency = new_mvmt.getResourceValue()
200
      if currency is not None:
201 202 203
        currency_url = currency.getRelativeUrl()
        dest_section = new_mvmt.getDestinationSectionValue()
        if dest_section is not None:
204
          dest_currency_url = dest_section.getProperty('price_currency', None)
205
        else:
206 207
          dest_currency_url = None
        if dest_currency_url is not None and currency_url != dest_currency_url:
208
          precision = dest_section.getPriceCurrencyValue().getQuantityPrecision()
209
          dest_exchange_ratio = currency.getPrice(context=new_mvmt.asContext(
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
210
            categories=['price_currency/%s' % dest_currency_url,
211 212
                        'resource/%s' % currency_url],
            start_date=new_mvmt.getStartDate()))
213
          if dest_exchange_ratio is not None:
214
            new_mvmt.edit(destination_total_asset_price=round(
215
             (dest_exchange_ratio*
216
              applied_rule.getParentValue().getTotalPrice()),precision))
217 218 219

        source_section = new_mvmt.getSourceSectionValue()
        if source_section is not None:
220
          source_currency_url = source_section.getProperty('price_currency', None)
221
        else:
222 223
          source_currency_url = None
        if source_currency_url is not None and currency_url != source_currency_url:
224
          precision = source_section.getPriceCurrencyValue().getQuantityPrecision()
225
          source_exchange_ratio = currency.getPrice(context=new_mvmt.asContext(
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
226
            categories=['price_currency/%s' % source_currency_url,
227
                        'resource/%s' % currency_url],
228
            start_date=new_mvmt.getStartDate()))
229 230 231
          if source_exchange_ratio is not None:
            new_mvmt.setSourceTotalAssetPrice(round(
       (source_exchange_ratio*applied_rule.getParentValue().getTotalPrice()),
232
            precision))
233
      
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    # Pass to base class
    Rule.expand(self, applied_rule, force=force, **kw)
  
  # Matrix related
  security.declareProtected( Permissions.ModifyPortalContent,
                              'newCellContent' )
  def newCellContent(self, id, **kw):
    """
      Creates a new Cell.
    """
    self.invokeFactory(type_name='Accounting Rule Cell', id=id)
    new_cell = self.get(id)
    return new_cell
  
  security.declareProtected(Permissions.ModifyPortalContent, 'solve')
  def solve(self, applied_rule, solution_list):
    """
      Solve inconsistency 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
    """

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
#   # 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
#     """
289 290 291 292 293 294 295 296 297 298

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

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