TradeCondition.py 20 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',)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61 62 63

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

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

78 79 80
    zope.interface.implements(interfaces.IAmountGenerator,
                              interfaces.IMovementGenerator,
                              interfaces.IMovementCollectionUpdater,)
81

82
    security.declareProtected(Permissions.AccessContentsInformation,
Fabien Morin's avatar
Fabien Morin committed
83
                              'updateAggregatedAmountList')
84
    def updateAggregatedAmountList(self, context, movement_list=None, rounding=None, **kw):
85
      existing_movement_list = context.getMovementList()
86
      aggregated_amount_list = self.getAggregatedAmountList(context=context,
87
          movement_list=movement_list, **kw)
88

89
      modified_reference_list = []
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
        if not movement.getBaseApplicationList():
97
          continue
98

99 100 101 102 103
        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)
104

105
          if movement.getProperty('reference') == update_kw['reference'] and\
106 107 108
              movement.getVariationCategoryList() == \
              amount.getVariationCategoryList():
            movement.edit(**update_kw)
109
            modified_reference_list.append(update_kw['reference'])
110
            keep_movement = True
111

112 113
        if not keep_movement:
          movement_to_delete_list.append(movement)
114

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 120
      return {'movement_to_delete_list' : movement_to_delete_list,
              'movement_to_add_list': movement_to_add_list}
121

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

127
         Uses Breadth First Search.
Łukasz Nowak's avatar
Łukasz Nowak committed
128
      """
129
      if portal_type_list is None:
130
        portal_type_list = [self.getPortalType()]
131
      if context.getPortalType() in portal_type_list:
132 133 134
        specialise_value_list = [context]
        visited_trade_condition_list = [context]
      else:
135
        specialise_value_list = context.getSpecialiseValueList()
136 137
        visited_trade_condition_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
Aurel's avatar
Aurel committed
138

139 140
      while len(specialise_value_list) != 0:
        specialise = specialise_value_list.pop(0)
141
        try:
Aurel's avatar
Aurel committed
142 143 144 145
          # all children
          child_specialised_value_list = specialise.getSpecialiseValueList()
          # only children that match the portal_type given
          child_visited_trade_condition_list = specialise.getSpecialiseValueList(\
146 147 148 149 150
              portal_type=portal_type_list)
        except AttributeError:
          # it is possible, that specialised object cannot be specialised
          # anymore
          continue
151 152 153
        # Use a set for faster lookups. We do not use sets everywhere
        # because search order does matter
        intersection = set(child_specialised_value_list).intersection(\
154
            set(visited_trade_condition_list))
155 156 157 158 159 160 161 162
        for model in child_specialised_value_list:
          # don't add model that have already been visited. This permit to
          # visit all the tree and to prevent having circular dependency
          if model not in intersection:
            specialise_value_list.append(model)
            # only add those who matches the portal type given
            if model in child_visited_trade_condition_list:
              visited_trade_condition_list.append(model)
Aurel's avatar
Aurel committed
163

164
      return visited_trade_condition_list
165

Fabien Morin's avatar
Fabien Morin committed
166 167
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTradeModelLineComposedList')
168
    def getTradeModelLineComposedList(self, context=None, portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
169 170
      """Returns list of Trade Model Lines using composition.

171
      Reference of Trade Model Line is used to hide other Trade Model Line
172
      In chain first found Trade Model Line has precedence
173
      Context's, if not None, Trade Model Lines have precedence
174 175
      Result is sorted in safe order to do one time pass - movements which
      applies are before its possible contributions.
176
      """
177 178
      if portal_type_list is None:
        portal_type_list = self.model_line_portal_type_list
179

180
      reference_list = []
181 182
      trade_model_line_composed_list = []
      containting_object_list = []
183 184
      start_date = None
      stop_date = None
185
      if context is not None:
186 187
        document = context
        if getattr(context, 'getExplanationValue', None) is not None:
188 189
          # if context is movement it is needed to ask its explanation
          # for contained Trade Model Lines
190 191
          document = context.getExplanationValue()
        containting_object_list.append(document)
192
        start_date = document.getStartDate()
193
        stop_date = document.getStopDate()
194 195 196
      containting_object_list.extend(\
          self.findEffectiveSpecialiseValueList(context=self,
            start_date=start_date, stop_date=stop_date))
197 198 199

      for specialise in containting_object_list:
        for trade_model_line in specialise.contentValues(
200
            portal_type=portal_type_list):
201
          reference = trade_model_line.getReference()
202
          if reference not in reference_list or reference is None:
203
            reference_list.append(reference)
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
            trade_model_line_composed_list.append(trade_model_line)

      # build a graph
      father_dict = {}
      child_dict = {}
      for line in trade_model_line_composed_list:
        father_dict.setdefault(line, [])
        for other_line in trade_model_line_composed_list:
          if line == other_line:
            continue
          child_dict.setdefault(other_line, [])
          for base_application in line.getBaseApplicationList():
            if base_application in other_line.getBaseContributionList():
              father_dict[line].append(other_line)
              child_dict[other_line].append(line)
Aurel's avatar
Aurel committed
219
      final_list = []
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
      if len(father_dict):
        # find roots elements
        # XXX maybe this can be done while building the graph
        root_line_list = []
        for k, v in child_dict.iteritems():
          if len(v) == 0:
            root_line_list.append(k)
        # sort graph according to predecessors
        f = root_line_list[:]
        tmp = None
        final_list = root_line_list[:]
        while len(f):
          tmp = f.pop(0)
          for predecessors in father_dict[tmp]:
            f.append(predecessors)
            if predecessors in final_list:
              final_list.remove(predecessors)
            final_list.append(predecessors)
        final_list.reverse()

      if len(final_list) == 0:
        # at least return original lines retrieved
        final_list = trade_model_line_composed_list

      return final_list
245

Fabien Morin's avatar
Fabien Morin committed
246 247
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
248
    def getAggregatedAmountList(self, context, movement_list=None, **kw):
249 250
      if movement_list is None:
        movement_list = []
251 252
      result = AggregatedAmountList()

253 254 255
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

256 257
      # trade_model_line_composed_list is sorted in good way to have
      # simple algorithm
258 259 260 261 262
      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))
263
      movement_list = result
264

265 266 267 268 269 270
      # 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()
271
      for movement in movement_list:
272
        movement_reference = movement.getReference()
273 274
        if movement_reference is None:
            raise ValueError, 'Reference on Trade Model Line is None. Reference must be set.'
275
        for model_line in trade_model_line_composed_list:
276
          if model_line.getReference() == movement_reference and\
277
              model_line.isCreateLine():
278 279 280
            aggregated_amount_list.append(movement)

      return aggregated_amount_list
281 282 283

    security.declareProtected( Permissions.AccessContentsInformation, 'getCell')
    def getCell(self, *kw , **kwd):
Fabien Morin's avatar
Fabien Morin committed
284
      '''Overload the function getCell to be able to search a cell on the
Fabien Morin's avatar
Fabien Morin committed
285
      inheritance model tree if the cell is not found on current one.
286 287 288
      '''
      cell = XMLMatrix.getCell(self, *kw, **kwd)
      if cell is None:
Fabien Morin's avatar
Fabien Morin committed
289 290 291 292 293 294 295
        # 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)
296 297 298 299 300 301 302 303 304
        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):
Aurel's avatar
Aurel committed
305
      """Return a dict containing all id's of the objects contained in
Fabien Morin's avatar
Fabien Morin committed
306
      this model and corresponding to the given portal_type. The key of the dict
Fabien Morin's avatar
Fabien Morin committed
307
      are the reference (or id if no reference)
Aurel's avatar
Aurel committed
308
      """
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
      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
326
    def findEffectiveSpecialiseValueList(self, context, start_date=None,
Fabien Morin's avatar
Fabien Morin committed
327
        stop_date=None, portal_type_list=None, effective_model_list=None):
Aurel's avatar
Aurel committed
328
      """Return a list of effective specialised objects that is the
Fabien Morin's avatar
Fabien Morin committed
329
      inheritance tree.
Fabien Morin's avatar
typo  
Fabien Morin committed
330 331 332 333
      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.
334

Fabien Morin's avatar
typo  
Fabien Morin committed
335
      This algorithm uses Breadth First Search.
Aurel's avatar
Aurel committed
336
      """
337
      if start_date is None and stop_date is None:
Fabien Morin's avatar
typo  
Fabien Morin committed
338
        # if dates are not defined, return findSpecialiseValueList result
339
        return self.findSpecialiseValueList(context=context)
Fabien Morin's avatar
Fabien Morin committed
340 341
      if effective_model_list is None:
        effective_model_list = []
342
      visited_trade_condition_list = []
343 344 345
      if portal_type_list is None:
        portal_type_list = [self.getPortalType()]

346 347 348 349
      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
350
          effective_model_list = [effective_model]
351 352 353 354
          visited_trade_condition_list = [effective_model]
      else:
        model_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
Fabien Morin's avatar
Fabien Morin committed
355
        effective_model_list = [model.getEffectiveModel(\
356 357 358 359 360
            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
361
      # remove None models
Fabien Morin's avatar
Fabien Morin committed
362 363 364
      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)
365 366 367 368 369 370 371 372 373 374 375 376
        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)
Aurel's avatar
Aurel committed
377
          if effective_model is not None and effective_model not in intersection:
378 379
            # 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
380
            effective_model_list.append(effective_model)
381 382
            visited_trade_condition_list.append(effective_model)
      return visited_trade_condition_list
383 384 385 386 387 388

    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
389 390 391
      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.
392 393 394 395 396 397 398 399 400 401 402 403 404 405
      '''
      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
406
        if len(id_list) != 0:
407 408 409 410 411 412
          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):
413 414
      '''Return the more appropriate model using effective_date, expiration_date
      and version number.
Fabien Morin's avatar
Fabien Morin committed
415
      An effective model is a model which start and stop_date are equal (or
416
      excluded) to the range of the given start and stop_date and with the
Fabien Morin's avatar
Fabien Morin committed
417
      higher version number (if there is more than one)
418 419
      '''
      reference = self.getReference()
420
      if not reference or (start_date is None and stop_date is None):
421
        return self
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
      
      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'),))

443 444

    security.declareProtected(Permissions.AccessContentsInformation,
Yusuke Muraoka's avatar
Yusuke Muraoka committed
445 446
        'getModelInheritanceEffectiveProperty')
    def getModelInheritanceEffectiveProperty(self, paysheet, property_name):
447 448 449 450 451
      """Get a property from an effective model
      """
      v = self.getProperty(property_name)
      if v:
        return v
452
      model_list = self.findEffectiveSpecialiseValueList(context=self,
453 454 455 456 457
          start_date=paysheet.getStartDate(), stop_date=paysheet.getStopDate())
      for specialised_model in model_list:
        v = specialised_model.getProperty(property_name)
        if v:
          return v