TradeCondition.py 16.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 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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40

41 42
import zope.interface

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

48 49
class CircularException(Exception): pass

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',)
62
    isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63 64 65

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

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

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

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
      modified_reference_list = []
89 90
      normal_use_list = self.getPortalObject().portal_preferences\
              .getPreferredNormalResourceUseCategoryList()
91
      # check if the existing movements are in aggregated movements
92
      movement_to_delete_list = []
93
      movement_to_add_list = []
94 95
      for movement in existing_movement_list:
        keep_movement = False
Fabien Morin's avatar
Fabien Morin committed
96 97
        # check if the movement is a generated one or entered by the user.
        # If it has been entered by user, keep it.
98 99 100 101 102 103 104 105 106 107 108
        resource = movement.getResourceValue()
        if resource is not None and \
            len(set(normal_use_list).intersection(set(resource\
            .getUseList()))):
          keep_movement = True
          break
        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)
109
          if movement.getProperty('reference') == update_kw['reference'] and\
110 111 112
              movement.getVariationCategoryList() == \
              amount.getVariationCategoryList():
            movement.edit(**update_kw)
113
            modified_reference_list.append(update_kw['reference'])
114 115 116 117
            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
118
          amount.getReference() not in modified_reference_list]
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 135 136 137 138 139 140 141 142 143 144 145 146
        specialise_value_list = [context]
        visited_trade_condition_list = [context]
      else:
        specialise_value_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
        visited_trade_condition_list = context.getSpecialiseValueList(\
            portal_type=portal_type_list)
      while len(specialise_value_list) != 0:
        specialise = specialise_value_list.pop(0)
        children = specialise.getSpecialiseValueList(\
            portal_type=portal_type_list)
        specialise_value_list.extend(children)
        if not set(children).intersection(visited_trade_condition_list):
          visited_trade_condition_list.extend(children)
        else:
147
          raise CircularException
148
      return visited_trade_condition_list
149

Fabien Morin's avatar
Fabien Morin committed
150 151
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTradeModelLineComposedList')
152
    def getTradeModelLineComposedList(self, context=None, portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
153 154
      """Returns list of Trade Model Lines using composition.

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

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

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

209
      return trade_model_line_composed_list
210

Fabien Morin's avatar
Fabien Morin committed
211 212
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
213
    def getAggregatedAmountList(self, context, movement_list=None, **kw):
214 215
      if movement_list is None:
        movement_list = []
216 217
      result = AggregatedAmountList()

218 219 220
      trade_model_line_composed_list = \
          self.getTradeModelLineComposedList(context)

221 222 223
      # initialise run then rerun only once, as trade_model_line_composed_list
      # is sorted in good way to have simple algorithm
      for pass_type in ['initialise', 'rerun']:
Fabien Morin's avatar
Fabien Morin committed
224
        for model_line in trade_model_line_composed_list:
225
          result.extend(model_line.getAggregatedAmountList(context,
226 227
            movement_list=movement_list,
            current_aggregated_amount_list=result,
228 229
            **kw))
        movement_list = result # apply model again on generated movements
230 231 232 233 234 235 236 237 238 239

      # remove movement that should not be created
      movement_list = []
      for movement in result:
        movement_ref = movement.getReference()
        for model_line in trade_model_line_composed_list:
          if model_line.getReference() == movement_ref and\
              model_line.isCreateLine():
            movement_list.append(movement)
      return movement_list
240 241 242

    security.declareProtected( Permissions.AccessContentsInformation, 'getCell')
    def getCell(self, *kw , **kwd):
Fabien Morin's avatar
Fabien Morin committed
243
      '''Overload the function getCell to be able to search a cell on the
Fabien Morin's avatar
Fabien Morin committed
244
      inheritance model tree if the cell is not found on current one.
245 246 247
      '''
      cell = XMLMatrix.getCell(self, *kw, **kwd)
      if cell is None:
Fabien Morin's avatar
Fabien Morin committed
248 249 250 251 252 253 254
        # 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)
255 256 257 258 259 260 261 262 263
        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
264
      '''Return a dict containing all id's of the objects contained in
Fabien Morin's avatar
Fabien Morin committed
265
      this model and corresponding to the given portal_type. The key of the dict
Fabien Morin's avatar
Fabien Morin committed
266
      are the reference (or id if no reference)
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      '''
      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
285
    def findEffectiveSpecialiseValueList(self, context, start_date=None,
286
        stop_date=None, portal_type_list=None, effecive_model_list=None):
287
      '''Returns a list of effective specialised objects representing
Fabien Morin's avatar
Fabien Morin committed
288
      inheritance tree.
Fabien Morin's avatar
Fabien Morin committed
289
      An effective object is an object which start and stop_date are equal (or
Fabien Morin's avatar
Fabien Morin committed
290
      included) to the range of the given start and stop_date.
Fabien Morin's avatar
Fabien Morin committed
291 292
      If no start date and stop date are provided, findSpecialiseValueList is
      returned
293 294
      '''
      if start_date is None and stop_date is None:
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
        # if dates are not defined, return the specalise_value_list
        return self.findSpecialiseValueList(context=context)
      if effecive_model_list is None:
        effecive_model_list=[]
      if portal_type_list is None:
        portal_type_list = [self.getPortalType()]

      new_model = self.getEffectiveModel(start_date, stop_date)
      model_list = new_model.getSpecialiseValueList(portal_type=\
          portal_type_list)
      effecive_model_list.append(new_model)
      for model in model_list:
        model.findEffectiveSpecialiseValueList(context=context,
            start_date=start_date, stop_date=stop_date,
            portal_type_list=portal_type_list,
            effecive_model_list=effecive_model_list)
      return effecive_model_list
312 313 314 315 316 317

    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
318 319 320
      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.
321 322 323 324 325 326 327 328 329 330 331 332 333 334
      '''
      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
335
        if len(id_list) != 0:
336 337 338 339 340 341
          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):
342 343
      '''Return the more appropriate model using effective_date, expiration_date
      and version number.
Fabien Morin's avatar
Fabien Morin committed
344
      An effective model is a model which start and stop_date are equal (or
345
      excluded) to the range of the given start and stop_date and with the
Fabien Morin's avatar
Fabien Morin committed
346
      higher version number (if there is more than one)
347 348 349 350 351 352 353
      '''
      reference = self.getReference()
      if not reference:
        return self
      effective_model_list = []
      model_object_list = [result.getObject() for result in \
          self.portal_catalog(portal_type=self.portal_type,
354
                              reference=reference,
355 356 357 358 359 360 361 362 363 364
                              sort_on=(('version','descending'),),
                              effective_date="<=%s"%start_date,
                              expiration_date=">=%s"%stop_date,
                              limit=1)]
      if len(model_object_list):
        return model_object_list[0].getObject()
      else:
        # if no effective model are found (ex. because dates are None), 
        # return self
        return self
365 366 367 368 369 370 371 372 373

    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
374
      model_list = self.findEffectiveSpecialiseValueList(context=self,
375 376 377 378 379
          start_date=paysheet.getStartDate(), stop_date=paysheet.getStopDate())
      for specialised_model in model_list:
        v = specialised_model.getProperty(property_name)
        if v:
          return v