SimulationTool.py 98.7 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002, 2005 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
5
#                    Romain Courteaud <romain@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

30
from Products.CMFCore.utils import getToolByName
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32 33 34

from AccessControl import ClassSecurityInfo
from Globals import InitializeClass, DTMLFile
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
from Products.ERP5 import DeliverySolver
from Products.ERP5 import TargetSolver
47
from Products.PythonScripts.Utility import allow_class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48

49
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery, QueryMixin
50

51
class SimulationTool(BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
    """
    The SimulationTool implements the ERP5
    simulation algorithmics.


    Examples of applications:

    -

    -
    ERP5 main purpose:

    -

    -

    """
    id = 'portal_simulation'
    meta_type = 'ERP5 Simulation Tool'
71
    portal_type = 'Simulation Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
72 73 74 75 76 77 78 79 80 81 82 83
    allowed_types = ( 'ERP5 Applied Rule', )

    # Declarative Security
    security = ClassSecurityInfo()

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

    def filtered_meta_types(self, user=None):
84 85 86 87 88 89 90
      # 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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91

92 93 94
    def tpValues(self) :
      """ show the content in the left pane of the ZMI """
      return self.objectValues()
95

96 97 98
    security.declarePrivate('manage_afterAdd')
    def manage_afterAdd(self, item, container) :
      """Init permissions right after creation.
99

100 101 102 103 104 105 106 107 108 109 110 111
      Permissions in simulation tool are simple:
       o Each member can access and create some content.
       o Only manager can view, because simulation can be seen as
         sensitive information.
      """
      item.manage_permission(Permissions.AddPortalContent,
            ['Member', 'Author', 'Manager'])
      item.manage_permission(Permissions.AccessContentsInformation,
            ['Member', 'Auditor', 'Manager'])
      item.manage_permission(Permissions.View,
            ['Manager',])
      BaseTool.inheritedAttribute('manage_afterAdd')(self, item, container)
112

113
    def solveDelivery(self, delivery, dsolver_name, tsolver_name,
114 115 116 117 118 119
                                     additional_parameters=None,**kw):
      """
        Solve a delivery by calling DeliverySolver and TargetSolver
      """
      self.solveMovementOrDelivery(delivery, dsolver_name, tsolver_name,
          delivery=1,additional_parameters=additional_parameters,**kw)
120 121

    def solveMovement(self, movement, dsolver_name, tsolver_name,
122 123 124 125
                                       additional_parameters=None,**kw):
      """
        Solve a movement by calling DeliverySolver and TargetSolver
      """
126
      return self.solveMovementOrDelivery(movement, dsolver_name, tsolver_name,
127
          movement=1,additional_parameters=additional_parameters,**kw)
128 129

    def solveMovementOrDelivery(self, obj, dsolver_name, tsolver_name,
130 131
                                          movement=0,delivery=0,
                                          additional_parameters=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
132
      """
133
        Solve a delivery by calling DeliverySolver and TargetSolver
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134
      """
135 136 137 138 139 140 141 142 143
      for solver_name, solver_module in [(dsolver_name, DeliverySolver),\
                                         (tsolver_name, TargetSolver)]:

        if solver_name is not None:
          solver_file_path = "%s.%s" % (solver_module.__name__,
                                        solver_name)
          __import__(solver_file_path)
          solver_file = getattr(solver_module, solver_name)
          solver_class = getattr(solver_file, solver_name)
144
          solver = solver_class(additional_parameters=additional_parameters,**kw)
145

146
          if movement:
147
            return solver.solveMovement(obj)
148
          if delivery:
149
            return solver.solveDelivery(obj)
150

Jean-Paul Smets's avatar
Jean-Paul Smets committed
151 152
    #######################################################
    # Stock Management
153

154
    def _generatePropertyUidList(self, prop, as_text=0):
155 156 157 158 159 160 161
      """
      converts relative_url or text (single element or list or dict)
        to an object usable by buildSQLQuery

      as_text == 0: tries to lookup an uid from the relative_url
      as_text == 1: directly passes the argument as text
      """
162
      if prop is None :
163 164
        return []
      category_tool = getToolByName(self, 'portal_categories')
165
      property_uid_list = []
166
      if isinstance(prop, str):
167
        if not as_text:
168
          prop_value = category_tool.getCategoryValue(prop)
169
          if prop_value is None:
170
            raise ValueError, 'Category %s does not exists' % prop
171
          property_uid_list.append(prop_value.getUid())
172
        else:
173 174 175
          property_uid_list.append(prop)
      elif isinstance(prop, (list, tuple)):
        for property_item in prop :
176
          if not as_text:
177 178 179 180
            prop_value = category_tool.getCategoryValue(property_item)
            if prop_value is None:
              raise ValueError, 'Category %s does not exists' % property_item
            property_uid_list.append(prop_value.getUid())
181 182
          else:
            property_uid_list.append(property_item)
183
      elif isinstance(prop, dict):
184
        tmp_uid_list = []
185 186 187
        if isinstance(prop['query'], str):
          prop['query'] = [prop['query']]
        for property_item in prop['query'] :
188
          if not as_text:
189 190 191 192
            prop_value = category_tool.getCategoryValue(property_item)
            if prop_value is None:
              raise ValueError, 'Category %s does not exists' % property_item
            tmp_uid_list.append(prop_value.getUid())
193 194
          else:
            tmp_uid_list.append(property_item)
195
        if tmp_uid_list:
196
          property_uid_list = {}
197
          property_uid_list['operator'] = prop['operator']
198 199 200
          property_uid_list['query'] = tmp_uid_list
      return property_uid_list

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    def _getSimulationStateQuery(self, **kw):
      simulation_state_dict = self._getSimulationStateDict(**kw)
      return self._buildSimulationStateQuery(simulation_state_dict)
      
    def _buildSimulationStateQuery(self, simulation_state_dict):
      input_simulation_state = simulation_state_dict.get(
                                 'input_simulation_state')
      output_simulation_state = simulation_state_dict.get(
                                 'output_simulation_state')
      simulation_state = simulation_state_dict.get('simulation_state')
      if simulation_state is not None:
        simulation_query = Query(operator='IN',
                                 **{'stock.simulation_state':
                                    simulation_state})
      elif input_simulation_state is not None:
        input_quantity_query = Query(**{'stock.quantity': '>0'})
        input_simulation_query = Query(operator='IN',
                                       **{'stock.simulation_state':
                                          input_simulation_state})
        simulation_query = ComplexQuery(input_quantity_query,
                                        input_simulation_query,
                                        operator='AND')
        if output_simulation_state is not None:
          output_quantity_query = Query(**{'stock.quantity': '<0'})
          output_simulation_query = Query(operator='IN',
                                          **{'stock.simulation_state':
                                             output_simulation_state})
          output_query = ComplexQuery(output_quantity_query,
                                      output_simulation_query,
                                      operator='AND')
          simulation_query = ComplexQuery(simulation_query, output_query,
                                          operator='OR')
      else:
        simulation_query = '1'
      return simulation_query

    def _getSimulationStateDict(self, simulation_state=None, omit_transit=0,
238 239 240 241 242 243 244 245 246 247 248 249
                                input_simulation_state=None,
                                output_simulation_state=None,
                                transit_simulation_state=None,
                                strict_simulation_state=None):
      """
      This method is used in order to give what should be
      the input_simulation_state or output_simulation_state
      depending on many parameters
      """
      string_or_list = (str, list, tuple)
      # Simulation States
      # If strict_simulation_state is set, we directly put it into the dictionary
250
      simulation_dict = {}
251 252 253
      if strict_simulation_state:
        if isinstance(simulation_state, string_or_list)\
                and simulation_state:
254 255
           simulation_query = Query(
                   **{'stock.simulation_state': simulation_state})
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
      else:
        # first, we evaluate simulation_state
        sql_kw = {}
        if simulation_state and isinstance(simulation_state, string_or_list):
          if isinstance(simulation_state, str):
            sql_kw['input_simulation_state'] = [simulation_state]
            sql_kw['output_simulation_state'] = [simulation_state]
          else:
            sql_kw['input_simulation_state'] = simulation_state
            sql_kw['output_simulation_state'] = simulation_state
        # then, if omit_transit == 1, we evaluate (simulation_state -
        # transit_simulation_state) for input_simulation_state
        if omit_transit:
          if isinstance(simulation_state, string_or_list)\
                and simulation_state:
            if isinstance(transit_simulation_state, string_or_list)\
                  and transit_simulation_state:
              # when we know both are usable, we try to calculate
              # (simulation_state - transit_simulation_state)
              if isinstance(simulation_state, str):
                simulation_state = [simulation_state]
              if isinstance(transit_simulation_state, str) :
                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)
              sql_kw['input_simulation_state'] = delivered_simulation_state_list

        # alternatively, the user can directly define input_simulation_state
        # and output_simulation_state
        if input_simulation_state and isinstance(input_simulation_state,
                                                  string_or_list):
          if isinstance(input_simulation_state, str):
            input_simulation_state = [input_simulation_state]
          sql_kw['input_simulation_state'] = input_simulation_state
        if output_simulation_state and isinstance(output_simulation_state,
                                                  string_or_list):
          if isinstance(output_simulation_state, str):
            output_simulation_state = [output_simulation_state]
          sql_kw['output_simulation_state'] = output_simulation_state
        # XXX In this case, we must not set sql_kw[input_simumlation_state] before
        input_simulation_state = None
        output_simulation_state = None
        if sql_kw.has_key('input_simulation_state'):
          input_simulation_state = sql_kw.get('input_simulation_state')
        if sql_kw.has_key('output_simulation_state'):
          output_simulation_state = sql_kw.get('output_simulation_state')
        if input_simulation_state is not None \
           or output_simulation_state is not None:
          sql_kw.pop('input_simulation_state',None)
          sql_kw.pop('output_simulation_state',None)
        if input_simulation_state is not None:
          if output_simulation_state is not None:
            if input_simulation_state == output_simulation_state:
311
              simulation_dict['simulation_state'] = input_simulation_state
312
            else:
313 314
              simulation_dict['input_simulation_state'] = input_simulation_state
              simulation_dict['output_simulation_state'] = output_simulation_state
315
          else:
316
            simulation_dict['input_simulation_state'] = input_simulation_state
317
        elif output_simulation_state is not None:
318 319
          simulation_dict['simulation_state'] = output_simulation_state
      return simulation_dict
320 321 322 323 324 325 326 327 328 329

    def _getOmitQuery(self, query_table=None, omit_input=0, omit_output=0, **kw):
      """
      Build a specific query in order to take:
      - negatives quantity values if omit_input
      - postives quantity values if omit_output
      """
      omit_query = None
      if omit_input or omit_output:
        # Make sure to check some conditions
330 331 332 333 334 335 336
        condition_expression = \
          "%(query_table)s.node_uid <> %(query_table)s.mirror_node_uid \
         OR %(query_table)s.section_uid <> %(query_table)s.mirror_section_uid \
         OR %(query_table)s.mirror_node_uid IS NULL \
         OR %(query_table)s.mirror_section_uid IS NULL \
         OR %(query_table)s.payment_uid IS NOT NULL \
           " % {'query_table': query_table}
337
        if omit_input:
338
          quantity_query = Query(**{'%s.quantity' % query_table: '<0'})
339 340 341
          omit_query = ComplexQuery(quantity_query, condition_expression,
                                    operator='AND')
        if omit_output:
342
          quantity_query = Query(**{'%s.quantity' % query_table: '>0'})
343 344 345 346 347 348 349 350 351 352
          if omit_query is None:
            omit_query = ComplexQuery(quantity_query, condition_expression,
                                      operator='AND')
          else:
            output_query = ComplexQuery(quantity_query, condition_expression,
                                        operator='AND')
            omit_query = ComplexQuery(omit_query, output_query, operator='AND')

      return omit_query

353
    def _generateSQLKeywordDict(self, table='stock',
354
        # dates
355
        from_date=None, to_date=None, at_date=None,
356
        omit_mirror_date=1,
357
        # instances
Alexandre Boeglin's avatar
Alexandre Boeglin committed
358
        resource=None, node=None, payment=None,
359 360 361 362
        section=None, mirror_section=None, item=None,
        # used for tracking
        input=0, output=0,
        # categories
Alexandre Boeglin's avatar
Alexandre Boeglin committed
363
        resource_category=None, node_category=None, payment_category=None,
364
        section_category=None, mirror_section_category=None,
365 366 367 368 369 370 371
        # categories with strict membership
        resource_category_strict_membership=None,
        node_category_strict_membership=None,
        payment_category_strict_membership=None,
        section_category_strict_membership=None,
        mirror_section_category_strict_membership=None,
        # simulation_state
372
        strict_simulation_state=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
373
        simulation_state=None, transit_simulation_state = None, omit_transit=0,
374
        input_simulation_state=None, output_simulation_state=None,
375
        reserved_kw=None,
376
        # variations
377
        variation_text=None, sub_variation_text=None,
378 379 380
        variation_category=None,
        # uids
        resource_uid=None, node_uid=None, section_uid=None,
381 382 383 384 385 386 387 388 389 390 391 392 393
        # omit input and output
        omit_input=0,
        omit_output=0,
        # group by
        group_by_node=0,
        group_by_mirror_node=0,
        group_by_section=0,
        group_by_mirror_section=0,
        group_by_payment=0,
        group_by_sub_variation=0,
        group_by_variation=0,
        group_by_movement=0,
        group_by_resource=1,
394 395
        # keywords for related keys
        **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
396
      """
397 398 399 400
      Generates keywords and calls buildSQLQuery

      - omit_mirror_date: normally, date's parameters are only based on date
        column. If 0, it also used the mirror_date column.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
401 402 403 404 405
      """
      new_kw = {}
      new_kw.update(kw)
      sql_kw = {}

406 407 408 409
      # input and output are used by getTrackingList
      sql_kw['input'] = input
      sql_kw['output'] = output

410 411 412 413 414 415 416 417 418 419 420 421 422 423
      query_list = []

      if omit_mirror_date:
        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 at_date :
            date_dict['query'].append(at_date)
            date_dict['range'] = 'minngt'
        elif to_date :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
424
          date_dict['query'].append(to_date)
425
          date_dict['range'] = 'max'
426 427
        elif at_date :
          date_dict['query'].append(at_date)
428 429 430 431 432 433 434 435 436 437 438
          date_dict['range'] = 'ngt'
        if len(date_dict) :
          new_kw[table + '.date'] = date_dict
      else:
        date_query_list = []
        query_list.append(ComplexQuery(
          Query(range='ngt', 
                **{'%s.date' % table: [to_date]}),
          Query(range='nlt', 
                **{'%s.mirror_date' % table: [from_date]}),
          operator='AND'))
439

440
      # Some columns exists on multiple tables, we have to clear ambiguities
441 442 443 444
      if resource_uid is not None :
        new_kw[table + '.resource_uid'] = resource_uid
      if section_uid is not None :
        new_kw[table + '.section_uid'] = section_uid
445
        sql_kw['section_filtered'] = 1
446 447
      if node_uid is not None :
        new_kw[table + '.node_uid'] = node_uid
448

449
      resource_uid_list = self._generatePropertyUidList(resource)
450
      if resource_uid_list:
451
        new_kw[table + '.resource_uid'] = resource_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
452

453
      item_uid_list = self._generatePropertyUidList(item)
454
      if item_uid_list:
455
        new_kw[table + '.aggregate_uid'] = item_uid_list
456

457
      node_uid_list = self._generatePropertyUidList(node)
458
      if node_uid_list:
459
        new_kw[table + '.node_uid'] = node_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
460

461
      payment_uid_list = self._generatePropertyUidList(payment)
462
      if payment_uid_list:
463
        new_kw[table + '.payment_uid'] = payment_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
464

465
      section_uid_list = self._generatePropertyUidList(section)
466
      if section_uid_list:
467
        new_kw[table + '.section_uid'] = section_uid_list
468
        sql_kw['section_filtered'] = 1
Alexandre Boeglin's avatar
Alexandre Boeglin committed
469

470
      mirror_section_uid_list = self._generatePropertyUidList(mirror_section)
471
      if mirror_section_uid_list:
472
        new_kw[table + '.mirror_section_uid'] = mirror_section_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
473

474 475
      variation_text_list = self._generatePropertyUidList(variation_text,
                                                          as_text=1)
476
      if variation_text_list:
477
        new_kw[table + '.variation_text'] = variation_text_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
478

479 480
      sub_variation_text_list = self._generatePropertyUidList(
                                              sub_variation_text, as_text=1)
481
      if sub_variation_text_list:
482 483
        new_kw[table + '.sub_variation_text'] = sub_variation_text_list

484 485 486
      # category membership
      resource_category_uid_list = self._generatePropertyUidList(
                                              resource_category)
487
      if resource_category_uid_list:
488
        new_kw[table + '_resource_category_uid'] = resource_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
489

490
      node_category_uid_list = self._generatePropertyUidList(node_category)
491
      if node_category_uid_list:
492
        new_kw[table + '_node_category_uid'] = node_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
493

494
      payment_category_uid_list = self._generatePropertyUidList(payment_category)
495
      if payment_category_uid_list:
496
        new_kw[table + '_payment_category_uid'] = payment_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
497

498
      section_category_uid_list = self._generatePropertyUidList(section_category)
499
      if section_category_uid_list:
500
        new_kw[table + '_section_category_uid'] = section_category_uid_list
501
        sql_kw['section_filtered'] = 1
Alexandre Boeglin's avatar
Alexandre Boeglin committed
502

503 504
      mirror_section_category_uid_list = self._generatePropertyUidList(
                                              mirror_section_category)
505
      if mirror_section_category_uid_list:
506 507 508 509 510 511
        new_kw[table + '_mirror_section_category_uid'] =\
                                              mirror_section_category_uid_list

      # category strict membership
      resource_category_strict_membership_uid_list =\
            self._generatePropertyUidList(resource_category_strict_membership)
512
      if resource_category_strict_membership_uid_list:
513 514 515 516 517
        new_kw[table + '_resource_category_strict_membership_uid'] =\
            resource_category_strict_membership_uid_list

      node_category_strict_membership_uid_list =\
            self._generatePropertyUidList(node_category_strict_membership)
518
      if node_category_strict_membership_uid_list:
519 520 521 522 523
        new_kw[table + '_node_category_strict_membership_uid'] =\
            node_category_strict_membership_uid_list

      payment_category_strict_membership_uid_list =\
            self._generatePropertyUidList(payment_category_strict_membership)
524
      if payment_category_strict_membership_uid_list:
525 526 527 528 529
        new_kw[table + '_payment_category_strict_membership_uid'] =\
            payment_category_strict_membership_uid_list

      section_category_strict_membership_uid_list =\
            self._generatePropertyUidList(section_category_strict_membership)
530
      if section_category_strict_membership_uid_list:
531 532
        new_kw[table + '_section_category_strict_membership_uid'] =\
            section_category_strict_membership_uid_list
533
        sql_kw['section_filtered'] = 1
534 535 536 537

      mirror_section_category_strict_membership_uid_list =\
            self._generatePropertyUidList(
                                  mirror_section_category_strict_membership)
538
      if mirror_section_category_strict_membership_uid_list:
539 540
        new_kw[table + '_mirror_section_category_strict_membership_uid'] =\
            mirror_section_category_strict_membership_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
541

542 543 544
      #variation_category_uid_list = self._generatePropertyUidList(variation_category)
      #if len(variation_category_uid_list) :
      #  new_kw['variationCategory'] = variation_category_uid_list
545
      
546 547
      simulation_query =  self._getSimulationStateQuery(
                                simulation_state=simulation_state, 
548 549 550 551 552 553 554 555 556 557 558 559 560 561
                                omit_transit=omit_transit,
                                input_simulation_state=input_simulation_state,
                                output_simulation_state=output_simulation_state,
                                transit_simulation_state=transit_simulation_state,
                                strict_simulation_state=strict_simulation_state)
      if omit_input or omit_output:
        omit_query = self._getOmitQuery(omit_input=omit_input,
                                        omit_output=omit_output,
                                        query_table=table)
        if simulation_query is not None:
          simulation_query = ComplexQuery(simulation_query, omit_query, operator='AND')
        else:
          simulation_query = omit_query
      if reserved_kw is not None:
562
        if not isinstance(reserved_kw, dict):
563 564 565
          # Not a dict when taken from URL, so, cast is needed 
          # to make pop method available
          reserved_kw = dict(reserved_kw)
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
        reserved_omit_input = reserved_kw.pop('omit_input',0)
        reserved_omit_output = reserved_kw.pop('omit_output',0)
        reserved_omit_query = self._getOmitQuery(query_table=table,
                                                 omit_input=reserved_omit_input,
                                                 omit_output=reserved_omit_output)
        reserved_query = self._getSimulationStateQuery(**reserved_kw)
        if reserved_omit_query is not None:
          reserved_query = ComplexQuery(reserved_omit_query,reserved_query,
                                        operator='AND')
        if simulation_query is not None:
          simulation_query = ComplexQuery(simulation_query, reserved_query,
                                          operator='OR')
        else:
          simulation_query = reserved_query
      if simulation_query is not None:
581
        query_list.append(simulation_query)
582

583 584
      if query_list:
        new_kw['query'] = ComplexQuery(*query_list)
585

Alexandre Boeglin's avatar
Alexandre Boeglin committed
586

587 588 589 590 591 592 593
      # It is necessary to use here another SQL query (or at least a subquery)
      # to get _DISTINCT_ uid from predicate_category table.
      # Otherwise, by using a where_expression, cells which fit conditions
      # more than one time are counted more than one time, and the resulting
      # inventory is false
      # XXX Perhaps is there a better solution
      add_kw = {}
594
      if variation_category is not None and variation_category:
595 596
        where_expression = self.getPortalObject().portal_categories\
          .buildSQLSelector(
597 598 599 600 601 602 603 604 605 606
            category_list = variation_category,
            query_table = 'predicate_category')
        if where_expression != '':
          add_kw['where_expression'] = where_expression
          add_kw['predicate_category.uid'] = '!=NULL'
          add_kw['group_by_expression'] = 'uid'
          add_query = self.portal_catalog(**add_kw)
          uid_list = []
          for line in add_query:
            uid_list.append(line.uid)
607 608
          new_kw['where_expression'] = '( %s )' % ' OR '.join(
                      ['catalog.uid=%s' % uid for uid in uid_list])
Alexandre Boeglin's avatar
Alexandre Boeglin committed
609

Sebastien Robin's avatar
Sebastien Robin committed
610 611
      # build the group by expression
      group_by_expression_list = []
612
      if group_by_node:
613
        group_by_expression_list.append('%s.node_uid' % table)
614
      if group_by_mirror_node:
615
        group_by_expression_list.append('%s.mirror_node_uid' % table)
616
      if group_by_section:
617
        group_by_expression_list.append('%s.section_uid' % table)
618
      if group_by_mirror_section:
619
        group_by_expression_list.append('%s.mirror_section_uid' % table)
620
      if group_by_payment:
621
        group_by_expression_list.append('%s.payment_uid' % table)
622
      if group_by_sub_variation:
623
        group_by_expression_list.append('%s.sub_variation_text' % table)
624
      if group_by_variation:
625
        group_by_expression_list.append('%s.variation_text' % table)
626 627
      if group_by_movement:
        group_by_expression_list.append('%s.uid' % table)
628 629
      if group_by_expression_list:
        # by default, we group by resource
630
        if group_by_resource:
631
          group_by_expression_list.append('%s.resource_uid' % table)
632
        new_kw['group_by_expression'] = ', '.join(group_by_expression_list)
633
      
634
      sql_kw.update(self.portal_catalog.buildSQLQuery(**new_kw))
635 636
      return sql_kw

Jean-Paul Smets's avatar
Jean-Paul Smets committed
637
    #######################################################
638 639
    # Inventory management
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
640
                              'getInventory')
641
    def getInventory(self, src__=0, simulation_period='', **kw):
642
      """
643 644
      Returns an inventory of a single or multiple resources on a single or
      multiple nodes as a single float value
645

646
      from_date (>=) - only take rows which date is >= from_date
647

648
      to_date   (<)  - only take rows which date is < to_date
649 650 651 652 653

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

      resource (only in generic API in simulation)

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

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

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

663 664
      mirror_section -  only take rows in stock table which mirror_section_uid is
                        mirror_section
665

666 667
      resource_category  -  only take rows in stock table which
                        resource_uid is member of resource_category
668

669 670
      node_category   - only take rows in stock table which node_uid is
                        member of section_category
671

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

675
      section_category -  only take rows in stock table which section_uid is
676 677 678 679 680 681 682 683 684 685 686
                          member of section_category

      mirror_section_category - only take rows in stock table which 
                                mirror_section_uid is member of
				mirror_section_category

      node_filter     - only take rows in stock table which node_uid
                        matches node_filter

      payment_filter  - only take rows in stock table which payment_uid
                        matches payment_filter
687

688 689 690
      section_filter  - only take rows in stock table which section_uid
                        matches section_filter

691 692
      mirror_section_filter - only take rows in stock table which
                              mirror_section_uid matches mirror_section_filter
693

694 695 696 697 698 699
      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
700

701 702
      sub_variation_text - only take rows in stock table with specified
                        variation_text
703

704 705
      variation_category - variation or list of possible variations (it is not
                        a cross-search ; SQL query uses OR)
706 707 708

      simulation_state - only take rows with specified simulation_state

709
      transit_simulation_state - specifies which states are transit states
710

711
      omit_transit   -  do not evaluate transit_simulation_state
712

713 714
      input_simulation_state - only take rows with specified simulation_state
                        and quantity > 0
715

716 717
      output_simulation_state - only take rows with specified simulation_state
                        and quantity < 0
718

719 720 721
      ignore_variation -  do not take into account variation in inventory
                        calculation (useless on getInventory, but useful on
                        getInventoryList)
722

723 724
      standardise    -  provide a standard quantity rather than an SKU (XXX
                        not implemented yet)
725

726 727
      omit_simulation - doesn't take into account simulation movements

728
      omit_input     -  doesn't take into account movement with quantity < 0
729

730
      omit_output    -  doesn't take into account movement with quantity > 0
731 732 733

      selection_domain, selection_report - see ListBox

734 735
      group_by_variation - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
736

737 738
      group_by_node  -  (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
739

740 741
      group_by_mirror_node - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
742

743 744
      group_by_sub_variation - (useless on getInventory, but useful on
                        getInventoryList)
745

746 747 748
      group_by_movement - (useless on getInventory, but useful on
                        getInventoryList)

749 750
      precision - the precision used to round quantities and prices.

751 752
      **kw           -  if we want extended selection with more keywords (but
                        bad performance) check what we can do with
753
                        buildSQLQuery
754

755 756
      NOTE: we may want to define a parameter so that we can select the kind of
      inventory statistics we want to display (ex. sum, average, cost, etc.)
757
      """
758 759 760 761 762 763 764 765
      # JPS: this is a hint for implementation of xxx_filter arguments
      # node_uid_count = portal_catalog.countResults(**node_filter)
      # if node_uid_count not too big:
      #   node_uid_list = cache(portal_catalog(**node_filter))
      #   pass this list to ZSQL method
      # else:
      #   build a table in MySQL
      #   and join that table with the stock table
766 767
      method = getattr(self,'get%sInventoryList' % simulation_period)
      result = method(inventory_list=0, ignore_group_by=1, src__=src__, **kw)
768
      if src__:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
769 770
        return result

771 772
      total_result = 0.0
      if len(result) > 0:
773 774
        if len(result) != 1:
          raise ValueError, 'Sorry we must have only one'
775
        inventory = result[0].total_quantity
776 777
        if inventory is not None:
          total_result = inventory
778 779

      return total_result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
780

781
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
782
                              'getCurrentInventory')
783
    def getCurrentInventory(self, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
784 785 786
      """
      Returns current inventory
      """
787
      return self.getInventory(simulation_period='Current', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
788

789
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
790
                              'getAvailableInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
791 792 793
    def getAvailableInventory(self, **kw):
      """
      Returns available inventory
794
      (current inventory - reserved_inventory)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
795
      """
796
      return self.getInventory(simulation_period='Available', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
797

798
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
799
                              'getFutureInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
800 801 802 803
    def getFutureInventory(self, **kw):
      """
      Returns future inventory
      """
804
      return self.getInventory(simulation_period='Future', **kw)
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
    
    def _getDefaultGroupByParameters(self, ignore_group_by=0, **kw):
      """
      Set defaults group_by parameters
      """
      if not (ignore_group_by \
         or kw.get('group_by_node', 0) or kw.get('group_by_mirror_node', 0) \
         or kw.get('group_by_section', 0) or kw.get('group_by_mirror_section', 0) \
         or kw.get('group_by_payment', 0) or kw.get('group_by_sub_variation', 0) \
         or kw.get('group_by_variation', 0) or kw.get('group_by_movement', 0) \
         or kw.get('group_by_resource', 0)):
        kw['group_by_movement'] = 1
        kw['group_by_node'] = 1
        kw['group_by_resource'] = 1
      return kw
Alexandre Boeglin's avatar
Alexandre Boeglin committed
820

821
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
822
                              'getInventoryList')
823
    def getInventoryList(self, src__=0, ignore_variation=0, standardise=0,
824
                         omit_simulation=0, 
825
                         selection_domain=None, selection_report=None,
826
                         statistic=0, inventory_list=1, 
827
                         precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
828
      """
829 830 831
        Returns a list of inventories for a single or multiple
        resources on a single or multiple nodes, grouped by resource,
        node, section, etc. Every line defines an inventory value for
Romain Courteaud's avatar
Romain Courteaud committed
832
        a given group of resource, node, section.
833 834
        NOTE: we may want to define a parameter so that we can select
        the kind of inventory statistics we want to display (ex. sum,
Romain Courteaud's avatar
Romain Courteaud committed
835
        average, cost, etc.)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
836
      """
837
      kw = self._getDefaultGroupByParameters(**kw)
838
      # If no group at all, give a default sort group by
839
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
840
      return self.Resource_zGetInventoryList(
841
                    src__=src__, ignore_variation=ignore_variation,
842
                    standardise=standardise, omit_simulation=omit_simulation,
843
                    selection_domain=selection_domain,
844
                    selection_report=selection_report, precision=precision,
845 846
                    inventory_list=inventory_list, 
                    statistic=statistic, **sql_kw)
Romain Courteaud's avatar
Romain Courteaud committed
847

848
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
849
                              'getCurrentInventoryList')
850 851
    def getCurrentInventoryList(self, omit_transit=1, 
                                transit_simulation_state=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
852
      """
Romain Courteaud's avatar
Romain Courteaud committed
853
        Returns list of current inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
854
      """
855 856 857 858 859 860 861 862 863
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList() + \
                               self.getPortalTransitInventoryStateList()
      if transit_simulation_state is None:
        transit_simulation_state = self.getPortalTransitInventoryStateList()

      return self.getInventoryList(
                            omit_transit=omit_transit,
                            transit_simulation_state=transit_simulation_state,
                            **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
864

865
    security.declareProtected(Permissions.AccessContentsInformation,
866
                              'getAvailableInventoryList')
867
    def getAvailableInventoryList(self, omit_transit=1, transit_simulation_state=None, **kw):
868 869 870
      """
        Returns list of current inventory grouped by section or site
      """
871 872 873 874 875 876 877 878 879
      if transit_simulation_state is None:
        transit_simulation_state = self.getPortalTransitInventoryStateList()
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList() + \
                               self.getPortalTransitInventoryStateList()
      reserved_kw = {'simulation_state': self.getPortalReservedInventoryStateList(),
                     'transit_simulation_state': transit_simulation_state,
                     'omit_input': 1}
      return self.getInventoryList(reserved_kw=reserved_kw, omit_transit=omit_transit,
                     transit_simulation_state=transit_simulation_state, **kw)
880 881

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
882
                              'getFutureInventoryList')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
883 884
    def getFutureInventoryList(self, **kw):
      """
Romain Courteaud's avatar
Romain Courteaud committed
885
        Returns list of future inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
886
      """
Romain Courteaud's avatar
Romain Courteaud committed
887
      kw['simulation_state'] = tuple(
Romain Courteaud's avatar
Romain Courteaud committed
888
                 list(self.getPortalFutureInventoryStateList()) + \
889
                 list(self.getPortalTransitInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
890
                 list(self.getPortalReservedInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
891
                 list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
892 893
      return self.getInventoryList(**kw)

894
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
895
                              'getInventoryStat')
896
    def getInventoryStat(self, simulation_period='', **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
897
      """
898
      getInventoryStat is the pending to getInventoryList in order to
Romain Courteaud's avatar
Romain Courteaud committed
899
      provide statistics on getInventoryList lines in ListBox such as:
900
      total of inventories, number of variations, number of different
Romain Courteaud's avatar
Romain Courteaud committed
901
      nodes, etc.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
902
      """
Romain Courteaud's avatar
Romain Courteaud committed
903
      kw['group_by_variation'] = 0
904
      method = getattr(self,'get%sInventoryList' % simulation_period)
905
      return method(statistic=1, inventory_list=0, 
906
                                   ignore_group_by=1, **kw)
907 908

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
909
                              'getCurrentInventoryStat')
910
    def getCurrentInventoryStat(self, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
911 912 913
      """
      Returns statistics of current inventory grouped by section or site
      """
914
      return self.getInventoryStat(simulation_period='Current', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
915

916
    security.declareProtected(Permissions.AccessContentsInformation,
917 918 919 920 921
                              'getAvailableInventoryStat')
    def getAvailableInventoryStat(self, **kw):
      """
      Returns statistics of current inventory grouped by section or site
      """
922
      return self.getInventoryStat(simulation_period='Available', **kw)
923 924

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
925
                              'getFutureInventoryStat')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
926 927 928 929
    def getFutureInventoryStat(self, **kw):
      """
      Returns statistics of future inventory grouped by section or site
      """
930
      return self.getInventoryStat(simulation_period='Future', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
931

932
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
933
                              'getInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
934
    def getInventoryChart(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
935
      """
936 937
      Returns a list of couples derived from getInventoryList in order
      to feed a chart renderer. Each couple consist of a label
938
      (node, section, payment, combination of node & section, etc.)
Romain Courteaud's avatar
Romain Courteaud committed
939
      and an inventory value.
940

941
      Mostly useful for charts in ERP5 forms.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
942
      """
Alexandre Boeglin's avatar
Alexandre Boeglin committed
943
      result = self.getInventoryList(src__=src__, **kw)
944
      if src__ :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
945
        return result
946

947
      return map(lambda r: (r.node_title, r.total_quantity), result)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
948

949
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
950
                              'getCurrentInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
951 952 953 954
    def getCurrentInventoryChart(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
955
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
956 957
      return self.getInventoryChart(**kw)

958
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
959
                              'getFutureInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
960 961 962 963
    def getFutureInventoryChart(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
964 965 966 967
      kw['simulation_state'] = tuple(
                      list(self.getPortalFutureInventoryStateList()) + \
                      list(self.getPortalReservedInventoryStateList()) + \
                      list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
968 969
      return self.getInventoryChart(**kw)

970
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
971
                              'getInventoryAssetPrice')
972 973
    def getInventoryAssetPrice(self, src__=0, 
                               simulation_period='', **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
974
      """
975
      Same thing as getInventory but returns an asset
976
      price rather than an inventory.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
977
      """
978 979
      method = getattr(self,'get%sInventoryList' % simulation_period)
      result = method( src__=src__, inventory_list=0, ignore_group_by=1, **kw)
980 981
      if src__ :
        return result
982

983 984 985
      total_result = 0.0
      if len(result) > 0:
        for result_line in result:
986
          if result_line.total_price is not None:
987
            total_result += result_line.total_price
988

989
      return total_result
Alexandre Boeglin's avatar
Alexandre Boeglin committed
990

991
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
992
                              'getCurrentInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
993 994 995 996
    def getCurrentInventoryAssetPrice(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
997
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
998
      return self.getInventoryAssetPrice(simulation_period='Current',**kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
999

1000
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1001
                              'getAvailableInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1002 1003 1004 1005 1006
    def getAvailableInventoryAssetPrice(self, **kw):
      """
      Returns list of available inventory grouped by section or site
      (current inventory - deliverable)
      """
1007 1008 1009
      kw['simulation_state'] = tuple(
                    list(self.getPortalReservedInventoryStateList()) + \
                    list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1010 1011
      return self.getInventoryAssetPrice(**kw)

1012
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1013
                              'getFutureInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1014 1015 1016 1017
    def getFutureInventoryAssetPrice(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
1018 1019 1020 1021
      kw['simulation_state'] = tuple(
               list(self.getPortalFutureInventoryStateList()) + \
               list(self.getPortalReservedInventoryStateList()) + \
               list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1022 1023
      return self.getInventoryAssetPrice(**kw)

1024
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1025
                              'getInventoryHistoryList')
1026
    def getInventoryHistoryList(self, src__=0, ignore_variation=0,
1027
                                standardise=0, omit_simulation=0, omit_input=0,
1028
                                omit_output=0, selection_domain=None,
1029
                                selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1030
      """
1031 1032 1033
      Returns a time based serie of inventory values
      for a single or a group of resource, node, section, etc. This is useful
      to list the evolution with time of inventory values (quantity, asset price).
1034 1035 1036 1037

      TODO:
        - make sure getInventoryHistoryList can return
	  cumulative values calculated by SQL (JPS)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1038
      """
1039
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
1040
      return self.Resource_getInventoryHistoryList(
1041
                      src__=src__, ignore_variation=ignore_variation,
1042
                      standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1043
                      omit_input=omit_input, omit_output=omit_output,
1044
                      selection_domain=selection_domain,
1045 1046
                      selection_report=selection_report, precision=precision,
                      **sql_kw)
1047

1048
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1049
                              'getInventoryHistoryChart')
1050
    def getInventoryHistoryChart(self, src__=0, ignore_variation=0,
1051
                                 standardise=0, omit_simulation=0,
Romain Courteaud's avatar
Romain Courteaud committed
1052
                                 omit_input=0, omit_output=0,
1053
                                 selection_domain=None,
1054
                                 selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1055
      """
1056 1057 1058 1059 1060
      getInventoryHistoryChart is the pensing to getInventoryHistoryList
      to ease the rendering of time based graphs which show the evolution
      of one ore more inventories. Each item in the serie consists of
      time, value and "colour" (multiple graphs can be drawn for example
      for each variation of a resource)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1061
      """
1062 1063
      sql_kw = self._generateSQLKeywordDict(**kw)

Romain Courteaud's avatar
Romain Courteaud committed
1064
      return self.Resource_getInventoryHistoryChart(
1065
                    src__=src__, ignore_variation=ignore_variation,
1066
                    standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1067
                    omit_input=omit_input, omit_output=omit_output,
1068
                    selection_domain=selection_domain,
1069 1070
                    selection_report=selection_report, precision=precision,
                    **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1071

1072
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1073
                              'getMovementHistoryList')
1074
    def getMovementHistoryList(self, src__=0, ignore_variation=0,
1075
                               standardise=0, omit_simulation=0,
1076 1077
                               omit_input=0, omit_output=0,
                               selection_domain=None, selection_report=None,
1078
                               initial_running_total_quantity=0,
1079
                               initial_running_total_price=0, precision=None,
Romain Courteaud's avatar
Romain Courteaud committed
1080
                               **kw):
1081
      """Returns a list of movements which modify the inventory
1082
      for a single or a group of resource, node, section, etc.
1083 1084 1085
      A running total quantity and a running total price are available on
      brains. The initial values can be passed, in case you want to have an
      "initial summary line".
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1086
      """
1087
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
1088
      return self.Resource_zGetMovementHistoryList(
1089 1090
                         src__=src__, ignore_variation=ignore_variation,
                         standardise=standardise,
1091
                         omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1092
                         omit_input=omit_input, omit_output=omit_output,
1093
                         selection_domain=selection_domain,
1094 1095 1096 1097 1098
                         selection_report=selection_report,
                         initial_running_total_quantity=
                                  initial_running_total_quantity,
                         initial_running_total_price=
                                  initial_running_total_price,
1099
                         precision=precision, **sql_kw)
1100

1101
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1102
                              'getMovementHistoryStat')
1103
    def getMovementHistoryStat(self, src__=0, ignore_variation=0,
1104
                               standardise=0, omit_simulation=0, omit_input=0,
1105
                               omit_output=0, selection_domain=None,
1106
                               selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1107
      """
Romain Courteaud's avatar
Romain Courteaud committed
1108 1109
      getMovementHistoryStat is the pending to getMovementHistoryList
      for ListBox stat
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1110
      """
1111
      sql_kw = self._generateSQLKeywordDict(**kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1112
      return self.Resource_zGetInventory(src__=src__,
1113
          ignore_variation=ignore_variation, standardise=standardise,
1114
          omit_simulation=omit_simulation, omit_input=omit_input,
1115
          omit_output=omit_output, selection_domain=selection_domain,
1116
          selection_report=selection_report, precision=precision, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1117

1118 1119
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getNextNegativeInventoryDate')
1120
    def getNextNegativeInventoryDate(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1121 1122 1123
      """
      Returns statistics of inventory grouped by section or site
      """
1124 1125 1126
      #sql_kw = self._generateSQLKeywordDict(order_by_expression='stock.date', **kw)
      #sql_kw['group_by_expression'] = 'stock.uid'
      #sql_kw['order_by_expression'] = 'stock.date'
1127

1128
      result = self.getInventoryList(src__=src__,
1129
          sort_on = (('stock.date', 'ascending'),), group_by_movement=1, **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1130 1131
      if src__ :
        return result
1132

1133
      total_inventory = 0.
1134
      for inventory in result:
1135 1136 1137 1138 1139
        if inventory['inventory'] is not None:
          total_inventory += inventory['inventory']
          if total_inventory < 0:
            return inventory['date']

1140
      return None
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1141

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1142
    #######################################################
1143
    # Traceability management
1144
    security.declareProtected(Permissions.AccessContentsInformation, 'getTrackingList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1145
    def getTrackingList(self, src__=0,
1146 1147
        selection_domain=None, selection_report=None,
        strict_simulation_state=1, **kw) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1148
      """
1149
      Returns a list of items in the form
1150

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1151 1152 1153 1154 1155 1156
        uid (of item)
        date
        node_uid
        section_uid
        resource_uid
        variation_text
1157
        delivery_uid
1158

1159 1160 1161 1162 1163 1164 1165 1166
      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
1167 1168

      This method is only suitable for singleton items (an item which can
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1169 1170
      only be at a single place at a given time). Such items include
      containers, serial numbers (ex. for engine), rolls with subrolls,
1171 1172

      This method is not suitable for batches (ex. a coloring batch).
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1173
      For such items, standard getInventoryList method is appropriate
1174

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1175
      Parameters are the same as for getInventory.
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
      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

      selection_domain, selection_report - see ListBox

      **kw  - if we want extended selection with more keywords (but bad performance)
1209
              check what we can do with buildSQLQuery
1210 1211 1212 1213

      Extra parameters for getTrackingList :

      item
1214

1215 1216 1217 1218 1219
      input - if set, answers to the question "which are those items which have been
              delivered for the first time after from_date". Cannot be used with output

      output - if set, answers to the question "which are those items which have been
               delivered for the last time before at_date or to_date". Cannot be used with input
1220

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1221
      """
1222
      new_kw = self._generateSQLKeywordDict(table='item',strict_simulation_state=strict_simulation_state,**kw)
1223 1224 1225 1226
      at_date = kw.get('at_date',None)
      if at_date is not None:
        query_mixin = QueryMixin()
        at_date = query_mixin._quoteSQLString(at_date)
1227
        at_date = at_date.strip("'")
1228 1229 1230
      # Do not remove at_date in new_kw, it is required in 
      # order to do a "select item left join item on date"
      new_kw['at_date'] = at_date
1231

1232 1233 1234 1235
      # Extra parameters for the SQL Method
      new_kw['join_on_item'] = new_kw.get('at_date') or \
                               new_kw.get('input') or \
                               new_kw.get('output')
1236
      new_kw['date_condition_in_join'] = not (new_kw.get('input') or new_kw.get('output'))
1237

1238 1239 1240 1241 1242
      # Pass simulation state to request
      if kw.has_key('item.simulation_state'):
          new_kw['simulation_state_list'] = kw['item.simulation_state']
      else:
          new_kw['simulation_state_list'] =  None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1243

1244
      return self.Resource_zGetTrackingList(src__=src__,
1245 1246 1247
                                            selection_domain=selection_domain,
                                            selection_report=selection_report,
                                            **new_kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1248 1249 1250 1251 1252 1253

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentTrackingList')
    def getCurrentTrackingList(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
1254
      kw['item.simulation_state'] = self.getPortalCurrentInventoryStateList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1255 1256 1257 1258 1259 1260 1261
      return self.getTrackingList(**kw)

    security.declareProtected(Permissions.AccessContentsInformation, 'getFutureTrackingList')
    def getFutureTrackingList(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
1262
      kw['item.simulation_state'] = tuple(list(self.getPortalFutureInventoryStateList())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1263 1264 1265
          + list(self.getPortalReservedInventoryStateList()) + list(self.getPortalCurrentInventoryStateList()))
      return self.getTrackingList(**kw)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
    #######################################################
    # 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()
1293 1294
      start_date = movement.getStartDate()
      stop_date = movement.getStopDate()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
      # 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.
1432
            if not isinstance(resource_aggregation_base_category, (tuple, list)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
              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
1487 1488
    # Asset Price Calculation
    def updateAssetPrice(self, resource, variation_text, section_category, node_category,
1489 1490 1491
                         strict_membership=0, simulation_state=None):
      if simulation_state is None:
        simulation_state = self.getPortalCurrentInventoryStateList()
1492 1493 1494
      category_tool = getToolByName(self, 'portal_categories')
      section_value = category_tool.resolveCategory(section_category)
      node_value = category_tool.resolveCategory(node_category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1495 1496 1497 1498
      # 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
1499
      brain_list = self.Resource_zGetMovementHistoryList(resource=[resource],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1500 1501 1502 1503
                             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
1504 1505 1506 1507
                             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
1508 1509
        m = b.getObject()
        if m is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
          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(),
1528
                          m.getQuantity(), 'Production or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1529 1530 1531 1532 1533 1534
                        ))
          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(),
1535
                          m.getQuantity(), 'Consumption or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1536
                        ))
1537
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and m.getDestinationValue().isAcquiredMemberOf(node_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1538 1539 1540 1541
            # 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(),
1542
                          m.getQuantity(), 'Internal', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1543
                        ))
1544
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and quantity < 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1545 1546 1547 1548
            # 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
1549
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1550
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1551
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1552 1553 1554 1555
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1556
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1557
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1558
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1559
                          ))
1560
            elif m.getDestinationSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1561
              current_inventory += inventory_quantity # Update inventory
1562
              if m.getDestinationValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1563 1564 1565 1566
                # 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(),
1567
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1568
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1569 1570 1571
              else:
                # Inbound from same section
                asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1572
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1573
                              m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1574
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1575
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1576 1577 1578
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1579
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1580
                          ))
1581
          elif m.getDestinationValue().isAcquiredMemberOf(node_category) and quantity > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1582 1583 1584 1585 1586 1587
            # 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(),
1588
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1589 1590 1591 1592
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1593
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1594
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1595
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1596
                          ))
1597
            elif m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1598
              current_inventory += inventory_quantity # Update inventory
1599
              if m.getSourceValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1600 1601 1602 1603
                # 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(),
1604
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1605
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1606
              else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1607 1608 1609
                # Inbound from same section
                asset_price = current_asset_price
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1610
                            m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1611
                          ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1612
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1613 1614 1615
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1616
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1617 1618 1619 1620 1621 1622
                          ))
          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(),
1623
                            m.getQuantity(), 'Outbound', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
                          ))

          # 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
1638
          if m.getSourceSectionValue() is not None and m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1639 1640
            # 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
1641 1642 1643 1644 1645 1646 1647
            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
1648 1649
            # 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
1650 1651 1652 1653 1654
            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)
1655 1656 1657
          # 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
1658
          m.reindexObject()
1659
          #m.activate(priority=7).immediateReindexObject() # Too slow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1660 1661

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

1663 1664 1665
    # Used for mergeDeliveryList.
    class MergeDeliveryListError(Exception): pass

1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
    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:
1677
        raise self.MergeDeliveryListError, "No delivery is passed"
1678
      elif len(delivery_list) == 1:
1679
        raise self.MergeDeliveryListError, "Only one delivery is passed"
1680 1681 1682 1683

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

1684
      # Another sanity check. It is necessary for them to be identical in some attributes.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
      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:
1695 1696 1697 1698
            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.
1699
      main_discount_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1700
      for delivery in delivery_list:
1701
        discount_list = delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
        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.
1715
      main_payment_condition_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1716
      for delivery in delivery_list:
1717
        payment_condition_list = delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
        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())
1731 1732 1733

      # Make sure that all activities are flushed, to get simulation movements from delivery cells.
      for delivery in delivery_list:
1734
        for order in delivery.getCausalityValueList(portal_type = self.getPortalOrderTypeList()):
1735 1736
          for applied_rule in order.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1737
        for causality_related_delivery in delivery.getCausalityValueList(portal_type = self.getPortalDeliveryTypeList()):
1738 1739
          for applied_rule in causality_related_delivery.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1740

1741 1742 1743 1744 1745
      # 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[:]
1746
      for delivery in delivery_list:
1747 1748 1749
        simulated_movement_list.extend(delivery.getSimulatedMovementList())
        invoice_movement_list.extend(delivery.getInvoiceMovementList())

1750 1751 1752 1753
      #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())))

1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
      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)
1766 1767 1768 1769 1770 1771 1772 1773 1774
        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)))

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
        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:
1789 1790
                  if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                    or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1791 1792 1793 1794 1795
                    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
1796

1797 1798 1799
              if delivery_line is None:
                # Not found. So create a new delivery line.
                movement = base_variant_group.movement_list[0]
1800 1801
                if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                  or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1802
                  delivery_line_type = movement.aq_parent.getPortalType()
1803
                else:
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
                  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)

1814
              object_to_update = None
1815 1816 1817 1818 1819 1820
              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()
1821
                    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)))
1822 1823 1824 1825 1826 1827 1828
                    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
1829

1830
                #LOG('mergeDeliveryList', 0, 'object_to_update = %s' % repr(object_to_update))
1831
                if object_to_update is not None:
1832
                  cell_price = object_to_update.getPrice() or 0.0
1833
                  cell_quantity = object_to_update.getQuantity() or 0.0
1834
                  cell_target_quantity = object_to_update.getNetConvertedTargetQuantity() or 0.0 # XXX What to do ?
1835
                  cell_total_price = cell_target_quantity * cell_price
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
                  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
1846 1847
                      cell_price = movement.getPrice()
                      cell_total_price += movement.getNetConvertedTargetQuantity() * cell_price
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1848
                    except TypeError:
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
                      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

1871
                  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)))
1872
                  object_to_update.setCategoryList(cell_category_list)
1873
                  if object_to_update.getPortalType() in self.getPortalSimulatedMovementTypeList():
1874 1875 1876 1877
                    object_to_update.edit(target_quantity = cell_target_quantity,
                                          quantity = cell_quantity,
                                          price = average_price,
                                          )
1878
                  elif object_to_update.getPortalType() in self.getPortalInvoiceMovementTypeList():
1879 1880 1881 1882 1883 1884 1885
                    # 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()
1886 1887 1888 1889 1890
                else:
                  raise self.MergeDeliveryListError, "No object to update"

      # Merge containers. Just copy them from other deliveries into the main.
      for delivery in delivery_list:
1891
        container_id_list = delivery.contentIds(filter = {'portal_type': self.getPortalContainerTypeList()})
1892 1893 1894
        if len(container_id_list) > 0:
          copy_data = delivery.manage_copyObjects(ids = container_id_list)
          new_id_list = main_delivery.manage_pasteObjects(copy_data)
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914

      # 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

1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
    #######################################################
    # Sequence
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getSequence')
    def getSequence(self, **kw):
      """
      getSequence is take the same parameters as Sequence constructor,
      and return a Sequence.
      """
      return Sequence(**kw)

    #######################################################
    # Time Management
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTime')
    def getAvailableTime(self, from_date=None, to_date=None, 
1931 1932
                         portal_type=[], node=[], 
                         resource=[], src__=0, **kw):
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
      """
      Calculate available time for a node
      Returns an inventory of a single or multiple resources on a single
      node as a single float value

      from_date (>=) - only take rows which mirror_date is >= from_date

      to_date   (<)  - only take rows which date is < to_date

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

1945 1946 1947
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
      portal_type    - only take rows in stock table which portal_type
                       is in portal_type parameter
      """
      # XXX For now, consider that from_date and to_date are required
      if (from_date is None) or (to_date is None):
        raise NotImplementedError, \
              "getAvailableTime does not managed yet None values"
      # Calculate portal_type
      if portal_type == []:
        portal_type = self.getPortalCalendarPeriodTypeList()

1959 1960 1961 1962
      simulation_state = self.getPortalCurrentInventoryStateList() + \
                         self.getPortalTransitInventoryStateList() + \
                         self.getPortalReservedInventoryStateList()

1963
      sql_result = self.Person_zGetAvailableTime(
1964 1965 1966 1967
                          from_date=from_date,
                          to_date=to_date,
                          portal_type=portal_type,
                          node=node,
1968
                          resource=resource,
1969
                          simulation_state=simulation_state,
1970 1971
                          src__=src__, **kw)
      if not src__:
1972
        result = 0
1973 1974 1975 1976
        if len(sql_result) == 1:
          result = sql_result[0].total_quantity
      else:
        result = sql_result
1977 1978 1979 1980 1981 1982
      return result

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTimeSequence')
    def getAvailableTimeSequence(self, from_date, to_date,  
                                 portal_type=[], node=[],
1983
                                 resource=[], 
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
                                 src__=0,
                                 **kw):
      """
      Calculate available time for a node in multiple period of time.
      Each row is the available time for a specific period

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

      portal_type    - only take rows in stock table which portal_type
                       is in portal_type parameter

1996 1997 1998
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010
      from_date (>=) - return period which start >= from_date

      to_date   (<)  - return period which start < to_date

      second, minute,
      hour, day,
      month, year   - duration of each time period (cumulative)
      """
      # Calculate portal_type
      if portal_type == []:
        portal_type = self.getPortalCalendarPeriodTypeList()

2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
      sequence = Sequence(from_date, to_date, **kw)
      for sequence_item in sequence:
        setattr(sequence_item, 'total_quantity',
                self.getAvailableTime(
                          from_date=sequence_item.from_date,
                          to_date=sequence_item.to_date,
                          portal_type=portal_type,
                          node=node,
                          resource=resource,
                          src__=src__))
      return sequence
2022 2023

from Products.ERP5Type.DateUtils import addToDate
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033

class SequenceItem:
  """
  SequenceItem define a time period.
  period.
  """
  def __init__(self, from_date, to_date):
    self.from_date = from_date
    self.to_date = to_date

2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
class Sequence:
  """
  Sequence is a iterable object, which calculate a range of time
  period.
  """
  def __init__(self, from_date, to_date, 
               second=None, minute=None, hour=None,
               day=None, month=None, year=None):
    """
    Calculate a list of time period.
    Time period is a 2-tuple of 2 DateTime, which represent the from date
    and to date of the period.

    The start date of a period is calculated with the rule
        start_date of the previous + period duration

    from_date (>=) - return period which start >= from_date

    to_date   (<)  - return period which start < to_date

    second, minute,
    hour, day,
    month, year   - duration of each time period (cumulative)

    """
    self.item_list = []
    # Calculate all time period
    current_from_date = from_date
    while current_from_date < to_date:
      current_to_date = addToDate(current_from_date, 
                                  second=second,
                                  minute=minute,
                                  hour=hour,
                                  day=day,
                                  month=month,
                                  year=year)
2070 2071
      self.item_list.append(SequenceItem(current_from_date, 
                                         current_to_date))
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088
      current_from_date = current_to_date

  def __len__(self):
    return len(self.item_list)

  def __getitem__(self, key):
    return self.item_list[key]

  def __contains__(self, value):
    return (value in self.item_list)

  def __iter__(self):
    for x in self.item_list:
      yield x

InitializeClass(Sequence)
allow_class(Sequence)
2089 2090
InitializeClass(SequenceItem)
allow_class(SequenceItem)
2091

2092
InitializeClass(SimulationTool)