TradeCondition.py 19.2 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, interfaces
36
from Products.ERP5.Document.Transformation import Transformation
37
from Products.ERP5.Document.Path import Path
38
from Products.ERP5.AggregatedAmountList import AggregatedAmountList
39
from Products.ERP5Type.XMLMatrix import XMLMatrix
40
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41

42 43
import zope.interface

Fabien Morin's avatar
Fabien Morin committed
44
# XXX TODO : getTradeModelLineComposedList and findSpecialiseValueList should
Fabien Morin's avatar
Fabien Morin committed
45
# probably move to Transformation (better names should be used)
46 47
# XXX TODO: review naming of new methods
# XXX WARNING: current API naming may change although model should be stable.
Fabien Morin's avatar
Fabien Morin committed
48

49
class TradeCondition(Path, Transformation, XMLMatrix):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51 52 53 54
    """
      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
    """
55
    edited_property_list = ['price', 'resource', 'quantity',
56
        'reference', 'base_application_list', 'base_contribution_list']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59

    meta_type = 'ERP5 Trade Condition'
    portal_type = 'Trade Condition'
60
    model_line_portal_type_list = ('Trade Model Line',)
61
    isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63 64

    # Declarative security
    security = ClassSecurityInfo()
65
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
66 67 68 69 70 71

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

79 80
    zope.interface.implements(interfaces.ITransformation)

81
    security.declareProtected(Permissions.AccessContentsInformation,
Fabien Morin's avatar
Fabien Morin committed
82
                              'updateAggregatedAmountList')
83
    def updateAggregatedAmountList(self, context, movement_list=None, rounding=None, **kw):
84
      existing_movement_list = context.getMovementList()
85
      aggregated_amount_list = self.getAggregatedAmountList(context=context,
86
          movement_list=movement_list, **kw)
87
      modified_reference_list = []
88 89
      normal_use_list = self.getPortalObject().portal_preferences\
              .getPreferredNormalResourceUseCategoryList()
90
      # check if the existing movements are in aggregated movements
91
      movement_to_delete_list = []
92 93
      for movement in existing_movement_list:
        keep_movement = False
Fabien Morin's avatar
Fabien Morin committed
94 95
        # check if the movement is a generated one or entered by the user.
        # If it has been entered by user, keep it.
96 97 98 99 100
        resource = movement.getResourceValue()
        if resource is not None and \
            len(set(normal_use_list).intersection(set(resource\
            .getUseList()))):
          keep_movement = True
101
          continue
102 103 104 105 106
        for amount in aggregated_amount_list:
          # if movement is generated and if not exist, append to delete list
          update_kw = {}
          for p in self.edited_property_list:
            update_kw[p] = amount.getProperty(p)
107
          if movement.getProperty('reference') == update_kw['reference'] and\
108 109 110
              movement.getVariationCategoryList() == \
              amount.getVariationCategoryList():
            movement.edit(**update_kw)
111
            modified_reference_list.append(update_kw['reference'])
112 113 114
            keep_movement = True
        if not keep_movement:
          movement_to_delete_list.append(movement)
115 116 117
      movement_to_add_list = AggregatedAmountList(
                  [amount for amount in aggregated_amount_list if
                    amount.getReference() not in modified_reference_list])
118 119
      return {'movement_to_delete_list' : movement_to_delete_list,
              'movement_to_add_list': movement_to_add_list}
120

121 122
    security.declareProtected(Permissions.AccessContentsInformation,
        'findSpecialiseValueList')
123
    def findSpecialiseValueList(self, context, portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
124 125
      """Returns a list of specialised objects representing inheritance tree.

126
         Uses Breadth First Search.
Łukasz Nowak's avatar
Łukasz Nowak committed
127
      """
128
      if portal_type_list is None:
129
        portal_type_list = [self.getPortalType()]
130
      if context.getPortalType() in portal_type_list:
131 132 133
        specialise_value_list = [context]
        visited_trade_condition_list = [context]
      else:
134
        specialise_value_list = context.getSpecialiseValueList()
135 136 137 138
        visited_trade_condition_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
      while len(specialise_value_list) != 0:
        specialise = specialise_value_list.pop(0)
139 140 141 142 143 144 145
        try:
          child_list = specialise.getSpecialiseValueList(\
              portal_type=portal_type_list)
        except AttributeError:
          # it is possible, that specialised object cannot be specialised
          # anymore
          continue
146 147 148 149 150 151 152 153
        intersection = set(child_list).intersection(\
            set(visited_trade_condition_list))
        for model in child_list:
          if model not in intersection:
            # don't add model that are already been visited. This permit to
            # visit all model tree, and to not have circular dependency
            specialise_value_list.append(model)
            visited_trade_condition_list.append(model)
154
      return visited_trade_condition_list
155

Fabien Morin's avatar
Fabien Morin committed
156 157
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTradeModelLineComposedList')
158
    def getTradeModelLineComposedList(self, context=None, portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
159 160
      """Returns list of Trade Model Lines using composition.

161
      Reference of Trade Model Line is used to hide other Trade Model Line
162
      In chain first found Trade Model Line has precedence
163
      Context's, if not None, Trade Model Lines have precedence
164 165
      Result is sorted in safe order to do one time pass - movements which
      applies are before its possible contributions.
166
      """
167 168
      if portal_type_list is None:
        portal_type_list = self.model_line_portal_type_list
169

170
      reference_list = []
171 172
      trade_model_line_composed_list = []
      containting_object_list = []
173 174
      start_date = None
      stop_date = None
175
      if context is not None:
176 177
        document = context
        if getattr(context, 'getExplanationValue', None) is not None:
178 179
          # if context is movement it is needed to ask its explanation
          # for contained Trade Model Lines
180 181
          document = context.getExplanationValue()
        containting_object_list.append(document)
182
        start_date = document.getStartDate()
183
        stop_date = document.getStopDate()
184 185 186
      containting_object_list.extend(\
          self.findEffectiveSpecialiseValueList(context=self,
            start_date=start_date, stop_date=stop_date))
187 188 189

      for specialise in containting_object_list:
        for trade_model_line in specialise.contentValues(
190
            portal_type=portal_type_list):
191
          reference = trade_model_line.getReference()
192
          if reference not in reference_list or reference is None:
193
            reference_list.append(reference)
194
            if len(trade_model_line.getBaseContributionList()) == 0:
195 196 197 198
              # 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:
199 200 201
              # parse full list of currently generated trade model lines
              # if current line applies to anything, put it after last
              # object it applies to
202
              index = 0
203
              insert_index = 0
204
              for old_trade_model_line in trade_model_line_composed_list:
205 206 207 208 209 210
                for base_application in trade_model_line \
                    .getBaseApplicationList():
                  if base_application in old_trade_model_line \
                      .getBaseContributionList():
                    insert_index = index + 1
                    continue
211
                index += 1
212 213
              trade_model_line_composed_list.insert(insert_index,
                  trade_model_line)
Fabien Morin's avatar
Fabien Morin committed
214

215
      return trade_model_line_composed_list
216

Fabien Morin's avatar
Fabien Morin committed
217 218
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
219
    def getAggregatedAmountList(self, context, movement_list=None, **kw):
220 221
      if movement_list is None:
        movement_list = []
222 223
      result = AggregatedAmountList()

224 225 226
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

227 228
      # trade_model_line_composed_list is sorted in good way to have
      # simple algorithm
229 230 231 232 233
      for model_line in trade_model_line_composed_list:
        result.extend(model_line.getAggregatedAmountList(context,
          movement_list=movement_list,
          current_aggregated_amount_list=result,
          **kw))
234
      movement_list = result
235

236 237 238 239 240 241
      # remove amounts that should not be created, or with "incorrect" references.
      # XXX what are incorrect references ???
      # getTradeModelLineComposedList should have removed duplicate reference
      # in the model graph
      # TODO: review this part
      aggregated_amount_list = AggregatedAmountList()
242
      for movement in movement_list:
243
        movement_reference = movement.getReference()
244
        for model_line in trade_model_line_composed_list:
245
          if model_line.getReference() == movement_reference and\
246
              model_line.isCreateLine():
247 248 249
            aggregated_amount_list.append(movement)

      return aggregated_amount_list
250 251 252

    security.declareProtected( Permissions.AccessContentsInformation, 'getCell')
    def getCell(self, *kw , **kwd):
Fabien Morin's avatar
Fabien Morin committed
253
      '''Overload the function getCell to be able to search a cell on the
Fabien Morin's avatar
Fabien Morin committed
254
      inheritance model tree if the cell is not found on current one.
255 256 257
      '''
      cell = XMLMatrix.getCell(self, *kw, **kwd)
      if cell is None:
Fabien Morin's avatar
Fabien Morin committed
258 259 260 261 262 263 264
        # if cell not found, look on the inherited models
        start_date = kwd.has_key('paysheet') and \
            kwd['paysheet'].getStartDate() or None
        stop_date = kwd.has_key('paysheet') and \
            kwd['paysheet'].getStopDate() or None
        model_list = self.findEffectiveSpecialiseValueList(\
            context=self, start_date=start_date, stop_date=stop_date)
265 266 267 268 269 270 271 272 273
        for specialised_model in model_list:
          cell = XMLMatrix.getCell(specialised_model, *kw, **kwd)
          if cell is not None:
            return cell
      return cell

    security.declareProtected(Permissions.AccessContentsInformation,
        'getReferenceDict')
    def getReferenceDict(self, portal_type_list, property_list=None):
Fabien Morin's avatar
Fabien Morin committed
274
      '''Return a dict containing all id's of the objects contained in
Fabien Morin's avatar
Fabien Morin committed
275
      this model and corresponding to the given portal_type. The key of the dict
Fabien Morin's avatar
Fabien Morin committed
276
      are the reference (or id if no reference)
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
      '''
      if property_list is None:
        property_list=[]
      reference_dict = {}
      object_list = self.contentValues(portal_type=portal_type_list,
          sort_on='id')
      for obj in object_list:
        keep = (len(property_list) == 0)
        for property_ in property_list:
          if obj.hasProperty(property_):
            keep = 1
            break
        if keep:
          reference_dict[obj.getProperty('reference', obj.getId())] = obj.getId()
      return reference_dict

    security.declareProtected(Permissions.AccessContentsInformation,
        'findEffectiveSpecialiseValueList')
Fabien Morin's avatar
Fabien Morin committed
295
    def findEffectiveSpecialiseValueList(self, context, start_date=None,
Fabien Morin's avatar
Fabien Morin committed
296
        stop_date=None, portal_type_list=None, effective_model_list=None):
Fabien Morin's avatar
typo  
Fabien Morin committed
297
      '''Return a list of effective specialised objects that is the
Fabien Morin's avatar
Fabien Morin committed
298
      inheritance tree.
Fabien Morin's avatar
typo  
Fabien Morin committed
299 300 301 302
      An effective object is an object which have start_date and stop_date
      included to the range of the given parameters start_date and stop_date.
      If no start_date and stop_date are provided, findSpecialiseValueList
      result is returned.
303

Fabien Morin's avatar
typo  
Fabien Morin committed
304
      This algorithm uses Breadth First Search.
305 306
      '''
      if start_date is None and stop_date is None:
Fabien Morin's avatar
typo  
Fabien Morin committed
307
        # if dates are not defined, return findSpecialiseValueList result
308
        return self.findSpecialiseValueList(context=context)
Fabien Morin's avatar
Fabien Morin committed
309 310
      if effective_model_list is None:
        effective_model_list = []
311
      visited_trade_condition_list = []
312 313 314
      if portal_type_list is None:
        portal_type_list = [self.getPortalType()]

315 316 317 318
      if context.getPortalType() in portal_type_list:
        effective_model = context.getEffectiveModel(
            start_date=start_date, stop_date=stop_date)
        if effective_model is not None:
Fabien Morin's avatar
Fabien Morin committed
319
          effective_model_list = [effective_model]
320 321 322 323
          visited_trade_condition_list = [effective_model]
      else:
        model_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
Fabien Morin's avatar
Fabien Morin committed
324
        effective_model_list = [model.getEffectiveModel(\
325 326 327 328 329
            start_date=start_date, stop_date=stop_date) for model in\
            model_list]
        visited_trade_condition_list = [model.getEffectiveModel(\
            start_date=start_date, stop_date=stop_date) for model in\
            model_list]
Fabien Morin's avatar
typo  
Fabien Morin committed
330
      # remove None models
Fabien Morin's avatar
Fabien Morin committed
331 332 333
      effective_model_list = [ob for ob in effective_model_list if ob is not None]
      while len(effective_model_list) != 0:
        specialise = effective_model_list.pop(0)
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
        effective_specialise = specialise.getEffectiveModel(start_date=start_date,
          stop_date=stop_date)
        child_list = []
        if effective_specialise is not None:
          child_list = effective_specialise.getSpecialiseValueList(\
              portal_type=portal_type_list)

        intersection = set(child_list).intersection(\
            set(visited_trade_condition_list))
        for model in child_list:
          effective_model = model.getEffectiveModel(start_date=start_date,
              stop_date=stop_date)
          if effective_model not in intersection:
            # don't add model that are already been visited. This permit to
            # visit all model tree, and to not have circular dependency
Fabien Morin's avatar
Fabien Morin committed
349
            effective_model_list.append(effective_model)
350 351
            visited_trade_condition_list.append(effective_model)
      return visited_trade_condition_list
352 353 354 355 356 357

    security.declareProtected(Permissions.AccessContentsInformation,
        'getInheritanceReferenceDict')
    def getInheritanceReferenceDict(self, portal_type_list,
        property_list=None):
      '''Returns a dict with the model url as key and a list of reference as
Fabien Morin's avatar
Fabien Morin committed
358 359 360
      value. A Reference can appear only one time in the final output.
      If property_list is not empty, documents which don't have any of theses
      properties will be skipped.
361 362 363 364 365 366 367 368 369 370 371 372 373 374
      '''
      if property_list is None:
        property_list=[]
      model_list = self.findSpecialiseValueList(context=self)
      reference_list = []
      model_reference_dict = {}
      for model in model_list:
        id_list = []
        model_reference_list = model.getReferenceDict(
                             portal_type_list, property_list=property_list)
        for reference in model_reference_list.keys():
          if reference not in reference_list:
            reference_list.append(reference)
            id_list.append(model_reference_list[reference])
Fabien Morin's avatar
Fabien Morin committed
375
        if len(id_list) != 0:
376 377 378 379 380 381
          model_reference_dict[model.getRelativeUrl()]=id_list
      return model_reference_dict

    security.declareProtected(Permissions.AccessContentsInformation,
        'getEffectiveModel')
    def getEffectiveModel(self, start_date=None, stop_date=None):
382 383
      '''Return the more appropriate model using effective_date, expiration_date
      and version number.
Fabien Morin's avatar
Fabien Morin committed
384
      An effective model is a model which start and stop_date are equal (or
385
      excluded) to the range of the given start and stop_date and with the
Fabien Morin's avatar
Fabien Morin committed
386
      higher version number (if there is more than one)
387 388
      '''
      reference = self.getReference()
389
      if not reference or (start_date is None and stop_date is None):
390
        return self
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
      
      return self.getPortalObject().portal_catalog.unrestrictedGetResultValue(
                              query=ComplexQuery(
                                      ComplexQuery(
                                        Query(effective_date=None),
                                        Query(effective_date=start_date,
                                              range='ngt'),
                                        logical_operator='OR'),
                                      ComplexQuery(
                                        Query(expiration_date=None),
                                        Query(expiration_date=stop_date,
                                              range='min'),
                                        logical_operator='OR'),
                                      Query(reference=reference),
                                      Query(validation_state=(
                                              'deleted', 'invalidated'),
                                            operator='NOT'),
                                      Query(portal_type=self.getPortalType()),
                                      logical_operator='AND'),
                              sort_on=(('version','descending'),))

412 413 414 415 416 417 418 419 420

    security.declareProtected(Permissions.AccessContentsInformation,
        'getModelIneritanceEffectiveProperty')
    def getModelIneritanceEffectiveProperty(self, paysheet, property_name):
      """Get a property from an effective model
      """
      v = self.getProperty(property_name)
      if v:
        return v
421
      model_list = self.findEffectiveSpecialiseValueList(context=self,
422 423 424 425 426
          start_date=paysheet.getStartDate(), stop_date=paysheet.getStopDate())
      for specialised_model in model_list:
        v = specialised_model.getProperty(property_name)
        if v:
          return v