TradeCondition.py 17.6 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
#
# 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.
#
##############################################################################

33
from collections import deque
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35
from AccessControl import ClassSecurityInfo

36
from Products.ERP5Type import Permissions, PropertySheet, interfaces
37
from Products.ERP5.Document.Transformation import Transformation
38
from Products.ERP5.Document.Path import Path
39
from Products.ERP5.AggregatedAmountList import AggregatedAmountList
40
from Products.ERP5Type.XMLMatrix import XMLMatrix
41
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42

43 44
import zope.interface

Fabien Morin's avatar
Fabien Morin committed
45
# XXX TODO : getTradeModelLineComposedList and findSpecialiseValueList should
Fabien Morin's avatar
Fabien Morin committed
46
# probably move to Transformation (better names should be used)
47 48
# 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
49

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

    meta_type = 'ERP5 Trade Condition'
    portal_type = 'Trade Condition'
61
    model_line_portal_type_list = ('Trade Model Line',)
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 81
    zope.interface.implements(interfaces.IAmountGenerator,
                              interfaces.IMovementGenerator,
                              interfaces.IMovementCollectionUpdater,)
82

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

90
      modified_reference_list = []
91
      # check if the existing movements are in aggregated movements
92
      movement_to_delete_list = []
93 94
      for movement in existing_movement_list:
        keep_movement = False
Fabien Morin's avatar
Fabien Morin committed
95 96
        # check if the movement is a generated one or entered by the user.
        # If it has been entered by user, keep it.
97
        if not movement.getBaseApplicationList():
98
          continue
99

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

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

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

116 117 118
      movement_to_add_list = AggregatedAmountList(
                  [amount for amount in aggregated_amount_list if
                    amount.getReference() not in modified_reference_list])
119

120 121
      return {'movement_to_delete_list' : movement_to_delete_list,
              'movement_to_add_list': movement_to_add_list}
122

123
    security.declareProtected(Permissions.AccessContentsInformation,
124
                              'findSpecialiseValueList')
125
    def findSpecialiseValueList(self, context, portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
126
      """Returns a list of specialised objects representing inheritance tree.
127 128 129 130 131 132 133 134 135 136 137 138 139
      """
      return self.findEffectiveSpecialiseValueList(context,
        portal_type_list=portal_type_list)


    security.declareProtected(Permissions.AccessContentsInformation,
                              'findEffectiveSpecialiseValueList')
    def findEffectiveSpecialiseValueList(self, context, start_date=None,
                                         stop_date=None, portal_type_list=None):
      """Return a list of effective specialised objects that is the
      inheritance tree.
      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.
Łukasz Nowak's avatar
Łukasz Nowak committed
140

141
      This algorithm uses Breadth First Search.
Łukasz Nowak's avatar
Łukasz Nowak committed
142
      """
143 144 145
      portal_type_set = set(portal_type_list or
                            self.getPortalAmountGeneratorTypeList())
      def getEffectiveModel(model):
146
        try:
147
          getEffectiveModel = model.getEffectiveModel
148
        except AttributeError:
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
          return model
        return getEffectiveModel(start_date, stop_date)
      filtered_list = []
      specialise_value_list = deque((getEffectiveModel(context),))
      specialise_value_set = set(specialise_value_list)
      specialise_index = 0
      while specialise_value_list:
        context = specialise_value_list.popleft()
        if context.getPortalType() in portal_type_set:
          filtered_list.append(context)
        for specialise_value in map(getEffectiveModel,
                                    context.getSpecialiseValueList()):
          if specialise_value not in specialise_value_set:
            specialise_value_set.add(specialise_value)
            specialise_value_list.append(specialise_value)
      return filtered_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
      trade_model_line_composed_list = []
Sebastien Robin's avatar
Sebastien Robin committed
182
      containing_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
          document = context.getExplanationValue()
Sebastien Robin's avatar
Sebastien Robin committed
191
        containing_object_list.append(document)
192
        start_date = document.getStartDate()
193
        stop_date = document.getStopDate()
Sebastien Robin's avatar
Sebastien Robin committed
194
      containing_object_list.extend(\
195 196
          self.findEffectiveSpecialiseValueList(context=self,
            start_date=start_date, stop_date=stop_date))
197

Sebastien Robin's avatar
Sebastien Robin committed
198
      for specialise in containing_object_list:
199
        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
            trade_model_line_composed_list.append(trade_model_line)

206 207 208 209 210 211 212 213 214 215
      # build a graph of precedences
      # B---\
      #      \
      # C-----> A
      # A is parent of B and C, and returned order should be
      #   (BC) A
      # where (BC) cannot be sorted
      parent_dict = {}
      # B and C are leaves
      leaf_line_list = []
216
      for line in trade_model_line_composed_list:
217
        has_child = False
218 219 220
        for other_line in trade_model_line_composed_list:
          if line == other_line:
            continue
221
          parent_dict.setdefault(other_line, [])
222 223
          for base_application in line.getBaseApplicationList():
            if base_application in other_line.getBaseContributionList():
224 225 226 227 228
              parent_dict[other_line].append(line)
              has_child = True
        if not has_child:
          leaf_line_list.append(line)

Aurel's avatar
Aurel committed
229
      final_list = []
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
      if len(parent_dict):
        # longest distance to a root (A)
        depth = {}
        tovisit = leaf_line_list
        while tovisit:
          node = tovisit[-1]
          if node in depth:
            tovisit.pop()
            continue

          parent_list = parent_dict.get(node, [])
          if len(parent_list) == 0:
            depth[node] = 0
            tovisit.pop()
          else:
            for parent in parent_list:
              if parent not in depth:
                tovisit.append(parent)
            if tovisit[-1] == node:
              depth[node] = max(depth[p] for p in parent_list) + 1
              tovisit.pop()

        # the farther a line is from a root, the earlier it should be returned
        final_list = sorted(depth.iterkeys(), key=depth.get, reverse=True)
254 255 256 257 258 259

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

      return final_list
260

Fabien Morin's avatar
Fabien Morin committed
261 262
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
263 264
    def getAggregatedAmountList(self, context, movement_list=None,
                                force_create_line=False, **kw):
265 266
      if movement_list is None:
        movement_list = []
267 268
      result = AggregatedAmountList()

269 270 271
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

272 273
      # trade_model_line_composed_list is sorted in good way to have
      # simple algorithm
274 275 276 277 278
      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))
279
      movement_list = result
280

281 282 283 284 285 286
      # 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()
287
      for movement in movement_list:
288
        movement_reference = movement.getReference()
289
        if movement_reference is None:
290 291
            raise ValueError('Reference on Trade Model Line is None. '
                'Reference must be set.')
292
        for model_line in trade_model_line_composed_list:
293
          if model_line.getReference() == movement_reference and\
294
              (force_create_line or model_line.isCreateLine()):
295 296 297
            aggregated_amount_list.append(movement)

      return aggregated_amount_list
298 299 300

    security.declareProtected( Permissions.AccessContentsInformation, 'getCell')
    def getCell(self, *kw , **kwd):
Fabien Morin's avatar
Fabien Morin committed
301
      '''Overload the function getCell to be able to search a cell on the
Fabien Morin's avatar
Fabien Morin committed
302
      inheritance model tree if the cell is not found on current one.
303 304 305
      '''
      cell = XMLMatrix.getCell(self, *kw, **kwd)
      if cell is None:
Fabien Morin's avatar
Fabien Morin committed
306 307 308 309 310 311 312
        # 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)
313 314 315 316 317 318 319 320 321
        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
322
      """Return a dict containing all id's of the objects contained in
Fabien Morin's avatar
Fabien Morin committed
323
      this model and corresponding to the given portal_type. The key of the dict
Fabien Morin's avatar
Fabien Morin committed
324
      are the reference (or id if no reference)
Aurel's avatar
Aurel committed
325
      """
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
      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,
        '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
346 347 348
      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.
349 350 351 352 353 354 355 356 357 358 359 360 361 362
      '''
      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
363
        if len(id_list) != 0:
364 365 366 367 368 369
          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):
370 371
      '''Return the more appropriate model using effective_date, expiration_date
      and version number.
Fabien Morin's avatar
Fabien Morin committed
372
      An effective model is a model which start and stop_date are equal (or
373
      excluded) to the range of the given start and stop_date and with the
Fabien Morin's avatar
Fabien Morin committed
374
      higher version number (if there is more than one)
375 376
      '''
      reference = self.getReference()
377
      if not reference or (start_date is None and stop_date is None):
378
        return self
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
      
      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'),))

400 401

    security.declareProtected(Permissions.AccessContentsInformation,
Yusuke Muraoka's avatar
Yusuke Muraoka committed
402 403
        'getModelInheritanceEffectiveProperty')
    def getModelInheritanceEffectiveProperty(self, paysheet, property_name):
404 405
      """Get a property from an effective model
      """
406
      model_list = self.findEffectiveSpecialiseValueList(context=self,
407 408 409 410 411
          start_date=paysheet.getStartDate(), stop_date=paysheet.getStopDate())
      for specialised_model in model_list:
        v = specialised_model.getProperty(property_name)
        if v:
          return v