DeliveryLine.py 21.6 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3 4
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
5
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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.
#
##############################################################################

30
import zope.interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from AccessControl import ClassSecurityInfo

33
from Products.ERP5Type import Permissions, PropertySheet, interfaces
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36 37 38
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
39
from Products.ERP5.Document.ImmobilisationMovement import ImmobilisationMovement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40

41
class DeliveryLine(Movement, XMLObject, XMLMatrix, Variated,
Romain Courteaud's avatar
Romain Courteaud committed
42
                   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

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

72 73
    # Declarative interfaces
    zope.interface.implements(interfaces.IDivergenceController,)
74

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
78 79 80
    # 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
81 82 83 84 85
      # 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

86 87
      # If variations and resources are set at the same time, resource must be
      # set before any variation.
Tatuya Kamada's avatar
Tatuya Kamada committed
88
      if kw.has_key('resource_value'):
89
        self._setResourceValue( kw['resource_value'] )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
90 91 92 93 94 95
      # 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'] )
96 97
      Movement._edit(self, REQUEST=REQUEST,
                       force_update = force_update, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98 99 100
      # 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
101 102 103 104 105

    # 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)
106

Fabien Morin's avatar
Fabien Morin committed
107
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
108
                              'isAccountable')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111 112 113 114
    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
      """
115
      return self.getParentValue().isAccountable() and (not self.hasCellContent())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
116

117
    def _getTotalPrice(self, default=0.0, context=None, fast=0):
118 119 120 121 122 123 124 125 126 127 128 129 130
      """
        Returns the total price for this line, this line contains, or the cells it contains.

        if hasLineContent: return sum of lines total price
        if hasCellContent: return sum of cells total price
        else: return quantity * price
        if fast is argument true, then a SQL method will be used.
      """
      if self.hasLineContent():
        meta_type = self.meta_type
        return sum(l.getTotalPrice(context=context)
                   for l in self.objectValues() if l.meta_type==meta_type)
      elif not self.hasCellContent(base_id='movement'):
131
        return Movement._getTotalPrice(self, default=default, context=context)
132 133 134 135
      elif fast: # Use MySQL
        return self.DeliveryLine_zGetTotal()[0].total_price or 0.0
      return sum(cell.getTotalPrice(default=0.0, context=context)
                 for cell in self.getCellValueList())
136 137 138

    security.declareProtected( Permissions.AccessContentsInformation,
                               'getTotalQuantity')
139
    def getTotalQuantity(self, fast=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
140 141
      """
        Returns the quantity if no cell or the total quantity if cells
142

143 144 145 146
        if hasLineContent: return sum of lines total quantity
        if hasCellContent: return sum of cells total quantity
        else: return quantity
        if fast argument is true, then a SQL method will be used.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
147
      """
148
      base_id = 'movement'
149 150 151 152 153
      if self.hasLineContent():
        meta_type = self.meta_type
        return sum(l.getTotalQuantity() for l in
            self.objectValues() if l.meta_type==meta_type)
      elif self.hasCellContent(base_id=base_id):
154 155 156 157
        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()])
158 159 160 161 162 163 164 165 166 167 168 169 170
      else:
        return self.getQuantity()

    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasLineContent')
    def hasLineContent(self):
      """Return true if the object contains lines.

      This method only checks the first sub line because all sub
      lines should be same meta type in reality if we have line
      inside line.
      """
      return len(self) != 0 and self.objectValues()[0].meta_type == self.meta_type
Jean-Paul Smets's avatar
Jean-Paul Smets committed
171

172 173
    security.declareProtected(Permissions.AccessContentsInformation,
                              'hasCellContent')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
174
    def hasCellContent(self, base_id='movement'):
175
      """Return true if the object contains cells.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
176
      """
177 178 179 180 181 182 183 184 185 186
      # 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)
187 188
      # DeliveryLine can be a movement when it does not content any cell and 
      # matrix cell range is not empty.
189 190 191 192 193
      # 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
194

195 196 197 198 199 200 201 202 203
    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
204 205 206 207 208 209 210
    security.declareProtected( Permissions.AccessContentsInformation, 'getCellValueList' )
    def getCellValueList(self, base_id='movement'):
      """
          This method can be overriden
      """
      return XMLMatrix.getCellValueList(self, base_id=base_id)

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    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
230 231 232 233 234 235 236 237 238 239 240 241 242

    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)()

243 244 245 246
    def reindexObject(self, *k, **kw):
      """Reindex children"""
      self.recursiveReindexObject(*k, **kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
247 248 249 250
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedQuantity')
    def getInventoriatedQuantity(self):
      """
      """
251
      return Movement.getInventoriatedQuantity(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
252

253 254
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStartDate')
    def getInventoriatedStartDate(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
255 256
      """
      """
257
      return Movement.getStartDate(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258

259 260
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoriatedStopDate')
    def getInventoriatedStopDate(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
261 262
      """
      """
263
      return Movement.getStopDate(self)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
264

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
#     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
299 300

    # Simulation Consistency Check
301
    def getSimulationQuantity(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
302 303 304
      """
          Computes the quantities in the simulation
      """
305 306 307 308
      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
309
      return None
310 311 312 313 314 315 316

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

318 319 320 321 322 323
    def getSimulationDestinationList(self):
      """
          Computes the destinations in the simulation
      """
      result = self.DeliveryLine_zGetRelatedDestination(uid=self.getUid())
      return map(lambda x: x.destination, result)
324

325 326 327 328 329 330
    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)
331

332 333 334 335 336 337
    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
338

339 340
    security.declareProtected(Permissions.AccessContentsInformation,
                              'getRootDeliveryValue')
Sebastien Robin's avatar
Sebastien Robin committed
341 342 343 344
    def getRootDeliveryValue(self):
      """
      Returns the root delivery responsible of this line
      """
345
      return self.getParentValue().getRootDeliveryValue()
346

347 348
    security.declareProtected(Permissions.ModifyPortalContent,
                              'updateSimulationDeliveryProperties')
349 350
    def updateSimulationDeliveryProperties(self, movement_list = None):
      """
351 352 353
      Set properties delivery_ratio and delivery_error for each
      simulation movement in movement_list (all movements by default),
      according to this delivery calculated quantity
354
      """
355
      parent = self.getParentValue()
356 357
      if parent is not None:
        parent.updateSimulationDeliveryProperties(movement_list, self)
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

    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)

Łukasz Nowak's avatar
Łukasz Nowak committed
373 374 375 376
# divergence support with solving

    security.declareProtected(Permissions.View, 'isDivergent')
    def isDivergent(self):
Jérome Perrin's avatar
Jérome Perrin committed
377
      """ Returns true if the delivery line is divergent
Łukasz Nowak's avatar
Łukasz Nowak committed
378
      """
379
      return bool(self.getDivergenceList())
Łukasz Nowak's avatar
Łukasz Nowak committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

    security.declareProtected(Permissions.View, 'getDivergenceList')
    def getDivergenceList(self):
      """
      Return a list of messages that contains the divergences
      """
      divergence_list = []
      if self.hasCellContent():
        for cell in self.contentValues(filter={
                'portal_type': self.getPortalDeliveryMovementTypeList()}):
          divergence_list.extend(cell.getDivergenceList())
        return divergence_list
      else:
        return Movement.getDivergenceList(self)

    def _distributePropertyToSimulation(self, decision):
      """Distributes property from self to all related simulation movements

      AKA - accept decision"""
      for simulation_movement in self.getDeliveryRelatedValueList(
          portal_type='Simulation Movement'):
        simulation_movement.edit(**{
          decision.divergence.tested_property:
            self.getProperty(decision.divergence.tested_property)
        })

    def _updatePropertyFromSimulation(self, decision_list):
      """Update property from simulation
      'Stolen' from Products.ERP5.Document.DeliveryBuilder._solveDivergence

      Another possibility is to just simply copy properties or, in case of
      quantity, add from all simulation movements.
      """
      simulation_movement_list = self.getDeliveryRelatedValueList(
                                      portal_type="Simulation Movement")

      business_path = simulation_movement_list[0].getCausalityValue()
      delivery = self.getExplanationValue()
      delivery_portal_type = delivery.getPortalType()
      delivery_line_portal_type = self.getPortalType()
      # we need to find only one matching delivery builder
      for delivery_builder in business_path.getDeliveryBuilderValueList():
        if delivery_builder.getDeliveryPortalType() == \
             delivery_portal_type and \
           delivery_builder.getDeliveryLinePortalType() == \
             delivery_line_portal_type:
          break
      else:
        raise ValueError('No builder found')

      self.edit(quantity=0) # adoption have to 'rebuild' delivery line
      movement_type_list = (delivery_builder.getDeliveryLinePortalType(),
              delivery_builder.getDeliveryCellPortalType())
      # Collect
      root_group_node = delivery_builder.collectMovement(
          simulation_movement_list)

      divergence_list = [decision.divergence for decision in decision_list]

      # Build
      portal = self.getPortalObject()
      delivery_module = getattr(portal, delivery_builder.getDeliveryModule())
      delivery_to_update_list = [delivery]
      delivery_list = delivery_builder._processDeliveryGroup(
        delivery_module,
        root_group_node,
        delivery_builder.getDeliveryMovementGroupList(),
        delivery_to_update_list=delivery_to_update_list,
        divergence_list=divergence_list,
        force_update=1)

      new_delivery_list = [x for x in delivery_list if x != delivery]
      if new_delivery_list:
        raise ValueError('No new deliveries shall be created')

      # Then, we should re-apply quantity divergence according to 'Do
      # nothing' quantity divergence list because all quantity are already
      # calculated in adopt prevision phase.
      quantity_dict = {}
      for divergence in self.getDivergenceList():
        if divergence.getProperty('divergence_scope') != 'quantity' or \
               divergence in divergence_list:
          continue
        s_m = divergence.getProperty('simulation_movement')
        delivery_movement = s_m.getDeliveryValue()
        assert delivery_movement == self
        quantity_gap = divergence.getProperty('decision_value') - \
                       divergence.getProperty('prevision_value')
        delivery_movement.setQuantity(delivery_movement.getQuantity() + \
                                      quantity_gap)
        quantity_dict[s_m] = \
            divergence.getProperty('decision_value')

      # Finally, recalculate delivery_ratio
      #
      # Here, created/updated movements are not indexed yet. So we try to
      # gather delivery relations from simulation movements.
      delivery_dict = {}
      for s_m in simulation_movement_list:
        delivery_path = s_m.getDelivery()
        delivery_dict[delivery_path] = \
                                     delivery_dict.get(delivery_path, []) + \
                                     [s_m]

      for s_m_list_per_movement in delivery_dict.values():
        total_quantity = sum([quantity_dict.get(s_m, s_m.getQuantity()) \
                              for s_m in s_m_list_per_movement])
        if total_quantity != 0.0:
          for s_m in s_m_list_per_movement:
            delivery_ratio = quantity_dict.get(s_m, s_m.getQuantity()) \
                                               / total_quantity
            s_m.edit(delivery_ratio=delivery_ratio)
        else:
          for s_m in s_m_list_per_movement:
            delivery_ratio = 1.0 / len(s_m_list_per_movement)
            s_m.edit(delivery_ratio=delivery_ratio)

    def solve(self, decision_list):
      """Solves line according to decision list
      """
      simulation_tool = self.getPortalObject().portal_simulation
      solveMovement = simulation_tool.solveMovement
      solve_result_list = []
      # accept + split
      for decision in [q for q in decision_list if q.decision != 'adopt']:
        if decision.decision == 'accept':
          # accepting - in case of passed DeliverySolver use it, otherwise
          # simply copy values to simulation
          if not decision.delivery_solver_name:
            self._distributePropertyToSimulation(decision)
          solveMovement(self, decision.delivery_solver_name,
511
              decision.target_solver_name, divergence_list = [decision.divergence])
Łukasz Nowak's avatar
Łukasz Nowak committed
512 513 514 515 516 517 518 519 520 521
        elif decision.decision == 'split':
          solveMovement(self, decision.delivery_solver_name,
              decision.target_solver_name, **decision.split_kw)
        else: # aka - do nothing
          pass
      # adopt
      adopt_decision_list = [q for q in decision_list \
                             if q.decision == 'adopt']
      if adopt_decision_list:
        self._updatePropertyFromSimulation(adopt_decision_list)