SimulationTool.py 86.2 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.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
#
# 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 Products.CMFCore.utils import UniqueObject

from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, DTMLFile
33
from Products.ERP5Type.Document.Folder import Folder
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34
from Products.ERP5Type import Permissions
35
from Products.ERP5Type.Tool.BaseTool import BaseTool
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36 37 38 39 40 41 42

from Products.ERP5 import _dtmldir

from zLOG import LOG

from Products.ERP5.Capacity.GLPK import solve
from Numeric import zeros, resize
Alexandre Boeglin's avatar
Alexandre Boeglin committed
43
from DateTime import DateTime
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45 46 47 48 49 50 51

# Solver Registration
is_initialized = 0
delivery_solver_dict = {}
delivery_solver_list = []

def registerDeliverySolver(solver):
    global delivery_solver_list, delivery_solver_dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52
    #LOG('Register Solver', 0, str(solver.__name__))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55 56 57 58 59 60
    delivery_solver_list.append(solver)
    delivery_solver_dict[solver.__name__] = solver

target_solver_dict = {}
target_solver_list = []

def registerTargetSolver(solver):
    global target_solver_list, target_solver_dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61
    #LOG('Register Solver', 0, str(solver.__name__))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63 64 65 66 67 68 69 70 71 72
    target_solver_list.append(solver)
    target_solver_dict[solver.__name__] = solver

class Target:

  def __init__(self, **kw):
    """
      Defines a target (target_quantity, start_date, stop_date)
    """
    self.__dict__.update(kw)

73
class SimulationTool (BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    """
    The SimulationTool implements the ERP5
    simulation algorithmics.


    Examples of applications:

    -

    -
    ERP5 main purpose:

    -

    -

    """
    id = 'portal_simulation'
    meta_type = 'ERP5 Simulation Tool'
93
    portal_type = 'Simulation Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    allowed_types = ( 'ERP5 Applied Rule', )

    # Declarative Security
    security = ClassSecurityInfo()

    #
    #   ZMI methods
    #
    manage_options = ( ( { 'label'      : 'Overview'
                         , 'action'     : 'manage_overview'
                         }
                        ,
                        )
                     + Folder.manage_options
                     )

    security.declareProtected( Permissions.ManagePortal, 'manage_overview' )
    manage_overview = DTMLFile( 'explainSimulationTool', _dtmldir )

    # Filter content (ZMI))
114 115
    #def __init__(self):
    #    return Folder.__init__(self, SimulationTool.id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

    # Filter content (ZMI))
    def filtered_meta_types(self, user=None):
        # Filters the list of available meta types.
        all = SimulationTool.inheritedAttribute('filtered_meta_types')(self)
        meta_types = []
        for meta_type in self.all_meta_types():
            if meta_type['name'] in self.allowed_types:
                meta_types.append(meta_type)
        return meta_types

    def initialize(self):
      """
        Update values of simulation movements based on delivery
        target values and solver
      """
132
      from Products.ERP5.TargetSolver import Reduce, Defer, SplitAndDefer, CopyToTarget, Redirect
Jean-Paul Smets's avatar
Jean-Paul Smets committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
      from Products.ERP5.DeliverySolver import Distribute, Copy

    def isInitialized(self):
      global is_initialized
      return is_initialized

    def newDeliverySolver(self, solver_id, *args, **kw):
      """
        Returns a solver instance
      """
      if not self.isInitialized(): self.initialize()
      solver = delivery_solver_dict[solver_id](self, *args, **kw)
      return solver

    def applyDeliverySolver(self, movement, solver):
      """
        Update values of simulation movements based on delivery
        target values and solver.

        movement  --  a delivery line or cell

        solver    --  a delivery solver
      """
      if not self.isInitialized(): self.initialize()
      solver.solve(movement)

    def newTargetSolver(self, solver_id, *args, **kw):
      """
        Returns a solver instance
      """
      if not self.isInitialized(): self.initialize()
      solver = target_solver_dict[solver_id](self, *args, **kw)
      return solver

    def applyTargetSolver(self, movement, solver, new_target=None):
      """
        Update upper targets based on new targets

        movement  --  a simulation movement

        solver    --  a target solver

        new_target--  new target values for that movement
      """
      if new_target is None:
        # Default behaviour is to solve target based on
        # target defined by Delivery
        # it must be overriden in recursive upward update
        # to make sure
        new_target = Target(target_quantity = movement.getQuantity(),
                            target_start_date = movement.getStartDate(),
184 185 186 187 188 189
                            target_stop_date = movement.getStopDate(),
                            target_destination = movement.getDestination(),
                            target_destination_section = movement.getDestinationSection(),
                            target_source = movement.getSource(),
                            target_source_section = movement.getSourceSection())

Jean-Paul Smets's avatar
Jean-Paul Smets committed
190 191 192 193 194 195 196
      if not self.isInitialized(): self.initialize()
      solver.solve(movement, new_target)

    def closeTargetSolver(self, solver):
      return solver.close()

    def showTargetSolver(self, solver):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
197
      #LOG("SimulationTool",0,"in showTargetSolver")
Jean-Paul Smets's avatar
Jean-Paul Smets committed
198 199 200 201 202
      return str(solver.__dict__)


    #######################################################
    # Stock Management
203

204 205
    def _generateSQLKeywordDict(self, table='stock',
        from_date=None, to_date=None, at_date=None,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
206
        resource=None, node=None, payment=None,
207
        section=None, mirror_section=None,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
208
        resource_category=None, node_category=None, payment_category=None,
209
        section_category=None, mirror_section_category=None,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
210
        simulation_state=None, transit_simulation_state = None, omit_transit=0,
211
        input_simulation_state = None, output_simulation_state=None,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
212
        variation_text=None, variation_category=None,
213
        **kw) :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
214
      """
215
      generates keywork and calls buildSqlQuery
Alexandre Boeglin's avatar
Alexandre Boeglin committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
      """
      new_kw = {}
      new_kw.update(kw)
      sql_kw = {}

      date_dict = {'query':[], 'operator':'and'}
      if from_date :
        date_dict['query'].append(from_date)
        date_dict['range'] = 'min'
        if to_date :
          date_dict['query'].append(to_date)
          date_dict['range'] = 'minmax'
      elif to_date :
        date_dict['query'].append(to_date)
        date_dict['range'] = 'max'
      elif at_date :
        date_dict['query'].append(at_date)
        date_dict['range'] = 'ngt'
      if len(date_dict) :
235
        new_kw[table + '.date'] = date_dict
Alexandre Boeglin's avatar
Alexandre Boeglin committed
236 237 238 239 240 241 242

      resource_uid_list = []
      if type(resource) is type('') :
        resource_uid_list.append(self.portal_categories.restrictedTraverse(resource).getUid())
      elif type(resource) is type([]) or type(resource) is type(()) :
        for resource_item in resource :
          resource_uid_list.append(self.portal_categories.restrictedTraverse(resource_item).getUid())
243 244 245 246 247 248 249 250 251 252
      elif type(resource) is type({}) :
        tmp_uid_list = []
        if type(resource['query']) is type('') :
          resource['query'] = [resource['query']]
        for resource_item in resource['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(resource_item).getUid())
        if len(tmp_uid_list) :
          resource_uid_list = {}
          resource_uid_list['operator'] = resource['operator']
          resource_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
253
      if len(resource_uid_list) :
254
        new_kw[table + '.resource_uid'] = resource_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
255 256 257 258 259 260 261

      node_uid_list = []
      if type(node) is type('') :
        node_uid_list.append(self.portal_categories.restrictedTraverse(node).getUid())
      elif type(node) is type([]) or type(node) is type(()) :
        for node_item in node :
          node_uid_list.append(self.portal_categories.restrictedTraverse(node_item).getUid())
262 263 264 265 266 267 268 269 270 271
      elif type(node) is type({}) :
        tmp_uid_list = []
        if type(node['query']) is type('') :
          node['query'] = [node['query']]
        for node_item in node['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(node_item).getUid())
        if len(tmp_uid_list) :
          node_uid_list = {}
          node_uid_list['operator'] = node['operator']
          node_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
272
      if len(node_uid_list) :
273
        new_kw[table + '.node_uid'] = node_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
274 275 276 277 278 279 280

      payment_uid_list = []
      if type(payment) is type('') :
        payment_uid_list.append(self.portal_categories.restrictedTraverse(payment).getUid())
      elif type(payment) is type([]) or type(payment) is type(()) :
        for payment_item in payment :
          payment_uid_list.append(self.portal_categories.restrictedTraverse(payment_item).getUid())
281 282 283 284 285 286 287 288 289 290
      elif type(payment) is type({}) :
        tmp_uid_list = []
        if type(payment['query']) is type('') :
          payment['query'] = [payment['query']]
        for payment_item in payment['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(payment_item).getUid())
        if len(tmp_uid_list) :
          payment_uid_list = {}
          payment_uid_list['operator'] = payment['operator']
          payment_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
291
      if len(payment_uid_list) :
292
        new_kw[table + '.payment_uid'] = payment_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
293 294 295 296 297 298 299

      section_uid_list = []
      if type(section) is type('') :
        section_uid_list.append(self.portal_categories.restrictedTraverse(section).getUid())
      elif type(section) is type([]) or type(section) is type(()) :
        for section_item in section :
          section_uid_list.append(self.portal_categories.restrictedTraverse(section_item).getUid())
300 301 302 303 304 305 306 307 308 309
      elif type(section) is type({}) :
        tmp_uid_list = []
        if type(section['query']) is type('') :
          section['query'] = [section['query']]
        for section_item in section['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(section_item).getUid())
        if len(tmp_uid_list) :
          section_uid_list = {}
          section_uid_list['operator'] = section['operator']
          section_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
310
      if len(section_uid_list) :
311
        new_kw[table + '.section_uid'] = section_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
312 313 314 315 316 317 318

      mirror_section_uid_list = []
      if type(mirror_section) is type('') :
        mirror_section_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section).getUid())
      elif type(mirror_section) is type([]) or type(mirror_section) is type(()) :
        for mirror_section_item in mirror_section :
          mirror_section_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section_item).getUid())
319 320 321 322 323 324 325 326 327 328
      elif type(mirror_section) is type({}) :
        tmp_uid_list = []
        if type(mirror_section['query']) is type('') :
          mirror_section['query'] = [mirror_section['query']]
        for mirror_section_item in mirror_section['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section_item).getUid())
        if len(tmp_uid_list) :
          mirror_section_uid_list = {}
          mirror_section_uid_list['operator'] = mirror_section['operator']
          mirror_section_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
329
      if len(mirror_section_uid_list) :
330
        new_kw[table + '.mirror_section_uid'] = mirror_section_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
331 332 333

      variation_text_list = []
      if type(variation_text) is type('') :
334
        variation_text_list.append(variation_text) # Do not getUid for variation_text !
Alexandre Boeglin's avatar
Alexandre Boeglin committed
335 336 337
      elif type(variation_text) is type([]) or type(variation_text) is type(()) :
        for variation_text_item in variation_text :
          variation_text_list.append(variation_text_item)
338 339 340 341 342 343 344 345 346 347
      elif type(variation_text) is type({}) :
        tmp_uid_list = []
        if type(variation_text['query']) is type('') :
          variation_text['query'] = [variation_text['query']]
        for variation_text_item in variation_text['query'] :
          tmp_uid_list.append(variation_text_item)
        if len(tmp_uid_list) :
          variation_text_uid_list = {}
          variation_text_uid_list['operator'] = variation_text['operator']
          variation_text_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
348
      if len(variation_text_list) :
349
        new_kw[table + '.variation_text'] = variation_text_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
350 351 352 353 354 355 356

      resource_category_uid_list = []
      if type(resource_category) is type('') :
        resource_category_uid_list.append(self.portal_categories.restrictedTraverse(resource_category).getUid())
      elif type(resource_category) is type([]) or type(resource_category) is type(()) :
        for resource_category_item in resource_category :
          resource_category_uid_list.append(self.portal_categories.restrictedTraverse(resource_category_item).getUid())
357 358 359 360 361 362 363 364 365 366
      elif type(resource_category) is type({}) :
        tmp_uid_list = []
        if type(resource_category['query']) is type('') :
          resource_category['query'] = [resource_category['query']]
        for resource_category_item in resource_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(resource_category_item).getUid())
        if len(tmp_uid_list) :
          resource_category_uid_list = {}
          resource_category_uid_list['operator'] = resource_category['operator']
          resource_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
367
      if len(resource_category_uid_list) :
368
        new_kw[table + '_resourceCategory'] = resource_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
369 370 371 372 373 374 375

      node_category_uid_list = []
      if type(node_category) is type('') :
        node_category_uid_list.append(self.portal_categories.restrictedTraverse(node_category).getUid())
      elif type(node_category) is type([]) or type(node_category) is type(()) :
        for node_category_item in node_category :
          node_category_uid_list.append(self.portal_categories.restrictedTraverse(node_category_item).getUid())
376 377 378 379 380 381 382 383 384 385
      elif type(node_category) is type({}) :
        tmp_uid_list = []
        if type(node_category['query']) is type('') :
          node_category['query'] = [node_category['query']]
        for node_category_item in node_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(node_category_item).getUid())
        if len(tmp_uid_list) :
          node_category_uid_list = {}
          node_category_uid_list['operator'] = node_category['operator']
          node_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
386
      if len(node_category_uid_list) :
387
        new_kw[table + '_nodeCategory'] = node_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
388 389 390 391 392 393 394

      payment_category_uid_list = []
      if type(payment_category) is type('') :
        payment_category_uid_list.append(self.portal_categories.restrictedTraverse(payment_category).getUid())
      elif type(payment_category) is type([]) or type(payment_category) is type(()) :
        for payment_category_item in payment_category :
          payment_category_uid_list.append(self.portal_categories.restrictedTraverse(payment_category_item).getUid())
395 396 397 398 399 400 401 402 403 404
      elif type(payment_category) is type({}) :
        tmp_uid_list = []
        if type(payment_category['query']) is type('') :
          payment_category['query'] = [payment_category['query']]
        for payment_category_item in payment_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(payment_category_item).getUid())
        if len(tmp_uid_list) :
          payment_category_uid_list = {}
          payment_category_uid_list['operator'] = payment_category['operator']
          payment_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
405
      if len(payment_category_uid_list) :
406
        new_kw[table + '_paymentCategory'] = payment_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
407 408 409 410 411 412 413

      section_category_uid_list = []
      if type(section_category) is type('') :
        section_category_uid_list.append(self.portal_categories.restrictedTraverse(section_category).getUid())
      elif type(section_category) is type([]) or type(section_category) is type(()) :
        for section_category_item in section_category :
          section_category_uid_list.append(self.portal_categories.restrictedTraverse(section_category_item).getUid())
414 415 416 417 418 419 420 421 422 423
      elif type(section_category) is type({}) :
        tmp_uid_list = []
        if type(section_category['query']) is type('') :
          section_category['query'] = [section_category['query']]
        for section_category_item in section_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(section_category_item).getUid())
        if len(tmp_uid_list) :
          section_category_uid_list = {}
          section_category_uid_list['operator'] = section_category['operator']
          section_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
424
      if len(section_category_uid_list) :
425
        new_kw[table + '_sectionCategory'] = section_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
426 427 428 429 430 431 432

      mirror_section_category_uid_list = []
      if type(mirror_section_category) is type('') :
        mirror_section_category_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section_category).getUid())
      elif type(mirror_section_category) is type([]) or type(mirror_section_category) is type(()) :
        for mirror_section_category_item in mirror_section_category :
          mirror_section_category_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section_category_item).getUid())
433 434 435 436 437 438 439 440 441 442
      elif type(mirror_section_category) is type({}) :
        tmp_uid_list = []
        if type(mirror_section_category['query']) is type('') :
          mirror_section_category['query'] = [mirror_section_category['query']]
        for mirror_section_category_item in mirror_section_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(mirror_section_category_item).getUid())
        if len(tmp_uid_list) :
          mirror_section_category_uid_list = {}
          mirror_section_category_uid_list['operator'] = mirror_section_category['operator']
          mirror_section_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
443
      if len(mirror_section_category_uid_list) :
444
        new_kw[table + '_mirrorSectionCategory'] = mirror_section_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
445 446 447 448 449 450 451

      variation_category_uid_list = []
      if type(variation_category) is type('') :
        variation_category_uid_list.append(self.portal_categories.restrictedTraverse(variation_category).getUid())
      elif type(variation_category) is type([]) or type(variation_category) is type(()) :
        for variation_category_item in variation_category :
          variation_category_uid_list.append(self.portal_categories.restrictedTraverse(variation_category_item).getUid())
452 453 454 455 456 457 458 459 460 461
      elif type(variation_category) is type({}) :
        tmp_uid_list = []
        if type(variation_category['query']) is type('') :
          variation_category['query'] = [variation_category['query']]
        for variation_category_item in variation_category['query'] :
          tmp_uid_list.append(self.portal_categories.restrictedTraverse(variation_category_item).getUid())
        if len(tmp_uid_list) :
          variation_category_uid_list = {}
          variation_category_uid_list['operator'] = variation_category['operator']
          variation_category_uid_list['query'] = tmp_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
462 463 464 465 466 467 468
      if len(variation_category_uid_list) :
        new_kw['variationCategory'] = variation_category_uid_list

      # Simulation States
      # first, we evaluate simulation_state
      if (type(simulation_state) is type('')) or (type(simulation_state) is type([])) or (type(simulation_state) is type(())) :
        if len(simulation_state) :
469 470
          sql_kw['input_simulation_state'] = simulation_state
          sql_kw['output_simulation_state'] = simulation_state
Alexandre Boeglin's avatar
Alexandre Boeglin committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
      # then, if omit_transit == 1, we evaluate (simulation_state - transit_simulation_state) for input_simulation_state
      if omit_transit == 1 :
        if (type(simulation_state) is type('')) or (type(simulation_state) is type([])) or (type(simulation_state) is type(())) :
          if len(simulation_state) :
            if (type(transit_simulation_state) is type('')) or (type(transit_simulation_state) is type([])) or (type(transit_simulation_state) is type(())) :
              if len(transit_simulation_state) :
                # when we know both are usable, we try to calculate (simulation_state - transit_simulation_state)
                if type(simulation_state) is type('') :
                  simulation_state = [simulation_state]
                if type(transit_simulation_state) is type('') :
                  transit_simulation_state = [transit_simulation_state]
                delivered_simulation_state_list = []
                for state in simulation_state :
                  if state not in transit_simulation_state :
                    delivered_simulation_state_list.append(state)
486
                sql_kw['input_simulation_state'] = delivered_simulation_state_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
487 488 489
      # alternatively, the user can directly define input_simulation_state and output_simulation_state
      if (type(input_simulation_state) is type('')) or (type(input_simulation_state) is type([])) or (type(input_simulation_state) is type(())) :
        if len(input_simulation_state) :
490
          sql_kw['input_simulation_state'] = input_simulation_state
Alexandre Boeglin's avatar
Alexandre Boeglin committed
491 492
      if (type(output_simulation_state) is type('')) or (type(output_simulation_state) is type([])) or (type(output_simulation_state) is type(())) :
        if len(output_simulation_state) :
493 494 495 496 497
          sql_kw['output_simulation_state'] = output_simulation_state
      if type(sql_kw.get('input_simulation_state')) is type('') :
        sql_kw['input_simulation_state'] = [sql_kw['input_simulation_state']]
      if type(sql_kw.get('output_simulation_state')) is type('') :
        sql_kw['output_simulation_state'] = [sql_kw['output_simulation_state']]
Alexandre Boeglin's avatar
Alexandre Boeglin committed
498 499 500

      sql_kw.update(self.portal_catalog.buildSQLQuery(**new_kw))

501 502
      return sql_kw

Jean-Paul Smets's avatar
Jean-Paul Smets committed
503 504
    #######################################################
    # Inventory management                  
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
    security.declareProtected(Permissions.AccessContentsInformation, 'getInventory')
    def getInventory(self, src__=0,
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
        selection_domain=None, selection_report=None, **kw) :
      """
      from_date (>=) -

      to_date   (<)  -

      at_date   (<=) - only take rows which date is <= at_date

      resource (only in generic API in simulation)

      node        -  only take rows in stock table which node_uid is equivalent to node

      payment        -  only take rows in stock table which payment_uid is equivalent to payment

      section        -  only take rows in stock table which section_uid is equivalent to section

      mirror_section

      resource_category        -  only take rows in stock table which resource_uid is in resource_category

      node_category        -  only take rows in stock table which node_uid is in section_category

      payment_category        -  only take rows in stock table which payment_uid is in section_category

      section_category        -  only take rows in stock table which section_uid is in section_category

      mirror_section_category

      variation_text - only take rows in stock table with specified variation_text
                       this needs to be extended with some kind of variation_category ?
                       XXX this way of implementing variation selection is far from perfect

      variation_category - variation or list of possible variations

      simulation_state - only take rows with specified simulation_state

      transit_simulation_state - take rows with specified transit_simulation_state and quantity < 0

      omit_transit - do not evaluate transit_simulation_state

      input_simulation_state - only take rows with specified input_simulation_state and quantity > 0

      output_simulation_state - only take rows with specified output_simulation_state and quantity < 0

      ignore_variation - do not take into account variation in inventory calculation

      standardise - provide a standard quantity rather than an SKU

      omit_simulation

      omit_input

      omit_output

      selection_domain, selection_report - see ListBox

      **kw  - if we want extended selection with more keywords (but bad performance)
              check what we can do with buildSqlQuery
      """
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
569
      result = self.Resource_zGetInventory(src__=src__,
570
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
571 572
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
573 574 575 576
      if src__ :
        return result

      if len(result) > 0 and result[0].inventory is not None :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
577 578 579
        return result[0].inventory
      return 0.0

Alexandre Boeglin's avatar
Alexandre Boeglin committed
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventory')
    def getCurrentInventory(self, **kw):
      """
      Returns current inventory
      """
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
      return self.getInventory(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getAvailableInventory')
    def getAvailableInventory(self, **kw):
      """
      Returns available inventory
      (current inventory - deliverable)
      """
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
      return self.getInventory(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureInventory')
    def getFutureInventory(self, **kw):
      """
      Returns future inventory
      """
602 603
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
604 605 606
      return self.getInventory(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryList')
607
    def getInventoryList(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
608
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
609
        selection_domain=None, selection_report=None, **kw) :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
610 611 612
      """
      Returns list of inventory grouped by section or site
      """
613 614
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
615
      return self.Resource_zGetInventoryList(src__=src__,
616 617 618
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
619 620 621 622 623 624

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventoryList')
    def getCurrentInventoryList(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
625
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
626 627 628 629 630 631 632
      return self.getInventoryList(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureInventoryList')
    def getFutureInventoryList(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
633 634
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
635 636 637
      return self.getInventoryList(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryStat')
638
    def getInventoryStat(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
639
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
640
        selection_domain=None, selection_report=None, **kw) :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
641 642 643
      """
      Returns statistics of inventory grouped by section or site
      """
644 645
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
646
      return self.Resource_zGetInventory(src__=src__,
647 648 649
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
650 651 652 653 654 655

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventoryStat')
    def getCurrentInventoryStat(self, **kw):
      """
      Returns statistics of current inventory grouped by section or site
      """
656
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
657 658 659 660 661 662 663
      return self.getInventoryStat(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureInventoryStat')
    def getFutureInventoryStat(self, **kw):
      """
      Returns statistics of future inventory grouped by section or site
      """
664 665
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
666 667 668
      return self.getInventoryStat(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
669
    def getInventoryChart(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
670 671 672
      """
      Returns list of inventory grouped by section or site
      """
Alexandre Boeglin's avatar
Alexandre Boeglin committed
673
      result = self.getInventoryList(src__=src__, **kw)
674
      if src__ :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
675
        return result
676 677

      return map(lambda r: (r.node_title, r.inventory), result)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
678 679 680 681 682 683

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventoryChart')
    def getCurrentInventoryChart(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
684
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
685 686 687 688 689 690 691
      return self.getInventoryChart(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureInventoryChart')
    def getFutureInventoryChart(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
692 693
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
694 695 696
      return self.getInventoryChart(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryAssetPrice')
697
    def getInventoryAssetPrice(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
698
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
699
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
700 701 702
      """
      Returns list of inventory grouped by section or site
      """
703 704
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
705
      return self.Resource_zGetInventoryAssetPrice(src__=src__,
706 707 708
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
709 710 711 712 713 714

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentInventoryAssetPrice')
    def getCurrentInventoryAssetPrice(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
715
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
716 717 718 719 720 721 722 723
      return self.getInventoryAssetPrice(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getAvailableInventoryAssetPrice')
    def getAvailableInventoryAssetPrice(self, **kw):
      """
      Returns list of available inventory grouped by section or site
      (current inventory - deliverable)
      """
724
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
725 726 727 728 729 730 731
      return self.getInventoryAssetPrice(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureInventoryAssetPrice')
    def getFutureInventoryAssetPrice(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
732 733
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
734 735 736
      return self.getInventoryAssetPrice(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryHistoryList')
737
    def getInventoryHistoryList(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
738
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
739
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
740 741 742
      """
      Returns list of inventory grouped by section or site
      """
743 744
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
745
      return self.Resource_getInventoryHistoryList(src__=src__,
746 747 748
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
749 750

    security.declareProtected(Permissions.AccessContentsInformation, 'getInventoryHistoryChart')
751
    def getInventoryHistoryChart(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
752
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
753
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
754 755 756
      """
      Returns list of inventory grouped by section or site
      """
757 758
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
759
      return self.Resource_getInventoryHistoryChart(src__=src__,
760 761 762
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
763 764

    security.declareProtected(Permissions.AccessContentsInformation, 'getMovementHistoryList')
765
    def getMovementHistoryList(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
766
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
767
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
768 769 770
      """
      Returns list of inventory grouped by section or site
      """
771 772
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
773
      return self.Resource_zGetMovementHistoryList(src__=src__,
774 775 776
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
777 778

    security.declareProtected(Permissions.AccessContentsInformation, 'getMovementHistoryStat')
779
    def getMovementHistoryStat(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
780
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
781
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
782 783 784
      """
      Returns statistics of inventory grouped by section or site
      """
785 786
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
787
      return self.Resource_zGetInventory(src__=src__,
788 789 790
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
791 792

    security.declareProtected(Permissions.AccessContentsInformation, 'getNextNegativeInventoryDate')
793
    def getNextNegativeInventoryDate(self, src__=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
794
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
795
        selection_domain=None, selection_report=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
796 797 798
      """
      Returns statistics of inventory grouped by section or site
      """
799 800
      sql_kw = self._generateSQLKeywordDict(**kw)

Alexandre Boeglin's avatar
Alexandre Boeglin committed
801
      result = self.Resource_getInventoryHistoryList(src__=src__,
802 803 804
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
805 806
      if src__ :
        return result
807 808 809 810 811

      for inventory in result:
        if inventory['inventory'] < 0:
          return inventory['stop_date']
      return None
Alexandre Boeglin's avatar
Alexandre Boeglin committed
812

Jean-Paul Smets's avatar
Jean-Paul Smets committed
813 814 815 816 817 818
    #######################################################
    # Traceability management                  
    security.declareProtected(Permissions.AccessContentsInformation, 'getTrackingList')
    def getTrackingList(self, src__=0,
        selection_domain=None, selection_report=None, **kw) :
      """
819
      Returns a list of items in the form
Jean-Paul Smets's avatar
Jean-Paul Smets committed
820 821 822 823 824 825 826
      
        uid (of item)
        date
        node_uid
        section_uid
        resource_uid
        variation_text
827 828 829 830 831 832 833 834 835 836
      
      If at_date is provided, returns the a list which answers
      to the question "where are those items at this date" or
      "which are those items which are there a this date"

      If at_date is not provided, returns a history of positions
      which answers the question "where have those items been
      between this time and this time". This will be handled by
      something like getTrackingHistoryList
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
837 838 839 840 841 842 843 844 845
      This method is only suitable for singleton items (an item which can 
      only be at a single place at a given time). Such items include
      containers, serial numbers (ex. for engine), rolls with subrolls,
      
      This method is not suitable for batches (ex. a coloring batch). 
      For such items, standard getInventoryList method is appropriate
      
      Parameters are the same as for getInventory.
      
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
      Default sort orders is based on dates, reverse.


      from_date (>=) -

      to_date   (<)  -

      at_date   (<=) - only take rows which date is <= at_date

      resource (only in generic API in simulation)

      node        -  only take rows in stock table which node_uid is equivalent to node

      section        -  only take rows in stock table which section_uid is equivalent to section

      resource_category        -  only take rows in stock table which resource_uid is in resource_category

      node_category        -  only take rows in stock table which node_uid is in section_category

      section_category        -  only take rows in stock table which section_uid is in section_category

      variation_text - only take rows in stock table with specified variation_text
                       this needs to be extended with some kind of variation_category ?
                       XXX this way of implementing variation selection is far from perfect

      variation_category - variation or list of possible variations

      simulation_state - only take rows with specified simulation_state

      transit_simulation_state - take rows with specified transit_simulation_state and quantity < 0

      omit_transit - do not evaluate transit_simulation_state

      input_simulation_state - only take rows with specified input_simulation_state and quantity > 0

      output_simulation_state - only take rows with specified output_simulation_state and quantity < 0

      selection_domain, selection_report - see ListBox

      **kw  - if we want extended selection with more keywords (but bad performance)
              check what we can do with buildSqlQuery
      
Jean-Paul Smets's avatar
Jean-Paul Smets committed
888
      """
889 890 891
      node_uid = self.portal_categories.getCategoryUid(kw.get('node'))
      return self.Resource_zGetTrackingList(src__=src__,node_uid=node_uid,at_date=kw.get('at_date'))
      #sql_kw = self._generateSQLKeywordDict(table='item', **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
892

893 894
      #return self.Resource_zGetTrackingList(src__=src__,
      #    selection_domain=selection_domain, selection_report=selection_report, **sql_kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentTrackingList')
    def getCurrentTrackingList(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
      return self.getTrackingList(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureTrackingList')
    def getFutureTrackingList(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
      kw['simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
      return self.getTrackingList(**kw)

          
Jean-Paul Smets's avatar
Jean-Paul Smets committed
914 915
    #######################################################
    # Movement Group Collection / Delivery Creation
916

Jean-Paul Smets's avatar
Jean-Paul Smets committed
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    def buildOrderList(self, movement_group):
      # Build orders from a list of movements (attached to orders)
      order_list = []

      if movement_group is not None:
        for order_group in movement_group.group_list:
          if order_group.order is None:
            # Only build if there is not order yet
            for path_group in order_group.group_list :
              if path_group.destination.find('site/Stock_PF') >=0 :
                # Build a Production Order
                delivery_module = self.ordre_fabrication
                delivery_type = 'Production Order'
                delivery_line_type = delivery_type + ' Line'
                delivery_cell_type = 'Delivery Cell'
              else:
                # Build a Purchase Order
                delivery_module = self.commande_achat
                delivery_type = 'Purchase Order'
                delivery_line_type = delivery_type + ' Line'
                delivery_cell_type = 'Delivery Cell'
              # we create a new delivery for each DateGroup
              for date_group in path_group.group_list :

                for resource_group in date_group.group_list :

                  # Create a new production Order for each resource (Modele)
                  modele_url_items = resource_group.resource.split('/')
                  modele_id = modele_url_items[len(modele_url_items)-1]
                  try :
                    modele_object = self.getPortalObject().modele[modele_id]
                  except :
                    modele_object = None
                  if modele_object is not None :
                    of_description = modele_id + ' ' + modele_object.getDefaultDestinationTitle('')
                  else :
                    of_description = modele_id

                  new_delivery_id = str(delivery_module.generateNewId())
                  self.portal_types.constructContent(type_name = delivery_type,
                                                      container = delivery_module,
                                                      id = new_delivery_id,
                                                      start_date = date_group.start_date,
                                                      stop_date = date_group.stop_date,
                                                      source = path_group.source,
                                                      destination = path_group.destination,
                                                      source_section = path_group.source_section,
                                                      destination_section = path_group.destination_section,
                                                      description = of_description,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
966
                                                      title = new_delivery_id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
                                                    )
                  delivery = delivery_module[new_delivery_id]
                  # the new delivery is added to the order_list
                  order_list.append(delivery)

                  # Create each delivery_line in the new delivery

                  new_delivery_line_id = str(delivery.generateNewId())
                  self.portal_types.constructContent(type_name = delivery_line_type,
                  container = delivery,
                  id = new_delivery_line_id,
                  resource = resource_group.resource,
                  )
                  delivery_line = delivery[new_delivery_line_id]

                  line_variation_category_list = []
                  line_variation_base_category_dict = {}

                  # compute line_variation_base_category_list and
                  # line_variation_category_list for new delivery_line
                  for variant_group in resource_group.group_list :
                    for variation_item in variant_group.category_list :
                      if not variation_item in line_variation_category_list :
                        line_variation_category_list.append(variation_item)
                        variation_base_category_items = variation_item.split('/')
                        if len(variation_base_category_items) > 0 :
                          line_variation_base_category_dict[variation_base_category_items[0]] = 1

                  # update variation_base_category_list and line_variation_category_list for delivery_line
                  line_variation_base_category_list = line_variation_base_category_dict.keys()
                  delivery_line.setVariationBaseCategoryList(line_variation_base_category_list)
                  delivery_line.setVariationCategoryList(line_variation_category_list)

                  # IMPORTANT : delivery cells are automatically created during setVariationCategoryList

1002
                  # update quantity for each delivery_cell
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1003
                  for variant_group in resource_group.group_list :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1004
                    #LOG('Variant_group examin',0,str(variant_group.category_list))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1005 1006 1007 1008 1009 1010 1011
                    object_to_update = None
                    # if there is no variation of the resource, update delivery_line with quantities and price
                    if len(variant_group.category_list) == 0 :
                      object_to_update = delivery_line
                    # else find which delivery_cell is represented by variant_group
                    else :
                      categories_identity = 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012 1013
                      #LOG('Before Check cell',0,str(delivery_cell_type))
                      #LOG('Before Check cell',0,str(delivery_line.contentValues()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1014
                      for delivery_cell in delivery_line.contentValues(filter={'portal_type':'Delivery Cell'}) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1015 1016 1017
                        #LOG('Check cell',0,str(delivery_cell))
                        #LOG('Check cell',0,str(variant_group.category_list))
                        #LOG('Check cell',0,str(delivery_cell.getVariationCategoryList()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1018
                        if len(variant_group.category_list) == len(delivery_cell.getVariationCategoryList()) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1019
                          #LOG('Parse category',0,str(delivery_cell.getVariationCategoryList()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1020 1021
                          for category in delivery_cell.getVariationCategoryList() :
                            if not category in variant_group.category_list :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1022
                              #LOG('Not found category',0,str(category))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1023 1024 1025 1026 1027 1028 1029 1030
                              break
                          else :
                            categories_identity = 1

                        if categories_identity :
                          object_to_update = delivery_cell
                          break

1031
                    # compute quantity and price for delivery_cell or delivery_line and
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1032 1033
                    # build relation between simulation_movement and delivery_cell or delivery_line
                    if object_to_update is not None :
1034
                      cell_quantity = 0
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1035
                      for movement in variant_group.movement_list :
1036
                        cell_quantity += movement.getConvertedQuantity()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1037 1038
                      # We do not create a relation or modifu anything
                      # since planification of this movement will create new applied rule
1039
                      object_to_update.edit(quantity = cell_quantity,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1040
                                            force_update = 1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070

      return order_list

    #######################################################
    # Capacity Management
    security.declareProtected( Permissions.ModifyPortalContent, 'updateCapacity' )
    def updateCapacity(self, node):
      capacity_item_list = []
      for o in node.contentValues():
        if o.isCapacity():
          # Do whatever is needed
          capacity_item_list += o.asCapacityItemList()
          pass
      # Do whatever with capacity_item_list
      # and store the resulting new capacity in node
      node._capacity_item_list = capacity_item_list

    security.declareProtected( Permissions.ModifyPortalContent, 'isMovementInsideCapacity' )
    def isMovementInsideCapacity(self, movement):
      """
        Purpose: provide answer to customer for the question "can you do it ?"

        movement:
          date
          source destination (2 nodes)
          source_section ...
      """
      # Get nodes and dat
      source_node = movement.getSourceValue()
      destination_node = movement.getDestinationValue()
1071 1072
      start_date = movement.getStartDate()
      stop_date = movement.getStopDate()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
      # Return result
      return self.isNodeInsideCapacity(source_node, start_date, additional_movement=movement, sign=1) and self.isNodeInsideCapacity(destination_node, stop_date, additional_movement=movement, sign=-1)

    security.declareProtected( Permissions.ModifyPortalContent, 'isNodeInsideCapacity' )
    def isNodeInsideCapacity(self, node, date, simulation_state=None, additional_movement=None, sign=1):
      """
        Purpose: decide if a node is consistent with its capacity definitions
        at a certain date (ie. considreing the stock / production history
      """
      # First get the current inventory situation for this node
      inventory_list = node.getInventoryList(XXXXX)
      # Add additional movement
      if additional_movement:
          inventory_list = inventory_list + sign * additional_movement # needs to be implemented
      # Return answer
      return self.isAmountListInsideCapacity(node, inventory_list)

    security.declareProtected( Permissions.ModifyPortalContent, 'isAmountListInsideCapacity' )
    def isAmountListInsideCapacity(self, node, amount_list,
         resource_aggregation_base_category=None, resource_aggregation_depth=None):
      """
        Purpose: decide if a list of amounts is consistent with the capacity of a node

        If any resource in amount_list is missing in the capacity of the node, resource
        aggregation is performed, based on resource_aggregation_base_category. If the
        base category is not specified, it is an error (should guess instead?). The resource
        aggregation is done at the level of resource_aggregation_depth in the tree
        of categories. If resource_aggregation_depth is not specified, it's an error.

        Assumptions: amount_list is an association list, like ((R1 V1) (R2 V2)).
                     node has an attribute '_capacity_item_list' which is a list of association lists.
                     resource_aggregation_base_category is a Base Category object or a list of Base
                     Category objects or None.
                     resource_aggregation_depth is a strictly positive integer or None.
      """
      # Make a copy of the attribute _capacity_item_list, because it may be necessary
      # to modify it for resource aggregation.
      capacity_item_list = node._capacity_item_list[:]

      # Make a mapping between resources and its indices.
      resource_map = {}
      index = 0
      for alist in capacity_item_list:
        for pair in alist:
          resource = pair[0]
#          LOG('isAmountListInsideCapacity', 0,
#              "resource is %s" % repr(resource))
          if resource not in resource_map:
            resource_map[resource] = index
            index += 1

      # Build a point from the amount list.
      point = zeros(index, 'd') # Fill up zeros for safety.
      mask_map = {}     # This is used to skip items in amount_list.
      for amount in amount_list:
        if amount[0] in mask_map:
          continue
        # This will fail, if amount_list has any different resource from the capacity.
        # If it has any different point, then we should ......
        #
        # There would be two possible different solutions:
        # 1) If a missing resource is a meta-resource of resources supported by the capacity,
        #    it is possible to add the resource into the capacity by aggregation.
        # 2) If a missing resource has a meta-resource as a parent and the capacity supports
        #    the meta-resource directly or indirectly (`indirectly' means `by aggregation'),
        #    it is possible to convert the missing resource into the meta-resource.
        #
        # However, another way has been implemented here. This does the following, if the resource
        # is not present in the capacity:
        # 1) If the value is zero, just ignore the resource, because zero is always acceptable.
        # 2) Attempt to aggregate resources both of the capacity and of the amount list. This aggregation
        #    is performed at the depth of 'resource_aggregation_depth' under the base category
        #    'resource_aggregation_base_category'.
        #
        resource = amount[0]
        if resource in resource_map:
          point[resource_map[amount[0]]] = amount[1]
        else:
          if amount[1] == 0:
            # If the value is zero, no need to consider.
            pass
          elif resource_aggregation_base_category is None or resource_aggregation_depth is None:
            # XXX use an appropriate error class
            # XXX should guess a base category instead of emitting an exception
            raise RuntimeError, "The resource '%s' is not found in the capacity, and the argument 'resource_aggregation_base_category' or the argument 'resource_aggregation_depth' is not specified" % resource
          else:
            # It is necessary to aggregate resources, to guess the capacity of this resource.

            def getAggregationResourceUrl(url, depth):
              # Return a partial url of the argument 'url'.
              # If 'url' is '/foo/bar/baz' and 'depth' is 2, return '/foo/bar'.
              pos = 0
              for i in range(resource_aggregation_depth):
                pos = url.find('/', pos+1)
                if pos < 0:
                  break
              if pos < 0:
                return None
              pos = url.find('/', pos+1)
              if pos < 0:
                pos = len(url)
              return url[:pos]

            def getAggregatedResourceList(aggregation_url, category, resource_list):
              # Return a list of resources which should be aggregated. 'aggregation_url' is used
              # for a top url of those resources. 'category' is a base category for the aggregation.
              aggregated_resource_list = []
              for resource in resource_list:
                for url in resource.getCategoryMembershipList(category, base=1):
                  if url.startswith(aggregation_url):
                    aggregated_resource_list.append(resource)
              return aggregated_resource_list

            def getAggregatedItemList(item_list, resource_list, aggregation_resource):
              # Return a list of association lists, which is a result of an aggregation.
              # 'resource_list' is a list of resources which should be aggregated.
              # 'aggregation_resource' is a category object which is a new resource created by
              # this aggregation.
              # 'item_list' is a list of association lists.
              new_item_list = []
              for alist in item_list:
                new_val = 0
                new_alist = []
                # If a resource is not a aggregated, then add it to the new alist as it is.
                # Otherwise, aggregate it to a single value.
                for pair in alist:
                  if pair[0] in resource_list:
                    new_val += pair[1]
                  else:
                    new_alist.append(pair)
                # If it is zero, ignore this alist, as it is nonsense.
                if new_val != 0:
                  new_alist.append([aggregation_resource, new_val])
                  new_item_list.append(new_alist)
              return new_item_list

            # Convert this to a string if necessary, for convenience.
            if type(resource_aggregation_base_category) not in (type([]), type(())):
              resource_aggregation_base_category = (resource_aggregation_base_category,)

            done = 0
#            LOG('isAmountListInsideCapacity', 0,
#                "resource_aggregation_base_category is %s" % repr(resource_aggregation_base_category))
            for category in resource_aggregation_base_category:
              for resource_url in resource.getCategoryMembershipList(category, base=1):
                aggregation_url = getAggregationResourceUrl(resource_url,
                                                            resource_aggregation_depth)
                if aggregation_url is None:
                  continue
                aggregated_resource_list = getAggregatedResourceList (aggregation_url,
                                                                      category,
                                                                      resource_map.keys())
                # If any, do the aggregation.
                if len(aggregated_resource_list) > 0:
                  aggregation_resource = self.portal_categories.resolveCategory(aggregation_url)
                  # Add the resource to the mapping.
 #                 LOG('aggregation_resource', 0, str(aggregation_resource))
                  resource_map[aggregation_resource] = index
                  index += 1
                  # Add the resource to the point.
                  point = resize(point, (index,))
                  val = 0
                  for aggregated_amount in amount_list:
                    for url in aggregated_amount[0].getCategoryMembershipList(category, base=1):
                      if url.startswith(aggregation_url):
                        val += aggregated_amount[1]
                        mask_map[aggregated_amount[0]] = None
                        break
                  point[index-1] = val
                  # Add capacity definitions of the resource into the capacity.
                  capacity_item_list += getAggregatedItemList(capacity_item_list,
                                                              aggregated_resource_list,
                                                              aggregation_resource)
                  done = 1
                  break
              if done:
                break
            if not done:
              raise RuntimeError, "Aggregation failed"

      # Build a matrix from the capacity item list.
#      LOG('resource_map', 0, str(resource_map))
      matrix = zeros((len(capacity_item_list)+1, index), 'd')
      for index in range(len(capacity_item_list)):
        for pair in capacity_item_list[index]:
          matrix[index,resource_map[pair[0]]] = pair[1]

#      LOG('isAmountListInsideCapacity', 0,
#          "matrix = %s, point = %s, capacity_item_list = %s" % (str(matrix), str(point), str(capacity_item_list)))
      return solve(matrix, point)


Jean-Paul Smets's avatar
Jean-Paul Smets committed
1265 1266
    # Asset Price Calculation
    def updateAssetPrice(self, resource, variation_text, section_category, node_category,
1267 1268 1269
                         strict_membership=0, simulation_state=None):
      if simulation_state is None:
        simulation_state = self.getPortalCurrentInventoryStateList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1270 1271 1272 1273 1274 1275
      section_value = self.portal_categories.resolveCategory(section_category)
      node_value = self.portal_categories.resolveCategory(node_category)
      # Initialize price
      current_asset_price = 0.0 # Missing: initial inventory price !!!
      current_inventory = 0.0
      # Parse each movement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1276
      brain_list = self.Resource_zGetMovementHistoryList(resource=[resource],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1277 1278 1279 1280
                             variation_text=variation_text,
                             section_category=section_category,
                             node_category=node_category,
                             strict_membership=strict_membership,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1281 1282 1283 1284
                             simulation_state=simulation_state) # strict_membership not taken into account
                             # We select movements related to certain nodes (ex. Stock) and sections (ex.Coramy Group)
      result = []
      for b in brain_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1285 1286
        m = b.getObject()
        if m is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
          previous_inventory = current_inventory
          inventory_quantity = b.quantity # We should use the aggregated quantity provided by Resource_zGetMovementHistoryList
          quantity = m.getQuantity() # The movement quantity is important to determine the meaning of source and destination
          # Maybe we should take care of target qty in delired deliveries
          if quantity is None:
            quantity = 0.0
          if m.getSourceValue() is None:
            # This is a production movement or an inventory movement
            # Use Industrial Price
            current_inventory += inventory_quantity # Update inventory
            if m.getPortalType() in ('Inventory Line', 'Inventory Cell'): # XX should be replaced by isInventory ???
              asset_price = m.getPrice()
              if asset_price in (0.0, None):
                asset_price = current_asset_price # Use current price if no price defined
            else: # this is a production
              asset_price = m.getIndustrialPrice()
              if asset_price is None: asset_price = current_asset_price  # Use current price if no price defined
            result.append((m.getRelativeUrl(), m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1305
                          m.getQuantity(), 'Production or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1306 1307 1308 1309 1310 1311
                        ))
          elif m.getDestinationValue() is None:
            # This is a consumption movement or an inventory movement
            current_inventory += inventory_quantity # Update inventory
            asset_price = current_asset_price
            result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1312
                          m.getQuantity(), 'Consumption or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1313
                        ))
1314
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and m.getDestinationValue().isAcquiredMemberOf(node_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1315 1316 1317 1318
            # This is an internal movement
            current_inventory += inventory_quantity # Update inventory
            asset_price = current_asset_price
            result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1319
                          m.getQuantity(), 'Internal', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1320
                        ))
1321
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and quantity < 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1322 1323 1324 1325
            # This is a physically inbound movement - try to use commercial price
            if m.getSourceSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1326
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1327
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1328
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1329 1330 1331 1332
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1333
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1334
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1335
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1336
                          ))
1337
            elif m.getDestinationSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1338
              current_inventory += inventory_quantity # Update inventory
1339
              if m.getDestinationValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1340 1341 1342 1343
                # Production
                asset_price = m.getIndustrialPrice()
                if asset_price is None: asset_price = current_asset_price  # Use current price if no price defined
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1344
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1345
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1346 1347 1348
              else:
                # Inbound from same section
                asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1349
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1350
                              m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1351
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1352
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1353 1354 1355
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1356
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1357
                          ))
1358
          elif m.getDestinationValue().isAcquiredMemberOf(node_category) and quantity > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1359 1360 1361 1362 1363 1364
            # This is a physically inbound movement - try to use commercial price
            if m.getSourceSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
              asset_price = current_asset_price
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1365
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1366 1367 1368 1369
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1370
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1371
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1372
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1373
                          ))
1374
            elif m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1375
              current_inventory += inventory_quantity # Update inventory
1376
              if m.getSourceValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1377 1378 1379 1380
                # Production
                asset_price = m.getIndustrialPrice()
                if asset_price is None: asset_price = current_asset_price  # Use current price if no price defined
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1381
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1382
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1383
              else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1384 1385 1386
                # Inbound from same section
                asset_price = current_asset_price
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1387
                            m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1388
                          ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1389
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1390 1391 1392
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1393
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1394 1395 1396 1397 1398 1399
                          ))
          else:
            # Outbound movement
            current_inventory += inventory_quantity # Update inventory
            asset_price = current_asset_price
            result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1400
                            m.getQuantity(), 'Outbound', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
                          ))

          # Update asset_price
          if current_inventory > 0:
            if inventory_quantity is not None:
              # Update price with an average of incoming goods and current goods
              current_asset_price = ( current_asset_price * previous_inventory + asset_price * inventory_quantity ) / float(current_inventory)
          else:
            # New price is the price of incoming goods - negative stock has no meaning for asset calculation
            current_asset_price = asset_price

          result.append(('###New Asset Price', current_asset_price, 'New Inventory', current_inventory))

          # Update Asset Price on the right side
1415
          if m.getSourceSectionValue() is not None and m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1416 1417
            # for each movement, source section is member of one and one only accounting category
            # therefore there is only one and one only source asset price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1418 1419 1420 1421 1422 1423 1424
            m._setSourceAssetPrice(current_asset_price)
            #quantity = m.getInventoriatedQuantity()
            #if quantity:
            #  #total_asset_price = - current_asset_price * quantity
            #  #m.Movement_zSetSourceTotalAssetPrice(uid=m.getUid(), total_asset_price = total_asset_price)
            #  m._setSourceAssetPrice(current_asset_price)
          if m.getDestinationSectionValue() is not None and m.getDestinationSectionValue().isMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1425 1426
            # for each movement, destination section is member of one and one only accounting category
            # therefore there is only one and one only destination asset price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1427 1428 1429 1430 1431
            m._setDestinationAssetPrice(current_asset_price)
            #quantity = m.getInventoriatedQuantity()
            #if quantity:
            #  total_asset_price = current_asset_price * quantity
            #  m.Movement_zSetDestinationTotalAssetPrice(uid=m.getUid(), total_asset_price = total_asset_price)
1432 1433 1434
          # Global reindexing required afterwards in any case: so let us do it now
          # Until we get faster methods (->reindexObject())
          #m.immediateReindexObject()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1435
          m.reindexObject()
1436
          #m.activate(priority=7).immediateReindexObject() # Too slow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1437 1438

      return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1439

1440 1441 1442
    # Used for mergeDeliveryList.
    class MergeDeliveryListError(Exception): pass

1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
    security.declareProtected( Permissions.ModifyPortalContent, 'mergeDeliveryList' )
    def mergeDeliveryList(self, delivery_list):
      """
        Merge multiple deliveries into one delivery.
        All delivery lines are merged into the first one.
        The first one is therefore called main_delivery here.
        The others are cancelled.
        Return the main delivery.
      """
      # Sanity checks.
      if len(delivery_list) == 0:
1454
        raise self.MergeDeliveryListError, "No delivery is passed"
1455
      elif len(delivery_list) == 1:
1456
        raise self.MergeDeliveryListError, "Only one delivery is passed"
1457 1458 1459 1460

      main_delivery = delivery_list[0]
      delivery_list = delivery_list[1:]

1461
      # Another sanity check. It is necessary for them to be identical in some attributes.
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
      for delivery in delivery_list:
        for attr in ('portal_type', 'simulation_state',
                     'source', 'destination',
                     'source_section', 'destination_section',
                     'source_decision', 'destination_decision',
                     'source_administration', 'destination_administration',
                     'source_payment', 'destination_payment'):
          main_value = main_delivery.getProperty(attr)
          value = delivery.getProperty(attr)
          if  main_value != value:
1472 1473 1474 1475
            raise self.MergeDeliveryListError, \
              "%s is not the same between %s and %s (%s and %s)" % (attr, delivery.getId(), main_delivery.getId(), value, main_value)

      # One more sanity check. Check if discounts are the same, if any.
1476
      main_discount_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1477
      for delivery in delivery_list:
1478
        discount_list = delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
        if len(main_discount_list) != len(discount_list):
          raise self.MergeDeliveryListError, "Discount is not the same between %s and %s" % (delivery.getId(), main_delivery.getId())
        for discount in discount_list:
          for main_discount in main_discount_list:
            if discount.getDiscount() == main_discount.getDiscount() \
               and discount.getDiscountRatio() == main_discount.getDiscountRatio() \
               and discount.getDiscountType() == main_discount.getDiscountType() \
               and discount.getImmediateDiscount() == main_discount.getImmediateDiscount():
              break
          else:
            raise self.MergeDeliveryListError, "Discount is not the same between %s and %s" % (delivery.getId(), main_delivery.getId())

      # One more sanity check. Check if payment conditions are the same, if any.
1492
      main_payment_condition_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1493
      for delivery in delivery_list:
1494
        payment_condition_list = delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
        if len(main_payment_condition_list) != len(payment_condition_list):
          raise self.MergeDeliveryListError, "Payment Condition is not the same between %s and %s" % (delivery.getId(), main_delivery.getId())
        for condition in payment_condition_list:
          for main_condition in main_payment_condition_list:
            if condition.getPaymentMode() == main_condition.getPaymentMode() \
               and condition.getPaymentAdditionalTerm() == main_condition.getPaymentAdditionalTerm() \
               and condition.getPaymentAmount() == main_condition.getPaymentAmount() \
               and condition.getPaymentEndOfMonth() == main_condition.getPaymentEndOfMonth() \
               and condition.getPaymentRatio() == main_condition.getPaymentRatio() \
               and condition.getPaymentTerm() == main_condition.getPaymentTerm():
              break
          else:
            raise self.MergeDeliveryListError, "Payment Condition is not the same between %s and %s" % (delivery.getId(), main_delivery.getId())
1508 1509 1510

      # Make sure that all activities are flushed, to get simulation movements from delivery cells.
      for delivery in delivery_list:
1511
        for order in delivery.getCausalityValueList(portal_type = self.getPortalOrderTypeList()):
1512 1513
          for applied_rule in order.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1514
        for causality_related_delivery in delivery.getCausalityValueList(portal_type = self.getPortalDeliveryTypeList()):
1515 1516
          for applied_rule in causality_related_delivery.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1517

1518 1519 1520 1521 1522
      # Get a list of simulated movements and invoice movements.
      main_simulated_movement_list = main_delivery.getSimulatedMovementList()
      main_invoice_movement_list = main_delivery.getInvoiceMovementList()
      simulated_movement_list = main_simulated_movement_list[:]
      invoice_movement_list = main_invoice_movement_list[:]
1523
      for delivery in delivery_list:
1524 1525 1526
        simulated_movement_list.extend(delivery.getSimulatedMovementList())
        invoice_movement_list.extend(delivery.getInvoiceMovementList())

1527 1528 1529 1530
      #for movement in simulated_movement_list + invoice_movement_list:
      #  parent = movement.aq_parent
      #  LOG('mergeDeliveryList', 0, 'movement = %s, parent = %s, movement.getPortalType() = %s, parent.getPortalType() = %s' % (repr(movement), repr(parent), repr(movement.getPortalType()), repr(parent.getPortalType())))

1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
      LOG('mergeDeliveryList', 0, 'simulated_movement_list = %s, invoice_movement_list = %s' % (str(simulated_movement_list), str(invoice_movement_list)))
      for main_movement_list, movement_list in \
        ((main_simulated_movement_list, simulated_movement_list),
         (main_invoice_movement_list, invoice_movement_list)):
        root_group = self.collectMovement(movement_list,
                                          check_order = 0,
                                          check_path = 0,
                                          check_date = 0,
                                          check_criterion = 1,
                                          check_resource = 1,
                                          check_base_variant = 1,
                                          check_variant = 1)
1543 1544 1545 1546 1547 1548 1549 1550 1551
        for criterion_group in root_group.group_list:
          LOG('mergeDeliveryList dump tree', 0, 'criterion = %s, movement_list = %s, group_list = %s' % (repr(criterion_group.criterion), repr(criterion_group.movement_list), repr(criterion_group.group_list)))
          for resource_group in criterion_group.group_list:
            LOG('mergeDeliveryList dump tree', 0, 'resource = %s, movement_list = %s, group_list = %s' % (repr(resource_group.resource), repr(resource_group.movement_list), repr(resource_group.group_list)))
            for base_variant_group in resource_group.group_list:
              LOG('mergeDeliveryList dump tree', 0, 'base_category_list = %s, movement_list = %s, group_list = %s' % (repr(base_variant_group.base_category_list), repr(base_variant_group.movement_list), repr(base_variant_group.group_list)))
              for variant_group in base_variant_group.group_list:
                LOG('mergeDeliveryList dump tree', 0, 'category_list = %s, movement_list = %s, group_list = %s' % (repr(variant_group.category_list), repr(variant_group.movement_list), repr(variant_group.group_list)))

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
        for criterion_group in root_group.group_list:
          for resource_group in criterion_group.group_list:
            for base_variant_group in resource_group.group_list:
              # Get a list of categories.
              category_dict = {}
              for variant_group in base_variant_group.group_list:
                for category in variant_group.category_list:
                  category_dict[category] = 1
              category_list = category_dict.keys()

              # Try to find a delivery line.
              delivery_line = None
              for movement in base_variant_group.movement_list:
                if movement in main_movement_list:
1566 1567
                  if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                    or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1568 1569 1570 1571 1572
                    delivery_line = movement.aq_parent
                  else:
                    delivery_line = movement
                  LOG('mergeDeliveryList', 0, 'delivery_line %s is found: criterion = %s, resource = %s, base_category_list = %s' % (repr(delivery_line), repr(criterion_group.criterion), repr(resource_group.resource), repr(base_variant_group.base_category_list)))
                  break
1573

1574 1575 1576
              if delivery_line is None:
                # Not found. So create a new delivery line.
                movement = base_variant_group.movement_list[0]
1577 1578
                if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                  or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1579
                  delivery_line_type = movement.aq_parent.getPortalType()
1580
                else:
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
                  delivery_line_type = movement.getPortalType()
                delivery_line = main_delivery.newContent(portal_type = delivery_line_type,
                                                         resource = resource_group.resource)
                LOG('mergeDeliveryList', 0, 'New delivery_line %s is created: criterion = %s, resource = %s, base_category_list = %s' % (repr(delivery_line), repr(criterion_group.criterion), repr(resource_group.resource), repr(base_variant_group.base_category_list)))

              # Update the base categories and categories.
              #LOG('mergeDeliveryList', 0, 'base_category_list = %s, category_list = %s' % (repr(base_category_list), repr(category_list)))
              delivery_line.setVariationBaseCategoryList(base_variant_group.base_category_list)
              delivery_line.setVariationCategoryList(category_list)

1591
              object_to_update = None
1592 1593 1594 1595 1596 1597
              for variant_group in base_variant_group.group_list:
                if len(variant_group.category_list) == 0:
                  object_to_update = delivery_line
                else:
                  for delivery_cell in delivery_line.contentValues():
                    predicate_value_list = delivery_cell.getPredicateValueList()
1598
                    LOG('mergeDeliveryList', 0, 'delivery_cell = %s, predicate_value_list = %s, variant_group.category_list = %s' % (repr(delivery_cell), repr(predicate_value_list), repr(variant_group.category_list)))
1599 1600 1601 1602 1603 1604 1605
                    if len(predicate_value_list) == len(variant_group.category_list):
                      for category in variant_group.category_list:
                        if category not in predicate_value_list:
                          break
                      else:
                        object_to_update = delivery_cell
                        break
1606

1607
                #LOG('mergeDeliveryList', 0, 'object_to_update = %s' % repr(object_to_update))
1608
                if object_to_update is not None:
1609
                  cell_price = object_to_update.getPrice() or 0.0
1610
                  cell_quantity = object_to_update.getQuantity() or 0.0
1611
                  cell_target_quantity = object_to_update.getNetConvertedTargetQuantity() or 0.0 # XXX What to do ?
1612
                  cell_total_price = cell_target_quantity * cell_price
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
                  cell_category_list = list(object_to_update.getCategoryList())

                  for movement in variant_group.movement_list:
                    if movement in main_movement_list:
                      continue
                    LOG('mergeDeliveryList', 0, 'movement = %s' % repr(movement))
                    cell_quantity += movement.getQuantity()
                    cell_target_quantity += movement.getNetConvertedTargetQuantity()
                    try:
                      # XXX WARNING - ADD PRICED QUANTITY
1623 1624
                      cell_price = movement.getPrice()
                      cell_total_price += movement.getNetConvertedTargetQuantity() * cell_price
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
                    except:
                      cell_total_price = None
                    for category in movement.getCategoryList():
                      if category not in cell_category_list:
                        cell_category_list.append(category)
                    # Make sure that simulation movements point to an appropriate delivery line or
                    # delivery cell.
                    if hasattr(movement, 'getDeliveryRelatedValueList'):
                      for simulation_movement in \
                        movement.getDeliveryRelatedValueList(portal_type = 'Simulation Movement'):
                        simulation_movement.setDeliveryValue(object_to_update)
                        #simulation_movement.reindexObject()
                    if hasattr(movement, 'getOrderRelatedValueList'):
                      for simulation_movement in \
                        movement.getOrderRelatedValueList(portal_type = 'Simulation Movement'):
                        simulation_movement.setOrderValue(object_to_update)
                        #simulation_movement.reindexObject()

                  if cell_target_quantity != 0 and cell_total_price is not None:
                    average_price = cell_total_price / cell_target_quantity
                  else:
                    average_price = 0

1648
                  LOG('mergeDeliveryList', 0, 'object_to_update = %s, cell_category_list = %s, cell_target_quantity = %s, cell_quantity = %s, average_price = %s' % (repr(object_to_update), repr(cell_category_list), repr(cell_target_quantity), repr(cell_quantity), repr(average_price)))
1649
                  object_to_update.setCategoryList(cell_category_list)
1650
                  if object_to_update.getPortalType() in self.getPortalSimulatedMovementTypeList():
1651 1652 1653 1654
                    object_to_update.edit(target_quantity = cell_target_quantity,
                                          quantity = cell_quantity,
                                          price = average_price,
                                          )
1655
                  elif object_to_update.getPortalType() in self.getPortalInvoiceMovementTypeList():
1656 1657 1658 1659 1660 1661 1662
                    # Invoices do not have target quantities, and the price never change.
                    object_to_update.edit(quantity = cell_quantity,
                                          price = cell_price,
                                          )
                  else:
                    raise self.MergeDeliveryListError, "Unknown portal type %s" % str(object_to_update.getPortalType())
                  #object_to_update.immediateReindexObject()
1663 1664 1665 1666 1667
                else:
                  raise self.MergeDeliveryListError, "No object to update"

      # Merge containers. Just copy them from other deliveries into the main.
      for delivery in delivery_list:
1668
        container_id_list = delivery.contentIds(filter = {'portal_type': self.getPortalContainerTypeList()})
1669 1670 1671
        if len(container_id_list) > 0:
          copy_data = delivery.manage_copyObjects(ids = container_id_list)
          new_id_list = main_delivery.manage_pasteObjects(copy_data)
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692

      # Unify the list of causality.
      causality_list = main_delivery.getCausalityValueList()
      for delivery in delivery_list:
        for causality in delivery.getCausalityValueList():
          if causality not in causality_list:
            causality_list.append(causality)
      LOG("mergeDeliveryList", 0, "causality_list = %s" % str(causality_list))
      main_delivery.setCausalityValueList(causality_list)

      # Cancel deliveries.
      for delivery in delivery_list:
        LOG("mergeDeliveryList", 0, "cancelling %s" % repr(delivery))
        delivery.cancel()

      # Reindex the main delivery.
      main_delivery.reindexObject()

      return main_delivery


1693
InitializeClass(SimulationTool)