TradeCondition.py 10.4 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.mixin.composition import _getEffectiveModel
38
from Products.ERP5.Document.Transformation import Transformation
39
from Products.ERP5.Document.Path import Path
40
from Products.ERP5.AggregatedAmountList import AggregatedAmountList
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):
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 124
    security.declareProtected(Permissions.AccessContentsInformation,
                              'findEffectiveSpecialiseValueList')
125
    def findEffectiveSpecialiseValueList(self, context, portal_type_list=None):
126 127 128 129
      """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
130

131
      This algorithm uses Breadth First Search.
Łukasz Nowak's avatar
Łukasz Nowak committed
132
      """
133 134
      portal_type_set = set(portal_type_list or
                            self.getPortalAmountGeneratorTypeList())
135 136
      return [x for x in context._findEffectiveSpecialiseValueList()
                if x.getPortalType() in portal_type_set]
137

Fabien Morin's avatar
Fabien Morin committed
138 139
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getTradeModelLineComposedList')
140 141
    def getTradeModelLineComposedList(self, context=None,
                                      portal_type_list=None):
Łukasz Nowak's avatar
Łukasz Nowak committed
142 143
      """Returns list of Trade Model Lines using composition.

144
      Reference of Trade Model Line is used to hide other Trade Model Line
145
      In chain first found Trade Model Line has precedence
146
      Context's, if not None, Trade Model Lines have precedence
147 148
      Result is sorted in safe order to do one time pass - movements which
      applies are before its possible contributions.
149
      """
150 151
      if portal_type_list is None:
        portal_type_list = self.model_line_portal_type_list
152 153
      trade_model_line_composed_list = \
        context.asComposedDocument().contentValues(portal_type=portal_type_list)
154

155 156 157 158 159 160 161 162 163 164
      # 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 = []
165
      for line in trade_model_line_composed_list:
166
        has_child = False
167 168 169
        for other_line in trade_model_line_composed_list:
          if line == other_line:
            continue
170
          parent_dict.setdefault(other_line, [])
171 172
          for base_application in line.getBaseApplicationList():
            if base_application in other_line.getBaseContributionList():
173 174 175 176 177
              parent_dict[other_line].append(line)
              has_child = True
        if not has_child:
          leaf_line_list.append(line)

Aurel's avatar
Aurel committed
178
      final_list = []
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
      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)
203 204 205 206 207 208

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

      return final_list
209

Fabien Morin's avatar
Fabien Morin committed
210 211
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getAggregatedAmountList')
212 213
    def getAggregatedAmountList(self, context, movement_list=None,
                                force_create_line=False, **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
      # trade_model_line_composed_list is sorted in good way to have
      # simple algorithm
223 224 225 226 227
      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))
228
      movement_list = result
229

230 231 232 233 234 235
      # 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()
236
      for movement in movement_list:
237
        movement_reference = movement.getReference()
238
        if movement_reference is None:
239 240
            raise ValueError('Reference on Trade Model Line is None. '
                'Reference must be set.')
241
        for model_line in trade_model_line_composed_list:
242
          if model_line.getReference() == movement_reference and\
243
              (force_create_line or model_line.isCreateLine()):
244 245 246
            aggregated_amount_list.append(movement)

      return aggregated_amount_list
247 248 249 250

    security.declareProtected(Permissions.AccessContentsInformation,
        'getEffectiveModel')
    def getEffectiveModel(self, start_date=None, stop_date=None):
251
      return _getEffectiveModel(self, start_date, stop_date)
252