TradeCondition.py 7.4 KB
Newer Older
1
# -*- coding: utf8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3
##############################################################################
#
4
# Copyright (c) 2002-2009 Nexedi SA and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
6
#                    Romain Courteaud <romain@nexedi.com>
7
#                    Łukasz Nowak <luke@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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

34
from Products.ERP5Type import Permissions, PropertySheet
35
from Products.ERP5.Document.Transformation import Transformation
36
from Products.ERP5.Document.Path import Path
37
from Products.ERP5.AggregatedAmountList import AggregatedAmountList
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38

39 40
class CircularException(Exception): pass

41
class TradeCondition(Path, Transformation):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46
    """
      Trade Conditions are used to store the conditions (payment, logistic,...)
      which should be applied (and used in the orders) when two companies make
      business together
    """
47 48
    edited_property_list = ['price', 'causality','resource','quantity',
        'base_application_list', 'base_contribution_list']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
49 50 51

    meta_type = 'ERP5 Trade Condition'
    portal_type = 'Trade Condition'
52
    isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55

    # Declarative security
    security = ClassSecurityInfo()
56
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59 60 61 62

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.DublinCore
Yoshinori Okuji's avatar
Yoshinori Okuji committed
63
                      , PropertySheet.Folder
64
                      , PropertySheet.Comment
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65 66
                      , PropertySheet.Arrow
                      , PropertySheet.TradeCondition
67
                      , PropertySheet.Order
Jean-Paul Smets's avatar
Jean-Paul Smets committed
68 69
                      )

70
    def updateAggregatedAmountList(self, context, **kw):
Fabien Morin's avatar
Fabien Morin committed
71 72
      '''
        updates exisiting movement and returns new if any
73 74
        return a dict of list of movement 'movement_to_add_list' and
        'movement_to_delete_list'
Fabien Morin's avatar
Fabien Morin committed
75
      '''
76
      existing_movement_list = context.getMovementList()
77 78 79
      aggregated_amount_list = self.getAggregatedAmountList(context = context,
          **kw)
      modified_resource_list = []
80 81 82 83 84
      normal_use_list = self.getPortalObject().portal_preferences\
              .getPreferredNormalResourceUseCategoryList()
      # check if the existing movements are in aggregated movments
      movement_to_delete_list = []
      if len(aggregated_amount_list):
85
        for movement in existing_movement_list:
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
          keep_movement = False
          for amount in aggregated_amount_list:
            # here we have to check if the movement is a generated one or
            # entered by the user. If it has been entered by user, we have to
            # keep it.
            # if movement is generated and if not exist, append to delete list
            # else, break
            resource = movement.getResourceValue()
            if resource is not None and \
                len(set(normal_use_list).intersection(set(resource\
                .getUseList()))):
              keep_movement = True
              break
            update_kw = {}
            for p in self.edited_property_list:
              update_kw[p] = amount.getProperty(p)
            if movement.getProperty('resource') == update_kw['resource'] and\
                movement.getVariationCategoryList() == \
                amount.getVariationCategoryList():
              movement.edit(**update_kw)
              modified_resource_list.append(update_kw['resource'])
              keep_movement = True
          if not keep_movement:
            movement_to_delete_list.append(movement)
        movement_to_add_list = [amount for amount in aggregated_amount_list if
            amount.getResource() not in modified_resource_list]
      return {'movement_to_delete_list' : movement_to_delete_list,
              'movement_to_add_list': movement_to_add_list}
114

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    def getTradeModelLineComposedList(self, context=None):
      """Returns list of Trade Model Lines using composition
      Resource of Trade Model Line is used to hide other Trade Model Line
      In chain first found Trade Model Line has precedence
      Context's, if not None, Trade Model Lines have precedence"""
      visited_trade_condition_list = []
      def findSpecialiseValueList(context):
        specialise_value_list = []
        if context.getPortalType() in self.getPortalType():
          specialise_value_list.append(context)
        for specialise in context.getSpecialiseValueList():
          if specialise in visited_trade_condition_list:
            raise CircularException
          visited_trade_condition_list.append(specialise)
          specialise_value_list.extend(findSpecialiseValueList(specialise))
        return specialise_value_list

      resource_list = []
      trade_model_line_composed_list = []
      containting_object_list = []
      if context is not None:
136 137
        document = context
        if getattr(context, 'getExplanationValue', None) is not None:
138 139
          # if context is movement it is needed to ask its explanation
          # for contained Trade Model Lines
140 141
          document = context.getExplanationValue()
        containting_object_list.append(document)
142 143 144 145 146 147 148 149 150 151 152
      containting_object_list.extend(findSpecialiseValueList(self))

      for specialise in containting_object_list:
        for trade_model_line in specialise.contentValues(
            portal_type='Trade Model Line'):
          resource = trade_model_line.getResource()
          if resource not in resource_list:
            trade_model_line_composed_list.append(trade_model_line)
            resource_list.append(resource)
      return trade_model_line_composed_list

153 154 155
    def getAggregatedAmountList(self, context, **kw):
      result = AggregatedAmountList()

156 157 158
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

159 160 161 162
      need_to_run = 1
      movement_list = []
      while need_to_run:
        need_to_run = 0
163
        for model in trade_model_line_composed_list:
164
          model_result = model.getAggregatedAmountList(context,
165 166
            movement_list = movement_list,
            current_aggregated_amount_list = result,
167 168 169 170 171 172 173 174
            **kw)
          result.extend(model_result)
        if len(result) != len(movement_list):
          # something was added
          need_to_run = 1
        movement_list = result

      return result