InvoiceTransactionRule.py 18 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
##############################################################################
#
# 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
30
from Products.ERP5Type import Permissions, PropertySheet, Constraint, interfaces
31
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
  """
    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
48

49 50 51 52 53
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

#### Helper method for expand
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
  def _generatePrevisionListBPM(self, applied_rule, **kw):
    """
    Generate a list of movements, that should be children of this rule,
    based on its context (parent movement, delivery, configuration ...)

    These previsions are actually returned as dictionaries.
    """
    input_movement, business_path = self._getInputMovementAndPathTupleList(
        applied_rule)[0]
    prevision_list = []

    # Find a matching cell
    cell = self._getMatchingCell(input_movement)

    if cell is not None : # else, we do nothing
      for accounting_rule_cell_line in cell.objectValues() :
        # 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 = input_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)
            if (resource is None) and \
               (simulation_movement.getParentValue().getParentValue() \
                                      == portal_simulation) :
              # we are on the first simulation movement, we'll try
              # to get the resource from it's order price currency.
              order = simulation_movement.getOrderValue()
              if order is not None:
                resource = order.getProperty('price_currency', None)
            simulation_movement = simulation_movement\
                                        .getParentValue().getParentValue()
        if resource is None :
          # last resort : get the resource from the rule
          resource = accounting_rule_cell_line.getResource() \
              or cell.getResource()
        prevision_line = {}
        prevision_line.update(**self._getExpandablePropertyDict(applied_rule,
          input_movement, business_path))

        prevision_line.update(
          source_list = [accounting_rule_cell_line.getSource()],
          destination_list = [accounting_rule_cell_line.getDestination()],
          quantity = (input_movement.getCorrectedQuantity() *
            input_movement.getPrice(0.0)) *
            accounting_rule_cell_line.getQuantity(),
          resource_list = [resource],
          price = 1,
        )
        if resource is not None:
          #set asset_price on movement when resource is different from price
          #currency of the source/destination section
          destination_exchange_ratio, precision = self \
              ._getCurrencyRatioAndPrecisionByArrow(
              'destination_section', prevision_line)
          if destination_exchange_ratio is not None:
            prevision_line.update(destination_total_asset_price=round(
             (destination_exchange_ratio*
              applied_rule.getParentValue().getTotalPrice()),precision))

          source_exchange_ratio, precision = self \
              ._getCurrencyRatioAndPrecisionByArrow(
              'source_section', prevision_line)
          if source_exchange_ratio is not None:
            prevision_line.update(source_total_asset_price=round(
             (source_exchange_ratio*
              applied_rule.getParentValue().getTotalPrice()),precision))

        if accounting_rule_cell_line.hasProperty(
            'generate_prevision_script_id'):
          generate_prevision_script_id = \
                accounting_rule_cell_line.getGeneratePrevisionScriptId()
          prevision_line.update(getattr(input_movement,
                              generate_prevision_script_id)(prevision_line))
        prevision_list.append(prevision_line)
    return prevision_list

147
  def _generatePrevisionList(self, applied_rule, **kw):
148
    """
149 150
    Generate a list of movements, that should be children of this rule,
    based on its context (parent movement, delivery, configuration ...)
151

152 153
    These previsions are acrually returned as dictionaries.
    """
154
    if self._isBPM():
155
      return self._generatePrevisionListBPM(applied_rule, **kw)
156 157
    prevision_list = []
    context_movement = applied_rule.getParentValue()
158

159 160 161 162
    # Find a matching cell
    cell = self._getMatchingCell(context_movement)

    if cell is not None : # else, we do nothing
163
      for accounting_rule_cell_line in cell.objectValues() :
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
        # 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)
186
            if (resource is None) and \
187 188
               (simulation_movement.getParentValue().getParentValue() \
                                      == portal_simulation) :
189 190 191
              # we are on the first simulation movement, we'll try
              # to get the resource from it's order price currency.
              order = simulation_movement.getOrderValue()
192 193
              if order is not None:
                resource = order.getProperty('price_currency', None)
194 195 196 197
            simulation_movement = simulation_movement\
                                        .getParentValue().getParentValue()
        if resource is None :
          # last resort : get the resource from the rule
198
          resource = accounting_rule_cell_line.getResource() or cell.getResource()
199 200 201 202
          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())
203
        # XXX Harcoded list
204
        prevision_line = {
205
            'source': accounting_rule_cell_line.getSource(),
206
            'source_section': context_movement.getSourceSection(),
207 208 209 210 211
            '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(),
212
            'destination': accounting_rule_cell_line.getDestination(),
213
            'destination_section': context_movement.getDestinationSection(),
214 215 216 217 218
            '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(),
219 220
            'start_date': context_movement.getStartDate(),
            'stop_date': context_movement.getStopDate(),
221
            'resource': resource,
222
#               'variation_category_list': \
223
#                   accounting_rule_cell_line.getVariationCategoryList(),
224
#               'variation_property_dict': \
225 226 227
#                   accounting_rule_cell_line.getVariationPropertyDict(),
#               'aggregate_list': accounting_rule_cell_line.getAggregateList(),
#               'price_currency': accounting_rule_cell_line.getPriceCurrency(),
228
            # calculate (quantity * price) * cell_quantity
229
            'quantity': (context_movement.getCorrectedQuantity() *
230 231
              context_movement.getPrice(0.0)) * accounting_rule_cell_line.getQuantity(),
#               'quantity_unit': accounting_rule_cell_line.getQuantityUnit(),
232
            'price': 1,
233 234
            'force_update': 1,
            }
235 236 237 238 239 240

        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))
241 242 243 244 245 246 247 248 249 250 251 252 253 254
        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
    """
255 256 257 258
    if self._isBPM():
      Rule.expand(self, applied_rule, force=force, **kw)
      return

259 260
    add_list, modify_dict, \
        delete_list = self._getCompensatedMovementList(applied_rule,
261 262 263
        matching_property_list=['resource', 'source',
               'destination','destination_total_asset_price',
              'source_total_asset_price'],**kw)
264 265 266 267 268 269

    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)
270

271 272 273 274 275 276 277 278 279 280 281
    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)
282 283 284
      #set asset_price on movement when resource is different from price
      #currency of the source/destination section
      currency = new_mvmt.getResourceValue()
285
      if currency is not None:
286 287 288
        currency_url = currency.getRelativeUrl()
        dest_section = new_mvmt.getDestinationSectionValue()
        if dest_section is not None:
289
          dest_currency_url = dest_section.getProperty('price_currency', None)
290
        else:
291 292
          dest_currency_url = None
        if dest_currency_url is not None and currency_url != dest_currency_url:
293
          precision = dest_section.getPriceCurrencyValue().getQuantityPrecision()
294
          dest_exchange_ratio = currency.getPrice(context=new_mvmt.asContext(
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
295
            categories=['price_currency/%s' % dest_currency_url,
296 297
                        'resource/%s' % currency_url],
            start_date=new_mvmt.getStartDate()))
298
          if dest_exchange_ratio is not None:
299
            new_mvmt.edit(destination_total_asset_price=round(
300
             (dest_exchange_ratio*
301
              applied_rule.getParentValue().getTotalPrice()),precision))
302 303 304

        source_section = new_mvmt.getSourceSectionValue()
        if source_section is not None:
305
          source_currency_url = source_section.getProperty('price_currency', None)
306
        else:
307 308
          source_currency_url = None
        if source_currency_url is not None and currency_url != source_currency_url:
309
          precision = source_section.getPriceCurrencyValue().getQuantityPrecision()
310
          source_exchange_ratio = currency.getPrice(context=new_mvmt.asContext(
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
311
            categories=['price_currency/%s' % source_currency_url,
312
                        'resource/%s' % currency_url],
313
            start_date=new_mvmt.getStartDate()))
314 315
          if source_exchange_ratio is not None:
            new_mvmt.setSourceTotalAssetPrice(round(
316
       source_exchange_ratio*applied_rule.getParentValue().getTotalPrice(),
317
            precision))
318

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

322 323 324
  # Matrix related
  security.declareProtected( Permissions.ModifyPortalContent,
                              'newCellContent' )
325
  def newCellContent(self, id, portal_type='Accounting Rule Cell', **kw):
326
    """Overriden to specify default portal type
327
    """
328
    return self.newContent(id=id, portal_type=portal_type, **kw)
329

330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
  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
    """

353 354 355 356 357 358
#   # Solvers
#   security.declareProtected(Permissions.View, 'isDivergent')
#   def isDivergent(self, applied_rule):
#     """
#       Returns 1 if divergent rule
#     """
359
#
360 361 362 363 364
#   security.declareProtected(Permissions.View, 'getDivergenceList')
#   def getDivergenceList(self, applied_rule):
#     """
#       Returns a list Divergence descriptors
#     """
365
#
366 367 368 369 370
#   security.declareProtected(Permissions.View, 'getSolverList')
#   def getSolverList(self, applied_rule):
#     """
#       Returns a list Divergence solvers
#     """
371 372 373 374 375 376 377 378 379

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

  def isDeliverable(self, m):
    if m.getSimulationState() in self.getPortalDraftOrderStateList():
      return 0
    return 1
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

  def _getCurrencyRatioAndPrecisionByArrow(self, arrow, prevision_line):
    from Products.ERP5Type.Document import newTempSimulationMovement
    try:
      prevision_currency = prevision_line['resource_list'][0]
    except IndexError:
      prevision_currency = None
    temporary_movement = newTempSimulationMovement(self.getPortalObject(),
        '1', **prevision_line)
    exchange_ratio = None
    precision = None
    try:
      section = prevision_line['%s_list' % arrow][0]
    except IndexError:
      section = None
    if section is not None:
      currency_url = self.restrictedTraverse(section).getProperty(
          'price_currency', None)
    else:
      currency_url = None
    if currency_url is not None and prevision_currency != currency_url:
      precision = section.getPriceCurrencyValue() \
          .getQuantityPrecision()
      exchange_ratio = self.restrictedTraverse(currency_url).getPrice(
          context=temporary_movement.asContext(
        categories=['price_currency/%s' % currency_url,
                    'resource/%s' % prevision_currency],
        start_date=temporary_movement.getStartDate()))
    return exchange_ratio, precision