TradeCondition.py 7.61 KB
Newer Older
Yusei Tahara's avatar
Yusei Tahara committed
1
# -*- coding: utf-8 -*-
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
    model_line_portal_type_list = ('Trade Model Line',)
53
    isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
54 55 56

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

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

71
    def updateAggregatedAmountList(self, context, **kw):
Fabien Morin's avatar
Fabien Morin committed
72 73
      '''
        updates exisiting movement and returns new if any
74 75
        return a dict of list of movement 'movement_to_add_list' and
        'movement_to_delete_list'
Fabien Morin's avatar
Fabien Morin committed
76
      '''
77
      existing_movement_list = context.getMovementList()
78
      aggregated_amount_list = self.getAggregatedAmountList(context=context,
79 80
          **kw)
      modified_resource_list = []
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 = []
85
      movement_to_add_list = []
86
      if len(aggregated_amount_list):
87
        for movement in existing_movement_list:
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
          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}
116

117
    def getTradeModelLineComposedList(self, context=None):
118 119
      """
      Returns list of Trade Model Lines using composition
120
      Resource of Trade Model Line is used to hide other Trade Model Line
121
        XXX - wrong - use reference to hide
122
      In chain first found Trade Model Line has precedence
123 124 125
      Context's, if not None, Trade Model Lines have precedence
        XXX - the sorting is missing
      """
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
      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:
142 143
        document = context
        if getattr(context, 'getExplanationValue', None) is not None:
144 145
          # if context is movement it is needed to ask its explanation
          # for contained Trade Model Lines
146 147
          document = context.getExplanationValue()
        containting_object_list.append(document)
148 149 150 151
      containting_object_list.extend(findSpecialiseValueList(self))

      for specialise in containting_object_list:
        for trade_model_line in specialise.contentValues(
152
            portal_type=self.model_line_portal_type_list):
153 154 155 156 157 158
          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

159 160 161
    def getAggregatedAmountList(self, context, **kw):
      result = AggregatedAmountList()

162 163 164
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

165 166 167 168
      need_to_run = 1
      movement_list = []
      while need_to_run:
        need_to_run = 0
Fabien Morin's avatar
Fabien Morin committed
169 170
        for model_line in trade_model_line_composed_list:
          model_line_result = model_line.getAggregatedAmountList(context,
171 172
            movement_list=movement_list,
            current_aggregated_amount_list=result,
173
            **kw)
Fabien Morin's avatar
Fabien Morin committed
174
          result.extend(model_line_result)
175 176 177 178 179 180
        if len(result) != len(movement_list):
          # something was added
          need_to_run = 1
        movement_list = result

      return result