DeliveryLine.py 15.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 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 35 36
#
# 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

from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.XMLMatrix import XMLMatrix
from Products.ERP5Type.XMLObject import XMLObject

from Products.ERP5.Document.Movement import Movement
from Products.ERP5.Variated import Variated
37
from Products.ERP5.Document.ImmobilisationMovement import ImmobilisationMovement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38 39 40

from zLOG import LOG

Romain Courteaud's avatar
Romain Courteaud committed
41 42
class DeliveryLine(Movement, XMLObject, XMLMatrix, Variated, 
                   ImmobilisationMovement):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43 44 45 46 47 48 49 50 51 52 53 54 55
    """
      A DeliveryLine object allows to implement lines in
      Deliveries (packing list, order, invoice, etc.)

      It may include a price (for insurance, for customs, for invoices,
      for orders)
    """

    meta_type = 'ERP5 Delivery Line'
    portal_type = 'Delivery Line'

    # Declarative security
    security = ClassSecurityInfo()
56
    security.declareObjectProtected(Permissions.AccessContentsInformation)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71

    # Declarative interfaces
    __implements__ = ( Interface.Variated, )

    # Declarative properties
    property_sheets = ( PropertySheet.Base
                      , PropertySheet.XMLObject
                      , PropertySheet.CategoryCore
                      , PropertySheet.Amount
                      , PropertySheet.Task
                      , PropertySheet.Arrow
                      , PropertySheet.Movement
                      , PropertySheet.Price
                      , PropertySheet.VariationRange
                      , PropertySheet.ItemAggregation
72
                      , PropertySheet.SortIndex
Jean-Paul Smets's avatar
Jean-Paul Smets committed
73 74
                      )

75 76
    # Multiple inheritance definition
    updateRelatedContent = XMLMatrix.updateRelatedContent
77

78
    # Explicit acquisition of aq_dynamic generated method
79
    security.declareProtected(Permissions.AccessContentsInformation,
80
                              'getSimulationState')
81 82 83 84
    def getSimulationState(self):
      """
        Explicitly acquire simulation_state from parent
      """
85 86 87
      method = getattr(self.getParentValue(),'getSimulationState', None)
      if method is not None:
        return method()
88
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
89 90 91
    # Force in _edit to modify variation_base_category_list first
    security.declarePrivate( '_edit' )
    def _edit(self, REQUEST=None, force_update = 0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
92 93 94 95 96
      # XXX FIXME For now, special cases are handled in _edit methods in many
      # documents : DeliveryLine, DeliveryCell ... Ideally, to prevent code
      # duplication, it should be handled in a _edit method present only in
      # Amount.py

97 98 99 100
      # If variations and resources are set at the same time, resource must be
      # set before any variation.
      if kw.has_key('resource_value'):
        self._setResourceValue( kw['resource_value'] )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
101 102 103 104 105 106
      # We must first prepare the variation_base_category_list before we do the edit of the rest
      #LOG('in edit', 0, str(kw))
      if kw.has_key('variation_base_category_list'):
        self._setVariationBaseCategoryList( kw['variation_base_category_list'] )
      if kw.has_key('variation_category_list'):
        self._setVariationCategoryList( kw['variation_category_list'] )
107 108
      Movement._edit(self, REQUEST=REQUEST,
                       force_update = force_update, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111
      # This one must be the last
      if kw.has_key('item_id_list'):
        self._setItemIdList( kw['item_id_list'] )
Sebastien Robin's avatar
Sebastien Robin committed
112 113 114 115 116

    # We must check if the user has changed the resource of particular line
    security.declareProtected( Permissions.ModifyPortalContent, 'edit' )
    def edit(self, REQUEST=None, force_update = 0, reindex_object=1, **kw):
      return self._edit(REQUEST=REQUEST, force_update=force_update, reindex_object=reindex_object, **kw)
117

Romain Courteaud's avatar
Romain Courteaud committed
118 119
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'isAccountable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
120 121 122 123 124 125
    def isAccountable(self):
      """
        Returns 1 if this needs to be accounted
        Only account movements which are not associated to a delivery
        Whenever delivery is there, delivery has priority
      """
126
      return self.getParentValue().isAccountable() and (not self.hasCellContent())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127

128
    def _getTotalPrice(self, context, fast=1):
129
      """ Returns the total price for this line or the cells it contains. """
130 131
      base_id = 'movement'
      if not self.hasCellContent(base_id=base_id):
132
        quantity = self.getQuantity() or 0.0
133
        price = self.getPrice(context=context) or 0.0
134
        return quantity * price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
135
      else:
136 137 138 139 140 141 142 143 144
        if fast : # Use MySQL
          aggregate = self.DeliveryLine_zGetTotal()[0]
          return aggregate.total_price or 0.0
        return sum([ ( (cell.getQuantity() or 0) *
                       (cell.getPrice(context=context) or 0))
                        for cell in self.getCellValueList()])

    security.declareProtected( Permissions.AccessContentsInformation,
                               'getTotalQuantity')
145
    def getTotalQuantity(self, fast=1):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146 147
      """
        Returns the quantity if no cell or the total quantity if cells
148 149 150 151

        If fast is equal to 0, we returns the right quantity even
        if there is nothing into the catalog or the catalog is not
        up to date
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152
      """
153 154
      base_id = 'movement'
      if not self.hasCellContent(base_id=base_id):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
155 156
        return self.getQuantity()
      else:
157 158 159 160
        if fast : # Use MySQL
          aggregate = self.DeliveryLine_zGetTotal()[0]
          return aggregate.total_quantity or 0.0
        return sum([cell.getQuantity() for cell in self.getCellValueList()])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
161

162 163
    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasCellContent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
164
    def hasCellContent(self, base_id='movement'):
165
      """Return true if the object contains cells.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
166
      """
167 168 169 170 171 172 173 174 175 176
      # Do not use XMLMatrix.hasCellContent, because it can generate
      # inconsistency in catalog
      # Exemple: define a line and set the matrix cell range, but do not create
      # cell.
      # Line was in this case consider like a movement, and was catalogued.
      # But, getVariationText of the line was not empty.
      # So, in ZODB, resource as without variation, but in catalog, this was
      # the contrary...
      cell_range = XMLMatrix.getCellRange(self, base_id=base_id)
      return (cell_range is not None and len(cell_range) > 0)
177 178
      # DeliveryLine can be a movement when it does not content any cell and 
      # matrix cell range is not empty.
179 180 181 182 183
      # Better implementation is needed.
      # We want to define a line without cell, defining a variated resource.
      # If we modify the cell range, we need to move the quantity to a new
      # cell, which define the same variated resource.
#       return XMLMatrix.hasCellContent(self, base_id=base_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184

185 186 187 188 189 190 191 192 193
    security.declareProtected( Permissions.AccessContentsInformation,
        'isMovement' )
    def isMovement(self):
      """
      returns true is the object contains no submovement (line or cell)
      """
      portal_type = self.getPortalMovementTypeList()
      return len(self.contentValues(filter={'portal_type': portal_type})) == 0

Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196 197 198 199 200
    security.declareProtected( Permissions.AccessContentsInformation, 'getCellValueList' )
    def getCellValueList(self, base_id='movement'):
      """
          This method can be overriden
      """
      return XMLMatrix.getCellValueList(self, base_id=base_id)

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    security.declareProtected( Permissions.View, 'getCell' )
    def getCell(self, *kw , **kwd):
      """
          This method can be overriden
      """
      if 'base_id' not in kwd:
        kwd['base_id'] = 'movement'

      return XMLMatrix.getCell(self, *kw, **kwd)

    security.declareProtected( Permissions.ModifyPortalContent, 'newCell' )
    def newCell(self, *kw, **kwd):
      """
          This method creates a new cell
      """
      if 'base_id' not in kwd:
        kwd['base_id'] = 'movement'

      return XMLMatrix.newCell(self, *kw, **kwd)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
220 221 222 223 224 225 226 227 228 229

    security.declareProtected(Permissions.View, 'isDivergent')
    def isDivergent(self):
      """
        Returns 1 if the target is not met according to the current information
        After and edit, the isOutOfTarget will be checked. If it is 1,
        a message is emitted

        emit targetUnreachable !
      """
230 231 232 233 234
      if self.getDivergenceList() == []:
        return 0
      else:
        return 1
  
235
    security.declareProtected(Permissions.View, 'getDivergenceList')
236 237 238 239 240
    def getDivergenceList(self):
      """
      Return a list of messages that contains the divergences
      """
      divergence_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
241
      if self.hasCellContent():
242 243 244 245
        for cell in self.contentValues(filter={
                'portal_type': self.getPortalDeliveryMovementTypeList()}):
          divergence_list.extend(cell.getDivergenceList())
        return divergence_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
246
      else:
247 248
        return Movement.getDivergenceList(self)
     
Jean-Paul Smets's avatar
Jean-Paul Smets committed
249 250 251 252 253 254 255 256 257 258 259 260 261
    def applyToDeliveryLineRelatedMovement(self, portal_type='Simulation Movement', method_id = 'expand'):
      # Find related in simulation
      for my_simulation_movement in self.getDeliveryRelatedValueList(
                                              portal_type = 'Simulation Movement'):
        # And apply
        getattr(my_simulation_movement.getObject(), method_id)()
      for c in self.contentValues(filter={'portal_type': 'Delivery Cell'}):
        for my_simulation_movement in c.getDeliveryRelatedValueList(
                                              portal_type = 'Simulation Movement'):
          # And apply
          getattr(my_simulation_movement.getObject(), method_id)()

    def reindexObject(self, *k, **kw):
262
      """Reindex children"""
263
      self.recursiveReindexObject(*k, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
264 265 266 267 268

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedQuantity')
    def getInventoriatedQuantity(self):
      """
      """
269
      return Movement.getInventoriatedQuantity(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
270

271 272
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStartDate')
    def getInventoriatedStartDate(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
273 274
      """
      """
275
      return Movement.getStartDate(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
276

277 278
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStopDate')
    def getInventoriatedStopDate(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
279 280
      """
      """
281
      return Movement.getStopDate(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
282

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
#     security.declarePrivate('_checkConsistency')
#     def _checkConsistency(self, fixit=0, mapped_value_property_list = ('quantity', 'price')):
#       """
#         Check the constitency of transformation elements
#       """
#       error_list = XMLMatrix._checkConsistency(self, fixit=fixit)
# 
#       # First quantity
#       # We build an attribute equality and look at all cells
#       q_constraint = Constraint.AttributeEquality(
#         domain_base_category_list = self.getVariationBaseCategoryList(),
#         predicate_operator = 'SUPERSET_OF',
#         mapped_value_property_list = mapped_value_property_list )
#       for k in self.getCellKeys(base_id = 'movement'):
#         kw={}
#         kw['base_id'] = 'movement'
#         c = self.getCell(*k, **kw)
#         if c is not None:
#           predicate_value = []
#           for p in k:
#             if p is not None: predicate_value += [p]
#           q_constraint.edit(predicate_value_list = predicate_value)
#           if fixit:
#             error_list += q_constraint.fixConsistency(c)
#           else:
#             error_list += q_constraint.checkConsistency(c)
#           if list(c.getVariationCategoryList()) != predicate_value:
#             error_message =  "Variation %s but sould be %s" % (c.getVariationCategoryList(),predicate_value)
#             if fixit:
#               c.setVariationCategoryList(predicate_value)
#               error_message += " (Fixed)"
#             error_list += [(c.getRelativeUrl(), 'VariationCategoryList inconsistency', 100, error_message)]
# 
#       return error_list
Jean-Paul Smets's avatar
Jean-Paul Smets committed
317 318

    # Simulation Consistency Check
319
    def getSimulationQuantity(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
320 321 322
      """
          Computes the quantities in the simulation
      """
323 324 325 326
      if not self.hasCellContent():
        result = self.DeliveryLine_zGetRelatedQuantity(uid=self.getUid())
        if len(result) > 0:
          return result[0].quantity
Jean-Paul Smets's avatar
Jean-Paul Smets committed
327
      return None
328 329 330 331 332 333 334

    def getSimulationSourceList(self):
      """
          Computes the sources in the simulation
      """
      result = self.DeliveryLine_zGetRelatedSource(uid=self.getUid())
      return map(lambda x: x.source, result)
335

336 337 338 339 340 341
    def getSimulationDestinationList(self):
      """
          Computes the destinations in the simulation
      """
      result = self.DeliveryLine_zGetRelatedDestination(uid=self.getUid())
      return map(lambda x: x.destination, result)
342

343 344 345 346 347 348
    def getSimulationSourceSectionList(self):
      """
          Computes the source sections in the simulation
      """
      result = self.DeliveryLine_zGetRelatedSourceSection(uid=self.getUid())
      return map(lambda x: x.source_section, result)
349

350 351 352 353 354 355
    def getSimulationDestinationSectionList(self):
      """
          Computes the destination sections in the simulation
      """
      result = self.DeliveryLine_zGetRelatedDestinationSection(uid=self.getUid())
      return map(lambda x: x.destination_section, result)
Sebastien Robin's avatar
Sebastien Robin committed
356

357 358
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRootDeliveryValue')
Sebastien Robin's avatar
Sebastien Robin committed
359 360 361 362
    def getRootDeliveryValue(self):
      """
      Returns the root delivery responsible of this line
      """
363
      return self.getParentValue().getRootDeliveryValue()
364

365 366
    security.declareProtected(Permissions.ModifyPortalContent,
                              'updateSimulationDeliveryProperties')
367 368
    def updateSimulationDeliveryProperties(self, movement_list = None):
      """
369 370 371
      Set properties delivery_ratio and delivery_error for each
      simulation movement in movement_list (all movements by default),
      according to this delivery calculated quantity
372
      """
373
      parent = self.getParentValue()
374 375
      if parent is not None:
        parent.updateSimulationDeliveryProperties(movement_list, self)
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

    security.declarePrivate('manage_afterAdd')
    def manage_afterAdd(self, item, container):
      "if the container is a line too, reindex it"
      if self.meta_type == container.meta_type:
        container.reindexObject()
      return Movement.manage_afterAdd(self, item, container)

    security.declarePrivate('manage_beforeDelete')
    def manage_beforeDelete(self, item, container):
      "if the container is a line too, reindex it"
      if self.meta_type == container.meta_type:
        container.reindexObject()
      return Movement.manage_beforeDelete(self, item, container)