TradeCondition.py 10.3 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>
8
#                    Fabien Morin <fabien@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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

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

Fabien Morin's avatar
Fabien Morin committed
40 41 42
# XXX TODO : getTradeModelLineComposedList and findSpecialiseValueList should
# probably move to Transformation (better names sould be used)

43 44
class CircularException(Exception): pass

45
class TradeCondition(Path, Transformation):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46 47 48 49 50
    """
      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
    """
51 52
    edited_property_list = ['price', 'causality','resource','quantity',
        'base_application_list', 'base_contribution_list']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55

    meta_type = 'ERP5 Trade Condition'
    portal_type = 'Trade Condition'
56
    model_line_portal_type_list = ('Trade Model Line',)
57
    isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
58 59 60

    # Declarative security
    security = ClassSecurityInfo()
61
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63 64 65 66 67

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

Fabien Morin's avatar
Fabien Morin committed
75 76
    security.declareProtected(Permissions.ModifyPortalContent,
                              'updateAggregatedAmountList')
77
    def updateAggregatedAmountList(self, context, **kw):
Fabien Morin's avatar
Fabien Morin committed
78 79
      '''
        updates exisiting movement and returns new if any
80 81
        return a dict of list of movement 'movement_to_add_list' and
        'movement_to_delete_list'
Fabien Morin's avatar
Fabien Morin committed
82
      '''
83
      existing_movement_list = context.getMovementList()
84
      aggregated_amount_list = self.getAggregatedAmountList(context=context,
85 86
          **kw)
      modified_resource_list = []
87 88 89 90
      normal_use_list = self.getPortalObject().portal_preferences\
              .getPreferredNormalResourceUseCategoryList()
      # check if the existing movements are in aggregated movments
      movement_to_delete_list = []
91
      movement_to_add_list = []
92
      if len(aggregated_amount_list):
93
        for movement in existing_movement_list:
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
          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}
122

123 124
    security.declareProtected(Permissions.AccessContentsInformation,
        'findSpecialiseValueList')
125 126
    def findSpecialiseValueList(self, context, portal_type_list=None,
        visited_trade_condition_list=None):
127 128 129
      '''Return a list of object. The list will represent the inheritance tree.
      It uses Breadth First Search.
      '''
130 131
      if visited_trade_condition_list is None:
        visited_trade_condition_list = []
132 133 134 135 136 137 138 139 140 141 142
      specialise_value_list = []
      if portal_type_list is None:
        portal_type_list = [self.getPortalType()]
      if context.getPortalType() in portal_type_list:
        specialise_value_list.append(context)
      for specialise in context.getSpecialiseValueList(portal_type=\
          portal_type_list):
        if specialise in visited_trade_condition_list:
          raise CircularException
        visited_trade_condition_list.append(specialise)
        specialise_value_list.extend(self.findSpecialiseValueList(context=specialise,
143 144
          portal_type_list=portal_type_list,
          visited_trade_condition_list=visited_trade_condition_list))
145 146
      return specialise_value_list

Fabien Morin's avatar
Fabien Morin committed
147 148
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTradeModelLineComposedList')
149
    def getTradeModelLineComposedList(self, context=None, portal_type_list=None):
150 151
      """
      Returns list of Trade Model Lines using composition
152
      Reference of Trade Model Line is used to hide other Trade Model Line
153
      In chain first found Trade Model Line has precedence
154
      Context's, if not None, Trade Model Lines have precedence
155 156
      Result is sorted in safe order to do one time pass - movements which
      applies are before its possible contributions.
157
      """
158 159
      if portal_type_list is None:
        portal_type_list = self.model_line_portal_type_list
160

161
      reference_list = []
162 163 164
      trade_model_line_composed_list = []
      containting_object_list = []
      if context is not None:
165 166
        document = context
        if getattr(context, 'getExplanationValue', None) is not None:
167 168
          # if context is movement it is needed to ask its explanation
          # for contained Trade Model Lines
169 170
          document = context.getExplanationValue()
        containting_object_list.append(document)
171
      containting_object_list.extend(self.findSpecialiseValueList(self))
172 173 174

      for specialise in containting_object_list:
        for trade_model_line in specialise.contentValues(
175
            portal_type=portal_type_list):
176
          reference = trade_model_line.getReference()
177
          if reference not in reference_list or reference is None:
178
            reference_list.append(reference)
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
            base_contribution_list = trade_model_line \
              .getBaseContributionList()
            if len(base_contribution_list) == 0:
              # when movement will not generate anything which contributes
              # it is safe to be last on list
              trade_model_line_composed_list.append(trade_model_line)
            else:
              # if movements contributes to anything it have to be placed
              # just before to what it contributes
              index = 0
              inserted = False
              for old_trade_model_line in trade_model_line_composed_list:
                for base_application in old_trade_model_line \
                  .getBaseApplicationList():
                  if base_application in base_contribution_list:
                    trade_model_line_composed_list.insert(index,
                        trade_model_line)
                    inserted = True
                    break
                if inserted:
                  break
                index += 1
              if not inserted:
                # last resort - nothing was found, it is safe to put movement
                # in beginning of list
                trade_model_line_composed_list.insert(0, trade_model_line)
Fabien Morin's avatar
Fabien Morin committed
205

206
      return trade_model_line_composed_list
207

Fabien Morin's avatar
Fabien Morin committed
208 209
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
210
    def getAggregatedAmountList(self, context, movement_list=None, **kw):
211 212
      result = AggregatedAmountList()

213 214 215
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

216
      need_to_run = 1
217 218
      if movement_list is None:
        movement_list = []
219 220
      while need_to_run:
        need_to_run = 0
Fabien Morin's avatar
Fabien Morin committed
221 222
        for model_line in trade_model_line_composed_list:
          model_line_result = model_line.getAggregatedAmountList(context,
223 224
            movement_list=movement_list,
            current_aggregated_amount_list=result,
225
            **kw)
Fabien Morin's avatar
Fabien Morin committed
226
          result.extend(model_line_result)
227 228 229
        if len(result) != len(movement_list):
          # something was added
          need_to_run = 1
230
          movement_list = result
231

232 233 234
      # remove movement that should not be created
      final_list = []
      for movement in result:
235
        if movement.getCausalityValue().getCreateLine():
236 237
          final_list.append(movement)
      return final_list