SimulationTool.py 91 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
class SimulationTool(BaseTool):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
    """
    The SimulationTool implements the ERP5
    simulation algorithmics.


    Examples of applications:

    -

    -
    ERP5 main purpose:

    -

    -

    """
    id = 'portal_simulation'
    meta_type = 'ERP5 Simulation Tool'
69
    portal_type = 'Simulation Tool'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
70 71 72 73 74 75 76 77 78 79 80 81
    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):
82 83 84 85 86 87 88
      # 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
89

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

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

98 99 100 101 102 103 104 105 106 107 108 109
      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)
110

111
    def solveDelivery(self, delivery, dsolver_name, tsolver_name,
112 113 114 115 116 117
                                     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)
118 119

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

    def solveMovementOrDelivery(self, obj, dsolver_name, tsolver_name,
128 129
                                          movement=0,delivery=0,
                                          additional_parameters=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130
      """
131
        Solve a delivery by calling DeliverySolver and TargetSolver
Jean-Paul Smets's avatar
Jean-Paul Smets committed
132
      """
133 134 135 136 137 138 139 140 141
      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)
142
          solver = solver_class(additional_parameters=additional_parameters,**kw)
143

144
          if movement:
145
            return solver.solveMovement(obj)
146
          if delivery:
147
            return solver.solveDelivery(obj)
148

Jean-Paul Smets's avatar
Jean-Paul Smets committed
149 150
    #######################################################
    # Stock Management
151

152 153 154 155 156 157 158 159
    def _generatePropertyUidList(self, property, as_text=0):
      """
      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
      """
160 161 162
      if property is None :
        return []
      category_tool = getToolByName(self, 'portal_categories')
163 164
      property_uid_list = []
      if type(property) is type('') :
165
        if not as_text:
166 167 168 169
          prop_value = category_tool.getCategoryValue(property)
          if prop_value is None:
            raise ValueError, 'Category %s does not exists' % property
          property_uid_list.append(prop_value.getUid())
170 171 172 173
        else:
          property_uid_list.append(property)
      elif type(property) is type([]) or type(property) is type(()) :
        for property_item in property :
174
          if not as_text:
175 176 177 178
            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())
179 180 181 182 183 184 185
          else:
            property_uid_list.append(property_item)
      elif type(property) is type({}) :
        tmp_uid_list = []
        if type(property['query']) is type('') :
          property['query'] = [property['query']]
        for property_item in property['query'] :
186
          if not as_text:
187 188 189 190
            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())
191 192
          else:
            tmp_uid_list.append(property_item)
193
        if tmp_uid_list:
194 195 196 197 198
          property_uid_list = {}
          property_uid_list['operator'] = property['operator']
          property_uid_list['query'] = tmp_uid_list
      return property_uid_list

199
    def _generateSQLKeywordDict(self, table='stock',
200
        # dates
201
        from_date=None, to_date=None, at_date=None,
202
        # instances
Alexandre Boeglin's avatar
Alexandre Boeglin committed
203
        resource=None, node=None, payment=None,
204 205 206 207
        section=None, mirror_section=None, item=None,
        # used for tracking
        input=0, output=0,
        # categories
Alexandre Boeglin's avatar
Alexandre Boeglin committed
208
        resource_category=None, node_category=None, payment_category=None,
209
        section_category=None, mirror_section_category=None,
210 211 212 213 214 215 216
        # 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
217
        strict_simulation_state=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
218
        simulation_state=None, transit_simulation_state = None, omit_transit=0,
219 220
        input_simulation_state=None, output_simulation_state=None,
        # variations
221
        variation_text=None, sub_variation_text=None,
222 223 224 225 226
        variation_category=None,
        # uids
        resource_uid=None, node_uid=None, section_uid=None,
        # keywords for related keys
        **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
227
      """
228
      generates keywords and calls buildSQLQuery
Alexandre Boeglin's avatar
Alexandre Boeglin committed
229 230 231 232 233
      """
      new_kw = {}
      new_kw.update(kw)
      sql_kw = {}

234 235 236 237
      # input and output are used by getTrackingList
      sql_kw['input'] = input
      sql_kw['output'] = output

Alexandre Boeglin's avatar
Alexandre Boeglin committed
238 239 240 241 242 243 244
      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'
245 246 247
        elif at_date :
          date_dict['query'].append(at_date)
          date_dict['range'] = 'minngt'
Alexandre Boeglin's avatar
Alexandre Boeglin committed
248 249 250 251 252 253 254
      elif to_date :
        date_dict['query'].append(to_date)
        date_dict['range'] = 'max'
      elif at_date :
        date_dict['query'].append(at_date)
        date_dict['range'] = 'ngt'
      if len(date_dict) :
255
        new_kw[table + '.date'] = date_dict
256

257
      # Some columns exists on multiple tables, we have to clear ambiguities
258 259 260 261
      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
262
        sql_kw['section_filtered'] = 1
263 264
      if node_uid is not None :
        new_kw[table + '.node_uid'] = node_uid
265

266
      resource_uid_list = self._generatePropertyUidList(resource)
267
      if resource_uid_list:
268
        new_kw[table + '.resource_uid'] = resource_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
269

270
      item_uid_list = self._generatePropertyUidList(item)
271
      if item_uid_list:
272
        new_kw[table + '.aggregate_uid'] = item_uid_list
273

274
      node_uid_list = self._generatePropertyUidList(node)
275
      if node_uid_list:
276
        new_kw[table + '.node_uid'] = node_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
277

278
      payment_uid_list = self._generatePropertyUidList(payment)
279
      if payment_uid_list:
280
        new_kw[table + '.payment_uid'] = payment_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
281

282
      section_uid_list = self._generatePropertyUidList(section)
283
      if section_uid_list:
284
        new_kw[table + '.section_uid'] = section_uid_list
285
        sql_kw['section_filtered'] = 1
Alexandre Boeglin's avatar
Alexandre Boeglin committed
286

287
      mirror_section_uid_list = self._generatePropertyUidList(mirror_section)
288
      if mirror_section_uid_list:
289
        new_kw[table + '.mirror_section_uid'] = mirror_section_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
290

291 292
      variation_text_list = self._generatePropertyUidList(variation_text,
                                                          as_text=1)
293
      if variation_text_list:
294
        new_kw[table + '.variation_text'] = variation_text_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
295

296 297
      sub_variation_text_list = self._generatePropertyUidList(
                                              sub_variation_text, as_text=1)
298
      if sub_variation_text_list:
299 300
        new_kw[table + '.sub_variation_text'] = sub_variation_text_list

301 302 303
      # category membership
      resource_category_uid_list = self._generatePropertyUidList(
                                              resource_category)
304
      if resource_category_uid_list:
305
        new_kw[table + '_resource_category_uid'] = resource_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
306

307
      node_category_uid_list = self._generatePropertyUidList(node_category)
308
      if node_category_uid_list:
309
        new_kw[table + '_node_category_uid'] = node_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
310

311
      payment_category_uid_list = self._generatePropertyUidList(payment_category)
312
      if payment_category_uid_list:
313
        new_kw[table + '_payment_category_uid'] = payment_category_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
314

315
      section_category_uid_list = self._generatePropertyUidList(section_category)
316
      if section_category_uid_list:
317
        new_kw[table + '_section_category_uid'] = section_category_uid_list
318
        sql_kw['section_filtered'] = 1
Alexandre Boeglin's avatar
Alexandre Boeglin committed
319

320 321
      mirror_section_category_uid_list = self._generatePropertyUidList(
                                              mirror_section_category)
322
      if mirror_section_category_uid_list:
323 324 325 326 327 328
        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)
329
      if resource_category_strict_membership_uid_list:
330 331 332 333 334
        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)
335
      if node_category_strict_membership_uid_list:
336 337 338 339 340
        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)
341
      if payment_category_strict_membership_uid_list:
342 343 344 345 346
        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)
347
      if section_category_strict_membership_uid_list:
348 349
        new_kw[table + '_section_category_strict_membership_uid'] =\
            section_category_strict_membership_uid_list
350
        sql_kw['section_filtered'] = 1
351 352 353 354

      mirror_section_category_strict_membership_uid_list =\
            self._generatePropertyUidList(
                                  mirror_section_category_strict_membership)
355
      if mirror_section_category_strict_membership_uid_list:
356 357
        new_kw[table + '_mirror_section_category_strict_membership_uid'] =\
            mirror_section_category_strict_membership_uid_list
Alexandre Boeglin's avatar
Alexandre Boeglin committed
358

359 360 361
      #variation_category_uid_list = self._generatePropertyUidList(variation_category)
      #if len(variation_category_uid_list) :
      #  new_kw['variationCategory'] = variation_category_uid_list
362 363
      
      string_or_list = (str, list, tuple)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
364
      # Simulation States
365 366
      # If strict_simulation_state is set, we directly put it into the dictionary
      if strict_simulation_state:
367 368 369
        if isinstance(simulation_state, string_or_list)\
                and simulation_state:
          new_kw['simulation_state'] = simulation_state
370 371
      else:
        # first, we evaluate simulation_state
372
        if simulation_state and isinstance(simulation_state, string_or_list):
373 374 375 376 377 378
          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
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
        # 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
Alexandre Boeglin's avatar
Alexandre Boeglin committed
410

411 412 413 414 415 416 417
      # 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 = {}
418
      if variation_category is not None and variation_category:
419 420
        where_expression = self.getPortalObject().portal_categories\
          .buildSQLSelector(
421 422 423 424 425 426 427 428 429 430
            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)
431 432
          new_kw['where_expression'] = '( %s )' % ' OR '.join(
                      ['catalog.uid=%s' % uid for uid in uid_list])
Alexandre Boeglin's avatar
Alexandre Boeglin committed
433

Sebastien Robin's avatar
Sebastien Robin committed
434 435
      # build the group by expression
      group_by_expression_list = []
436
      if kw.get('group_by_node', 0):
437
        group_by_expression_list.append('%s.node_uid' % table)
438 439 440 441 442 443 444 445 446
      if kw.get('group_by_mirror_node', 0):
        group_by_expression_list.append('%s.mirror_node_uid' % table)
      if kw.get('group_by_section', 0):
        group_by_expression_list.append('%s.section_uid' % table)
      if kw.get('group_by_mirror_section', 0):
        group_by_expression_list.append('%s.mirror_section_uid' % table)
      if kw.get('group_by_payment', 0):
        group_by_expression_list.append('%s.payment_uid' % table)
      if kw.get('group_by_sub_variation', 0):
447
        group_by_expression_list.append('%s.sub_variation_text' % table)
448
      if kw.get('group_by_variation', 0):
449
        group_by_expression_list.append('%s.variation_text' % table)
450 451 452 453
      if group_by_expression_list:
        # by default, we group by resource
        if kw.get('group_by_resource', 1):
          group_by_expression_list.append('%s.resource_uid' % table)
454
        new_kw['group_by_expression'] = ', '.join(group_by_expression_list)
455
      
456
      sql_kw.update(self.portal_catalog.buildSQLQuery(**new_kw))
457 458
      return sql_kw

Jean-Paul Smets's avatar
Jean-Paul Smets committed
459
    #######################################################
460 461
    # Inventory management
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
462
                              'getInventory')
463
    def getInventory(self, src__=0, ignore_variation=0, standardise=0,
464
                     omit_simulation=0, omit_input=0, omit_output=0,
465 466
                     selection_domain=None, selection_report=None,
                     precision=None, **kw):
467
      """
468 469
      Returns an inventory of a single or multiple resources on a single or
      multiple nodes as a single float value
470

471
      from_date (>=) - only take rows which date is >= from_date
472

473
      to_date   (<)  - only take rows which date is < to_date
474 475 476 477 478

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

      resource (only in generic API in simulation)

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

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

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

488 489
      mirror_section -  only take rows in stock table which mirror_section_uid is
                        mirror_section
490

491 492
      resource_category  -  only take rows in stock table which
                        resource_uid is member of resource_category
493

494 495
      node_category   - only take rows in stock table which node_uid is
                        member of section_category
496

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

500
      section_category -  only take rows in stock table which section_uid is
501 502 503 504 505 506 507 508 509 510 511
                          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
512

513 514 515
      section_filter  - only take rows in stock table which section_uid
                        matches section_filter

516 517
      mirror_section_filter - only take rows in stock table which
                              mirror_section_uid matches mirror_section_filter
518

519 520 521 522 523 524
      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
525

526 527
      sub_variation_text - only take rows in stock table with specified
                        variation_text
528

529 530
      variation_category - variation or list of possible variations (it is not
                        a cross-search ; SQL query uses OR)
531 532 533

      simulation_state - only take rows with specified simulation_state

534
      transit_simulation_state - specifies which states are transit states
535

536
      omit_transit   -  do not evaluate transit_simulation_state
537

538 539
      input_simulation_state - only take rows with specified simulation_state
                        and quantity > 0
540

541 542
      output_simulation_state - only take rows with specified simulation_state
                        and quantity < 0
543

544 545 546
      ignore_variation -  do not take into account variation in inventory
                        calculation (useless on getInventory, but useful on
                        getInventoryList)
547

548 549
      standardise    -  provide a standard quantity rather than an SKU (XXX
                        not implemented yet)
550

551 552
      omit_simulation - doesn't take into account simulation movements

553
      omit_input     -  doesn't take into account movement with quantity < 0
554

555
      omit_output    -  doesn't take into account movement with quantity > 0
556 557 558

      selection_domain, selection_report - see ListBox

559 560
      group_by_variation - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
561

562 563
      group_by_node  -  (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
564

565 566
      group_by_mirror_node - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
567

568 569
      group_by_sub_variation - (useless on getInventory, but useful on
                        getInventoryList)
570

571 572
      precision - the precision used to round quantities and prices.

573 574
      **kw           -  if we want extended selection with more keywords (but
                        bad performance) check what we can do with
575
                        buildSQLQuery
576

577 578
      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.)
579 580 581
      """
      sql_kw = self._generateSQLKeywordDict(**kw)

582 583 584 585 586 587 588 589 590
      # 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

Romain Courteaud's avatar
Romain Courteaud committed
591
      result = self.Resource_zGetInventory(
592
          src__=src__, ignore_variation=ignore_variation,
593
          standardise=standardise, omit_simulation=omit_simulation,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
594
          omit_input=omit_input, omit_output=omit_output,
Romain Courteaud's avatar
Romain Courteaud committed
595
          selection_domain=selection_domain, selection_report=selection_report,
596
          precision=precision, **sql_kw)
597
      if src__:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
598 599
        return result

600 601 602 603 604 605 606
      total_result = 0.0
      if len(result) > 0:
        for result_line in result:
          if result_line.inventory is not None:
            total_result += result_line.inventory

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

608
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
609
                              'getCurrentInventory')
610 611
    def getCurrentInventory(self, omit_transit=1,
                            transit_simulation_state=None,**kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
612 613 614
      """
      Returns current inventory
      """
615 616 617
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList() + \
                               self.getPortalTransitInventoryStateList()
      if transit_simulation_state is None:
618
        transit_simulation_state = self.getPortalTransitInventoryStateList()
619 620 621 622
      current_inventory = self.getInventory(omit_transit=omit_transit,
                                  transit_simulation_state=transit_simulation_state,
                                  **kw)
      return current_inventory
Alexandre Boeglin's avatar
Alexandre Boeglin committed
623

624
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
625
                              'getAvailableInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
626 627 628
    def getAvailableInventory(self, **kw):
      """
      Returns available inventory
629
      (current inventory - reserved_inventory)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
630
      """
631 632 633 634
      current_inventory = self.getCurrentInventory(**kw)
      kw['simulation_state'] = self.getPortalReservedInventoryStateList()
      reserved_inventory = self.getInventory(omit_input=1,**kw)
      return current_inventory+reserved_inventory
Alexandre Boeglin's avatar
Alexandre Boeglin committed
635

636
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
637
                              'getFutureInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
638 639 640 641
    def getFutureInventory(self, **kw):
      """
      Returns future inventory
      """
Romain Courteaud's avatar
Romain Courteaud committed
642 643
      kw['simulation_state'] = tuple(
                   list(self.getPortalFutureInventoryStateList()) + \
644
                   list(self.getPortalTransitInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
645 646
                   list(self.getPortalReservedInventoryStateList()) + \
                   list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
647 648
      return self.getInventory(**kw)

649
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
650
                              'getInventoryList')
651
    def getInventoryList(self, src__=0, ignore_variation=0, standardise=0,
652
                         omit_simulation=0, omit_input=0, omit_output=0,
653 654
                         selection_domain=None, selection_report=None,
                         precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
655
      """
656 657 658
        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
659
        a given group of resource, node, section.
660 661
        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
662
        average, cost, etc.)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
663
      """
664
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
665
      return self.Resource_zGetInventoryList(
666
                    src__=src__, ignore_variation=ignore_variation,
667
                    standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
668
                    omit_input=omit_input, omit_output=omit_output,
669
                    selection_domain=selection_domain,
670 671
                    selection_report=selection_report, precision=precision,
                    **sql_kw)
Romain Courteaud's avatar
Romain Courteaud committed
672

673
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
674
                              'getCurrentInventoryList')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
675 676
    def getCurrentInventoryList(self, **kw):
      """
Romain Courteaud's avatar
Romain Courteaud committed
677
        Returns list of current inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
678
      """
679
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
680 681
      return self.getInventoryList(**kw)

682
    security.declareProtected(Permissions.AccessContentsInformation,
683 684 685 686 687 688 689 690 691
                              'getAvailableInventoryList')
    def getAvailableInventoryList(self, **kw):
      """
        Returns list of current inventory grouped by section or site
      """
      kw['simulation_state'] = tuple(
                    list(self.getPortalReservedInventoryStateList()) + \
                    list(self.getPortalCurrentInventoryStateList()))
      return self.getInventoryList(**kw)
692 693

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
694
                              'getFutureInventoryList')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
695 696
    def getFutureInventoryList(self, **kw):
      """
Romain Courteaud's avatar
Romain Courteaud committed
697
        Returns list of future inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
698
      """
Romain Courteaud's avatar
Romain Courteaud committed
699
      kw['simulation_state'] = tuple(
Romain Courteaud's avatar
Romain Courteaud committed
700 701
                 list(self.getPortalFutureInventoryStateList()) + \
                 list(self.getPortalReservedInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
702
                 list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
703 704
      return self.getInventoryList(**kw)

705
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
706
                              'getInventoryStat')
707
    def getInventoryStat(self, src__=0, ignore_variation=0, standardise=0,
708
                         omit_simulation=0, omit_input=0, omit_output=0,
709 710
                         selection_domain=None, selection_report=None,
                         precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
711
      """
712
      getInventoryStat is the pending to getInventoryList in order to
Romain Courteaud's avatar
Romain Courteaud committed
713
      provide statistics on getInventoryList lines in ListBox such as:
714
      total of inventories, number of variations, number of different
Romain Courteaud's avatar
Romain Courteaud committed
715
      nodes, etc.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
716
      """
Romain Courteaud's avatar
Romain Courteaud committed
717
      kw['group_by_variation'] = 0
718
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
719
      result = self.Resource_zGetInventory(
720
          src__=src__, ignore_variation=ignore_variation,
721
          standardise=standardise, omit_simulation=omit_simulation,
722
          omit_input=omit_input, omit_output=omit_output,
723
          selection_domain=selection_domain,
724 725
          selection_report=selection_report,
          precision=precision, **sql_kw)
Romain Courteaud's avatar
Romain Courteaud committed
726
      return result
727 728

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
729
                              'getCurrentInventoryStat')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
730 731 732 733
    def getCurrentInventoryStat(self, **kw):
      """
      Returns statistics of current inventory grouped by section or site
      """
734
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
735 736
      return self.getInventoryStat(**kw)

737
    security.declareProtected(Permissions.AccessContentsInformation,
738 739 740 741 742 743 744 745 746
                              'getAvailableInventoryStat')
    def getAvailableInventoryStat(self, **kw):
      """
      Returns statistics of current inventory grouped by section or site
      """
      kw['simulation_state'] = tuple(
                    list(self.getPortalReservedInventoryStateList()) + \
                    list(self.getPortalCurrentInventoryStateList()))
      return self.getInventoryStat(**kw)
747 748

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
749
                              'getFutureInventoryStat')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
750 751 752 753
    def getFutureInventoryStat(self, **kw):
      """
      Returns statistics of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
754 755 756 757
      kw['simulation_state'] = tuple(
                 list(self.getPortalFutureInventoryStateList()) + \
                 list(self.getPortalReservedInventoryStateList()) + \
                 list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
758 759
      return self.getInventoryStat(**kw)

760
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
761
                              'getInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
762
    def getInventoryChart(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
763
      """
764 765
      Returns a list of couples derived from getInventoryList in order
      to feed a chart renderer. Each couple consist of a label
766
      (node, section, payment, combination of node & section, etc.)
Romain Courteaud's avatar
Romain Courteaud committed
767
      and an inventory value.
768

769
      Mostly useful for charts in ERP5 forms.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
770
      """
Alexandre Boeglin's avatar
Alexandre Boeglin committed
771
      result = self.getInventoryList(src__=src__, **kw)
772
      if src__ :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
773
        return result
774 775

      return map(lambda r: (r.node_title, r.inventory), result)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
776

777
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
778
                              'getCurrentInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
779 780 781 782
    def getCurrentInventoryChart(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
783
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
784 785
      return self.getInventoryChart(**kw)

786
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
787
                              'getFutureInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
788 789 790 791
    def getFutureInventoryChart(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
792 793 794 795
      kw['simulation_state'] = tuple(
                      list(self.getPortalFutureInventoryStateList()) + \
                      list(self.getPortalReservedInventoryStateList()) + \
                      list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
796 797
      return self.getInventoryChart(**kw)

798
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
799
                              'getInventoryAssetPrice')
800
    def getInventoryAssetPrice(self, src__=0, ignore_variation=0,
801
                               standardise=0, omit_simulation=0, omit_input=0,
802
                               omit_output=0, selection_domain=None,
803
                               selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
804
      """
805
      Same thing as getInventory but returns an asset
806
      price rather than an inventory.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
807
      """
808
      sql_kw = self._generateSQLKeywordDict(**kw)
809 810
      result = self.Resource_zGetInventory(
          src__=src__, ignore_variation=ignore_variation,
811
          standardise=standardise, omit_simulation=omit_simulation,
812 813
          omit_input=omit_input, omit_output=omit_output,
          selection_domain=selection_domain, selection_report=selection_report,
814
          precision=precision, **sql_kw)
815 816
      if src__ :
        return result
817

818 819 820
      total_result = 0.0
      if len(result) > 0:
        for result_line in result:
821
          if result_line.total_price is not None:
822
            total_result += result_line.total_price
823

824
      return total_result
Alexandre Boeglin's avatar
Alexandre Boeglin committed
825

826
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
827
                              'getCurrentInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
828 829 830 831
    def getCurrentInventoryAssetPrice(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
832
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
833 834
      return self.getInventoryAssetPrice(**kw)

835
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
836
                              'getAvailableInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
837 838 839 840 841
    def getAvailableInventoryAssetPrice(self, **kw):
      """
      Returns list of available inventory grouped by section or site
      (current inventory - deliverable)
      """
842 843 844
      kw['simulation_state'] = tuple(
                    list(self.getPortalReservedInventoryStateList()) + \
                    list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
845 846
      return self.getInventoryAssetPrice(**kw)

847
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
848
                              'getFutureInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
849 850 851 852
    def getFutureInventoryAssetPrice(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
853 854 855 856
      kw['simulation_state'] = tuple(
               list(self.getPortalFutureInventoryStateList()) + \
               list(self.getPortalReservedInventoryStateList()) + \
               list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
857 858
      return self.getInventoryAssetPrice(**kw)

859
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
860
                              'getInventoryHistoryList')
861
    def getInventoryHistoryList(self, src__=0, ignore_variation=0,
862
                                standardise=0, omit_simulation=0, omit_input=0,
863
                                omit_output=0, selection_domain=None,
864
                                selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
865
      """
866 867 868
      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).
869 870 871 872

      TODO:
        - make sure getInventoryHistoryList can return
	  cumulative values calculated by SQL (JPS)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
873
      """
874
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
875
      return self.Resource_getInventoryHistoryList(
876
                      src__=src__, ignore_variation=ignore_variation,
877
                      standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
878
                      omit_input=omit_input, omit_output=omit_output,
879
                      selection_domain=selection_domain,
880 881
                      selection_report=selection_report, precision=precision,
                      **sql_kw)
882

883
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
884
                              'getInventoryHistoryChart')
885
    def getInventoryHistoryChart(self, src__=0, ignore_variation=0,
886
                                 standardise=0, omit_simulation=0,
Romain Courteaud's avatar
Romain Courteaud committed
887
                                 omit_input=0, omit_output=0,
888
                                 selection_domain=None,
889
                                 selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
890
      """
891 892 893 894 895
      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
896
      """
897 898
      sql_kw = self._generateSQLKeywordDict(**kw)

Romain Courteaud's avatar
Romain Courteaud committed
899
      return self.Resource_getInventoryHistoryChart(
900
                    src__=src__, ignore_variation=ignore_variation,
901
                    standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
902
                    omit_input=omit_input, omit_output=omit_output,
903
                    selection_domain=selection_domain,
904 905
                    selection_report=selection_report, precision=precision,
                    **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
906

907
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
908
                              'getMovementHistoryList')
909
    def getMovementHistoryList(self, src__=0, ignore_variation=0,
910
                               standardise=0, omit_simulation=0,
911 912
                               omit_input=0, omit_output=0,
                               selection_domain=None, selection_report=None,
913
                               initial_running_total_quantity=0,
914
                               initial_running_total_price=0, precision=None,
Romain Courteaud's avatar
Romain Courteaud committed
915
                               **kw):
916
      """Returns a list of movements which modify the inventory
917
      for a single or a group of resource, node, section, etc.
918 919 920
      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
921
      """
922
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
923
      return self.Resource_zGetMovementHistoryList(
924 925
                         src__=src__, ignore_variation=ignore_variation,
                         standardise=standardise,
926
                         omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
927
                         omit_input=omit_input, omit_output=omit_output,
928
                         selection_domain=selection_domain,
929 930 931 932 933
                         selection_report=selection_report,
                         initial_running_total_quantity=
                                  initial_running_total_quantity,
                         initial_running_total_price=
                                  initial_running_total_price,
934
                         precision=precision, **sql_kw)
935

936
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
937
                              'getMovementHistoryStat')
938
    def getMovementHistoryStat(self, src__=0, ignore_variation=0,
939
                               standardise=0, omit_simulation=0, omit_input=0,
940
                               omit_output=0, selection_domain=None,
941
                               selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
942
      """
Romain Courteaud's avatar
Romain Courteaud committed
943 944
      getMovementHistoryStat is the pending to getMovementHistoryList
      for ListBox stat
Alexandre Boeglin's avatar
Alexandre Boeglin committed
945
      """
946
      sql_kw = self._generateSQLKeywordDict(**kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
947
      return self.Resource_zGetInventory(src__=src__,
948
          ignore_variation=ignore_variation, standardise=standardise,
949
          omit_simulation=omit_simulation, omit_input=omit_input,
950
          omit_output=omit_output, selection_domain=selection_domain,
951
          selection_report=selection_report, precision=precision, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
952

953
    security.declareProtected(Permissions.AccessContentsInformation, 'getNextNegativeInventoryDate')
954
    def getNextNegativeInventoryDate(self, src__=0,
955
        ignore_variation=0, standardise=0, omit_simulation=0, omit_input=0, omit_output=0,
956
        selection_domain=None, selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
957 958 959
      """
      Returns statistics of inventory grouped by section or site
      """
960
      sql_kw = self._generateSQLKeywordDict(order_by_expression='stock.date', **kw)
961 962
      sql_kw['group_by_expression'] = 'stock.uid'
      sql_kw['order_by_expression'] = 'stock.date'
963

964
      result = self.Resource_zGetInventory(src__=src__,
965
          ignore_variation=ignore_variation, standardise=standardise, omit_simulation=omit_simulation,
966
          omit_input=omit_input, omit_output=omit_output,
967 968
          selection_domain=selection_domain, selection_report=selection_report,
          precision=precision, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
969 970
      if src__ :
        return result
971

972
      total_inventory = 0.
973
      for inventory in result:
974 975 976 977 978
        if inventory['inventory'] is not None:
          total_inventory += inventory['inventory']
          if total_inventory < 0:
            return inventory['date']

979
      return None
Alexandre Boeglin's avatar
Alexandre Boeglin committed
980

Jean-Paul Smets's avatar
Jean-Paul Smets committed
981
    #######################################################
982
    # Traceability management
983
    security.declareProtected(Permissions.AccessContentsInformation, 'getTrackingList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
984
    def getTrackingList(self, src__=0,
985 986
        selection_domain=None, selection_report=None,
        strict_simulation_state=1, **kw) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
987
      """
988
      Returns a list of items in the form
989

Jean-Paul Smets's avatar
Jean-Paul Smets committed
990 991 992 993 994 995
        uid (of item)
        date
        node_uid
        section_uid
        resource_uid
        variation_text
996
        delivery_uid
997

998 999 1000 1001 1002 1003 1004 1005
      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
1006 1007

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1014
      Parameters are the same as for getInventory.
1015

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
      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)
1048
              check what we can do with buildSQLQuery
1049 1050 1051 1052

      Extra parameters for getTrackingList :

      item
1053

1054 1055 1056 1057 1058
      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
1059

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1060
      """
1061
      new_kw = self._generateSQLKeywordDict(table='item',strict_simulation_state=strict_simulation_state,**kw)
1062

1063 1064 1065 1066
      # 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')
1067
      new_kw['date_condition_in_join'] = not (new_kw.get('input') or new_kw.get('output'))
1068

1069 1070 1071 1072 1073
      # 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
1074

1075
      return self.Resource_zGetTrackingList(src__=src__,
1076 1077 1078
                                            selection_domain=selection_domain,
                                            selection_report=selection_report,
                                            **new_kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1079 1080 1081 1082 1083 1084

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentTrackingList')
    def getCurrentTrackingList(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
1085
      kw['item.simulation_state'] = self.getPortalCurrentInventoryStateList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1086 1087 1088 1089 1090 1091 1092
      return self.getTrackingList(**kw)

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
    #######################################################
    # 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()
1124 1125
      start_date = movement.getStartDate()
      stop_date = movement.getStopDate()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 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 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
      # Return result
      return self.isNodeInsideCapacity(source_node, start_date, additional_movement=movement, sign=1) and self.isNodeInsideCapacity(destination_node, stop_date, additional_movement=movement, sign=-1)

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

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

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

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

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

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

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

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

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

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

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

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

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


Jean-Paul Smets's avatar
Jean-Paul Smets committed
1318 1319
    # Asset Price Calculation
    def updateAssetPrice(self, resource, variation_text, section_category, node_category,
1320 1321 1322
                         strict_membership=0, simulation_state=None):
      if simulation_state is None:
        simulation_state = self.getPortalCurrentInventoryStateList()
1323 1324 1325
      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
1326 1327 1328 1329
      # 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
1330
      brain_list = self.Resource_zGetMovementHistoryList(resource=[resource],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1331 1332 1333 1334
                             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
1335 1336 1337 1338
                             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
1339 1340
        m = b.getObject()
        if m is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
          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(),
1359
                          m.getQuantity(), 'Production or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1360 1361 1362 1363 1364 1365
                        ))
          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(),
1366
                          m.getQuantity(), 'Consumption or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1367
                        ))
1368
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and m.getDestinationValue().isAcquiredMemberOf(node_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1369 1370 1371 1372
            # 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(),
1373
                          m.getQuantity(), 'Internal', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1374
                        ))
1375
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and quantity < 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1376 1377 1378 1379
            # 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
1380
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1381
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1382
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1383 1384 1385 1386
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1387
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1388
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1389
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1390
                          ))
1391
            elif m.getDestinationSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1392
              current_inventory += inventory_quantity # Update inventory
1393
              if m.getDestinationValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1394 1395 1396 1397
                # 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(),
1398
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1399
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1400 1401 1402
              else:
                # Inbound from same section
                asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1403
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1404
                              m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1405
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1406
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1407 1408 1409
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1410
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1411
                          ))
1412
          elif m.getDestinationValue().isAcquiredMemberOf(node_category) and quantity > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1413 1414 1415 1416 1417 1418
            # 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(),
1419
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1420 1421 1422 1423
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1424
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1425
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1426
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1427
                          ))
1428
            elif m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1429
              current_inventory += inventory_quantity # Update inventory
1430
              if m.getSourceValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1431 1432 1433 1434
                # 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(),
1435
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1436
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1437
              else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1438 1439 1440
                # Inbound from same section
                asset_price = current_asset_price
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1441
                            m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1442
                          ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1443
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1444 1445 1446
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1447
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1448 1449 1450 1451 1452 1453
                          ))
          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(),
1454
                            m.getQuantity(), 'Outbound', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
                          ))

          # 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
1469
          if m.getSourceSectionValue() is not None and m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1470 1471
            # 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
1472 1473 1474 1475 1476 1477 1478
            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
1479 1480
            # 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
1481 1482 1483 1484 1485
            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)
1486 1487 1488
          # 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
1489
          m.reindexObject()
1490
          #m.activate(priority=7).immediateReindexObject() # Too slow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1491 1492

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

1494 1495 1496
    # Used for mergeDeliveryList.
    class MergeDeliveryListError(Exception): pass

1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
    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:
1508
        raise self.MergeDeliveryListError, "No delivery is passed"
1509
      elif len(delivery_list) == 1:
1510
        raise self.MergeDeliveryListError, "Only one delivery is passed"
1511 1512 1513 1514

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

1515
      # Another sanity check. It is necessary for them to be identical in some attributes.
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
      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:
1526 1527 1528 1529
            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.
1530
      main_discount_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1531
      for delivery in delivery_list:
1532
        discount_list = delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
        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.
1546
      main_payment_condition_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1547
      for delivery in delivery_list:
1548
        payment_condition_list = delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
        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())
1562 1563 1564

      # Make sure that all activities are flushed, to get simulation movements from delivery cells.
      for delivery in delivery_list:
1565
        for order in delivery.getCausalityValueList(portal_type = self.getPortalOrderTypeList()):
1566 1567
          for applied_rule in order.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1568
        for causality_related_delivery in delivery.getCausalityValueList(portal_type = self.getPortalDeliveryTypeList()):
1569 1570
          for applied_rule in causality_related_delivery.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
1571

1572 1573 1574 1575 1576
      # 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[:]
1577
      for delivery in delivery_list:
1578 1579 1580
        simulated_movement_list.extend(delivery.getSimulatedMovementList())
        invoice_movement_list.extend(delivery.getInvoiceMovementList())

1581 1582 1583 1584
      #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())))

1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
      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)
1597 1598 1599 1600 1601 1602 1603 1604 1605
        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)))

1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
        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:
1620 1621
                  if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                    or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1622 1623 1624 1625 1626
                    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
1627

1628 1629 1630
              if delivery_line is None:
                # Not found. So create a new delivery line.
                movement = base_variant_group.movement_list[0]
1631 1632
                if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                  or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
1633
                  delivery_line_type = movement.aq_parent.getPortalType()
1634
                else:
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
                  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)

1645
              object_to_update = None
1646 1647 1648 1649 1650 1651
              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()
1652
                    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)))
1653 1654 1655 1656 1657 1658 1659
                    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
1660

1661
                #LOG('mergeDeliveryList', 0, 'object_to_update = %s' % repr(object_to_update))
1662
                if object_to_update is not None:
1663
                  cell_price = object_to_update.getPrice() or 0.0
1664
                  cell_quantity = object_to_update.getQuantity() or 0.0
1665
                  cell_target_quantity = object_to_update.getNetConvertedTargetQuantity() or 0.0 # XXX What to do ?
1666
                  cell_total_price = cell_target_quantity * cell_price
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
                  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
1677 1678
                      cell_price = movement.getPrice()
                      cell_total_price += movement.getNetConvertedTargetQuantity() * cell_price
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1679
                    except TypeError:
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
                      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

1702
                  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)))
1703
                  object_to_update.setCategoryList(cell_category_list)
1704
                  if object_to_update.getPortalType() in self.getPortalSimulatedMovementTypeList():
1705 1706 1707 1708
                    object_to_update.edit(target_quantity = cell_target_quantity,
                                          quantity = cell_quantity,
                                          price = average_price,
                                          )
1709
                  elif object_to_update.getPortalType() in self.getPortalInvoiceMovementTypeList():
1710 1711 1712 1713 1714 1715 1716
                    # 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()
1717 1718 1719 1720 1721
                else:
                  raise self.MergeDeliveryListError, "No object to update"

      # Merge containers. Just copy them from other deliveries into the main.
      for delivery in delivery_list:
1722
        container_id_list = delivery.contentIds(filter = {'portal_type': self.getPortalContainerTypeList()})
1723 1724 1725
        if len(container_id_list) > 0:
          copy_data = delivery.manage_copyObjects(ids = container_id_list)
          new_id_list = main_delivery.manage_pasteObjects(copy_data)
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745

      # 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

1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
    #######################################################
    # 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, 
1762 1763
                         portal_type=[], node=[], 
                         resource=[], src__=0, **kw):
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
      """
      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

1776 1777 1778
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
      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()

1790
      sql_result = self.Person_zGetAvailableTime(
1791 1792 1793 1794
                          from_date=from_date,
                          to_date=to_date,
                          portal_type=portal_type,
                          node=node,
1795
                          resource=resource,
1796 1797
                          src__=src__, **kw)
      if not src__:
1798
        result = 0
1799 1800 1801 1802
        if len(sql_result) == 1:
          result = sql_result[0].total_quantity
      else:
        result = sql_result
1803 1804 1805 1806 1807 1808
      return result

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTimeSequence')
    def getAvailableTimeSequence(self, from_date, to_date,  
                                 portal_type=[], node=[],
1809
                                 resource=[], 
1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
                                 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

1822 1823 1824
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
      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()

1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
      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
1848 1849

from Products.ERP5Type.DateUtils import addToDate
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859

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

1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
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)
1896 1897
      self.item_list.append(SequenceItem(current_from_date, 
                                         current_to_date))
1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
      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)
1915 1916
InitializeClass(SequenceItem)
allow_class(SequenceItem)
1917

1918
InitializeClass(SimulationTool)