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

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

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

from Products.ERP5 import _dtmldir

from zLOG import LOG

from Products.ERP5.Capacity.GLPK import solve
from Numeric import zeros, resize
Alexandre Boeglin's avatar
Alexandre Boeglin committed
43
from DateTime import DateTime
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

45 46
from Products.ERP5 import DeliverySolver
from Products.ERP5 import TargetSolver
47
from Products.PythonScripts.Utility import allow_class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48

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

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


    Examples of applications:

    -

    -
    ERP5 main purpose:

    -

    -

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

    # Declarative Security
    security = ClassSecurityInfo()

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

    def filtered_meta_types(self, user=None):
84 85 86 87 88 89 90
      # Filters the list of available meta types.
      all = SimulationTool.inheritedAttribute('filtered_meta_types')(self)
      meta_types = []
      for meta_type in self.all_meta_types():
        if meta_type['name'] in self.allowed_types:
          meta_types.append(meta_type)
      return meta_types
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      return omit_query

359 360 361
    def _getOmitDict(self, omit_input=False, omit_output=False):
      return {'input': omit_input, 'output': omit_output}

362
    def _generateSQLKeywordDict(self, table='stock', **kw):
363
        sql_kw, new_kw = self._generateKeywordDict(**kw)
364 365
        return self._generateSQLKeywordDictFromKeywordDict(table=table,
                 sql_kw=sql_kw, new_kw=new_kw)
366

367 368
    def _generateSQLKeywordDictFromKeywordDict(self, table='stock', sql_kw={},
                                               new_kw={}):
369 370
        sql_kw = sql_kw.copy()
        new_kw = new_kw.copy()
371 372
        # Some columns cannot be found automatically, prepend table name to
        # avoid ambiguities.
373
        # Group-by expression
374 375
        group_by = new_kw.pop('group_by', [])
        if len(group_by):
376 377
          new_kw['group_by_expression'] = ', '.join(['%s.%s' % (table, x) \
                                                     for x in group_by])
378
        # Column values
379 380 381
        column_value_dict = new_kw.pop('column_value_dict', {})
        for key, value in column_value_dict.iteritems():
          new_kw['%s.%s' % (table, key)] = value
382
        # Related keys
383 384 385 386 387 388
        # First, the passthrough (acts as default values)
        for key, value in new_kw.pop('related_key_dict_passthrough', {})\
            .iteritems():
          new_kw[key] = value
        # Second, calculated values
        for key, value in new_kw.pop('related_key_dict', {}).iteritems():
389
          new_kw['%s_%s' % (table, key)] = value
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
        # Simulation states matched with input and output omission
        def joinQueriesIfNeeded(query_a, query_b, operator):
          if None not in (query_a, query_b):
            return ComplexQuery(query_a, query_b, operator=operator)
          elif query_a is not None:
            return query_a
          return query_b
        def getSimulationQuery(simulation_dict, omit_dict):
          simulation_query = self._buildSimulationStateQuery(
                               simulation_state_dict=simulation_dict)
          omit_query = self._buildOmitQuery(query_table=table,
                                            omit_dict=omit_dict)
          return joinQueriesIfNeeded(query_a=simulation_query,
                                     query_b=omit_query, operator='AND')
        regular_query = getSimulationQuery(new_kw.pop('simulation_dict', {}),
                                           new_kw.pop('omit_dict', {}))
        reserved_kw = new_kw.pop('reserved_kw', None)
        if reserved_kw is not None:
          reserved_query = getSimulationQuery(
            reserved_kw.pop('simulation_dict', {}),
            reserved_kw.pop('omit_dict', {}))
          simulation_query = joinQueriesIfNeeded(query_a=regular_query,
                                                 query_b=reserved_query,
                                                 operator='OR')
        else:
          simulation_query = regular_query
        if simulation_query is not None:
          new_kw['query'] = simulation_query
418 419 420
        sql_kw.update(self.portal_catalog.buildSQLQuery(**new_kw))
        return sql_kw

421
    def _generateKeywordDict(self,
422
        # dates
423
        from_date=None, to_date=None, at_date=None,
424
        omit_mirror_date=1,
425
        # instances
Alexandre Boeglin's avatar
Alexandre Boeglin committed
426
        resource=None, node=None, payment=None,
427 428 429 430
        section=None, mirror_section=None, item=None,
        # used for tracking
        input=0, output=0,
        # categories
Alexandre Boeglin's avatar
Alexandre Boeglin committed
431
        resource_category=None, node_category=None, payment_category=None,
432
        section_category=None, mirror_section_category=None,
433 434 435 436 437 438 439
        # 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
440
        strict_simulation_state=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
441
        simulation_state=None, transit_simulation_state = None, omit_transit=0,
442
        input_simulation_state=None, output_simulation_state=None,
443
        reserved_kw=None,
444
        # variations
445
        variation_text=None, sub_variation_text=None,
446 447
        variation_category=None,
        # uids
448 449
        resource_uid=None, node_uid=None, section_uid=None, payment_uid=None,
        mirror_node_uid=None, mirror_section_uid=None,
450 451 452 453 454 455 456 457 458 459 460 461 462
        # omit input and output
        omit_input=0,
        omit_output=0,
        # group by
        group_by_node=0,
        group_by_mirror_node=0,
        group_by_section=0,
        group_by_mirror_section=0,
        group_by_payment=0,
        group_by_sub_variation=0,
        group_by_variation=0,
        group_by_movement=0,
        group_by_resource=1,
463 464
        # sort_on
        sort_on=None,
465 466
        # keywords for related keys
        **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
467
      """
468 469 470 471
      Generates keywords and calls buildSQLQuery

      - omit_mirror_date: normally, date's parameters are only based on date
        column. If 0, it also used the mirror_date column.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
472 473 474 475
      """
      new_kw = {}
      sql_kw = {}

476 477 478
      # input and output are used by getTrackingList
      sql_kw['input'] = input
      sql_kw['output'] = output
479 480 481
      # Add sort_on parameter if defined
      if sort_on is not None:
        new_kw['sort_on'] = sort_on
482

483 484 485 486 487 488 489 490 491 492 493 494
      class DictMixIn(dict):
        def set(dictionary, key, value):
          result = not(not(value))
          if result:
            dictionary[key] = value
          return result

        def setUIDList(dictionary, key, value, as_text=0):
          uid_list = self._generatePropertyUidList(value, as_text=as_text)
          return dictionary.set(key, uid_list)

      column_value_dict = DictMixIn()
495 496 497 498 499 500 501 502 503 504 505 506 507

      if omit_mirror_date:
        date_dict = {'query':[], 'operator':'and'}
        if from_date :
          date_dict['query'].append(from_date)
          date_dict['range'] = 'min'
          if to_date :
            date_dict['query'].append(to_date)
            date_dict['range'] = 'minmax'
          elif at_date :
            date_dict['query'].append(at_date)
            date_dict['range'] = 'minngt'
        elif to_date :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
508
          date_dict['query'].append(to_date)
509
          date_dict['range'] = 'max'
510 511
        elif at_date :
          date_dict['query'].append(at_date)
512
          date_dict['range'] = 'ngt'
513
        column_value_dict['date'] = date_dict
514
      else:
515 516
        column_value_dict['date'] = {'query': [to_date], 'range': 'ngt'}
        column_value_dict['mirror_date'] = {'query': [from_date], 'range': 'nlt'}
517

518
      column_value_dict.set('resource_uid', resource_uid)
519
      column_value_dict.set('payment_uid', payment_uid)
520
      if column_value_dict.set('section_uid', section_uid):
521
        sql_kw['section_filtered'] = 1
522
      column_value_dict.set('node_uid', node_uid)
523 524
      column_value_dict.set('mirror_node_uid', mirror_node_uid)
      column_value_dict.set('mirror_section_uid', mirror_section_uid)
525 526 527 528 529
      column_value_dict.setUIDList('resource_uid', resource)
      column_value_dict.setUIDList('aggregate_uid', item)
      column_value_dict.setUIDList('node_uid', node)
      column_value_dict.setUIDList('payment_uid', payment)
      if column_value_dict.setUIDList('section_uid', section):
530
        sql_kw['section_filtered'] = 1
531 532 533 534 535 536 537 538
      column_value_dict.setUIDList('mirror_section_uid', mirror_section)
      column_value_dict.setUIDList('variation_text', variation_text,
                                   as_text=1)
      column_value_dict.setUIDList('sub_variation_text', sub_variation_text,
                                   as_text=1)
      new_kw['column_value_dict'] = column_value_dict.copy()

      related_key_dict = DictMixIn()
539
      # category membership
540 541 542 543 544
      related_key_dict.setUIDList('resource_category_uid', resource_category)
      related_key_dict.setUIDList('node_category_uid', node_category)
      related_key_dict.setUIDList('payment_category_uid', payment_category)
      if related_key_dict.setUIDList('section_category_uid',
                                     section_category):
545
        sql_kw['section_filtered'] = 1
546 547
      related_key_dict.setUIDList('mirror_section_category_uid',
                                  mirror_section_category)
548
      # category strict membership
549 550 551 552 553 554 555 556
      related_key_dict.setUIDList('resource_category_strict_membership_uid',
                                  resource_category_strict_membership)
      related_key_dict.setUIDList('node_category_strict_membership_uid',
                                  node_category_strict_membership)
      related_key_dict.setUIDList('payment_category_strict_membership_uid',
                                  payment_category_strict_membership)
      if related_key_dict.setUIDList('section_category_strict_membership_uid',
                                     section_category_strict_membership):
557
        sql_kw['section_filtered'] = 1
558 559 560 561 562
      related_key_dict.setUIDList(
        'mirror_section_category_strict_membership_uid',
        mirror_section_category_strict_membership)
      
      new_kw['related_key_dict'] = related_key_dict.copy()
563
      new_kw['related_key_dict_passthrough'] = kw
564

565 566 567
      #variation_category_uid_list = self._generatePropertyUidList(variation_category)
      #if len(variation_category_uid_list) :
      #  new_kw['variationCategory'] = variation_category_uid_list
568
      
569
      simulation_dict =  self._getSimulationStateDict(
570
                                simulation_state=simulation_state, 
571 572 573 574 575
                                omit_transit=omit_transit,
                                input_simulation_state=input_simulation_state,
                                output_simulation_state=output_simulation_state,
                                transit_simulation_state=transit_simulation_state,
                                strict_simulation_state=strict_simulation_state)
576 577 578 579
      new_kw['simulation_dict'] = simulation_dict
      omit_dict = self._getOmitDict(omit_input=omit_input,
                                    omit_output=omit_output)
      new_kw['omit_dict'] = omit_dict
580
      if reserved_kw is not None:
581
        if not isinstance(reserved_kw, dict):
582 583 584
          # Not a dict when taken from URL, so, cast is needed 
          # to make pop method available
          reserved_kw = dict(reserved_kw)
585
        new_reserved_kw = {}
586 587
        reserved_omit_input = reserved_kw.pop('omit_input',0)
        reserved_omit_output = reserved_kw.pop('omit_output',0)
588 589 590 591 592
        new_reserved_kw['omit_dict'] = self._getOmitDict(
                                         omit_input=reserved_omit_input,
                                         omit_output=reserved_omit_output)
        new_reserved_kw['simulation_dict'] = self._getSimulationStateDict(**reserved_kw)
        new_kw['reserved_kw'] = new_reserved_kw
593 594 595 596 597 598 599
      # 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 = {}
600
      if variation_category is not None and variation_category:
601 602
        where_expression = self.getPortalObject().portal_categories\
          .buildSQLSelector(
603 604 605 606 607 608 609 610 611 612
            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)
613 614
          new_kw['where_expression'] = '( %s )' % ' OR '.join(
                      ['catalog.uid=%s' % uid for uid in uid_list])
Alexandre Boeglin's avatar
Alexandre Boeglin committed
615

Sebastien Robin's avatar
Sebastien Robin committed
616 617
      # build the group by expression
      group_by_expression_list = []
618
      if group_by_node:
619
        group_by_expression_list.append('node_uid')
620
      if group_by_mirror_node:
621
        group_by_expression_list.append('mirror_node_uid')
622
      if group_by_section:
623
        group_by_expression_list.append('section_uid')
624
      if group_by_mirror_section:
625
        group_by_expression_list.append('mirror_section_uid')
626
      if group_by_payment:
627
        group_by_expression_list.append('payment_uid')
628
      if group_by_sub_variation:
629
        group_by_expression_list.append('sub_variation_text')
630
      if group_by_variation:
631
        group_by_expression_list.append('variation_text')
632
      if group_by_movement:
633
        group_by_expression_list.append('uid')
634 635
      if group_by_resource:
        group_by_expression_list.append('resource_uid')
636
      if group_by_expression_list:
637 638
        new_kw['group_by'] = group_by_expression_list
      return sql_kw, new_kw 
639

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

649
      from_date (>=) - only take rows which date is >= from_date
650

651
      to_date   (<)  - only take rows which date is < to_date
652 653 654 655 656

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

      resource (only in generic API in simulation)

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

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

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

666 667
      mirror_section -  only take rows in stock table which mirror_section_uid is
                        mirror_section
668

669 670
      resource_category  -  only take rows in stock table which
                        resource_uid is member of resource_category
671

672 673
      node_category   - only take rows in stock table which node_uid is
                        member of section_category
674

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

678
      section_category -  only take rows in stock table which section_uid is
679 680 681 682 683 684 685 686 687 688 689
                          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
690

691 692 693
      section_filter  - only take rows in stock table which section_uid
                        matches section_filter

694 695
      mirror_section_filter - only take rows in stock table which
                              mirror_section_uid matches mirror_section_filter
696

697 698 699 700 701 702
      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
703

704 705
      sub_variation_text - only take rows in stock table with specified
                        variation_text
706

707 708
      variation_category - variation or list of possible variations (it is not
                        a cross-search ; SQL query uses OR)
709 710 711

      simulation_state - only take rows with specified simulation_state

712
      transit_simulation_state - specifies which states are transit states
713

714
      omit_transit   -  do not evaluate transit_simulation_state
715

716 717
      input_simulation_state - only take rows with specified simulation_state
                        and quantity > 0
718

719 720
      output_simulation_state - only take rows with specified simulation_state
                        and quantity < 0
721

722 723 724
      ignore_variation -  do not take into account variation in inventory
                        calculation (useless on getInventory, but useful on
                        getInventoryList)
725

726 727
      standardise    -  provide a standard quantity rather than an SKU (XXX
                        not implemented yet)
728

729 730
      omit_simulation - doesn't take into account simulation movements

731
      omit_input     -  doesn't take into account movement with quantity < 0
732

733
      omit_output    -  doesn't take into account movement with quantity > 0
734 735 736

      selection_domain, selection_report - see ListBox

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

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

743 744
      group_by_mirror_node - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
745

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

749 750 751
      group_by_movement - (useless on getInventory, but useful on
                        getInventoryList)

752 753
      precision - the precision used to round quantities and prices.

754 755
      **kw           -  if we want extended selection with more keywords (but
                        bad performance) check what we can do with
756
                        buildSQLQuery
757

758 759
      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.)
760
      """
761 762 763 764 765 766 767 768
      # 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
769 770
      method = getattr(self,'get%sInventoryList' % simulation_period)
      result = method(inventory_list=0, ignore_group_by=1, src__=src__, **kw)
771
      if src__:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
772 773
        return result

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

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

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

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

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

824
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
825
                              'getInventoryList')
826
    def getInventoryList(self, src__=0, ignore_variation=0, standardise=0,
827
                         omit_simulation=0, 
828
                         selection_domain=None, selection_report=None,
829
                         statistic=0, inventory_list=1, 
830
                         precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
831
      """
832 833 834
        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
835
        a given group of resource, node, section.
836 837
        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
838
        average, cost, etc.)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
839
      """
840
      # If no group at all, give a default sort group by
841
      kw = self._getDefaultGroupByParameters(**kw)
842
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
843
      return self.Resource_zGetInventoryList(
844
                    src__=src__, ignore_variation=ignore_variation,
845
                    standardise=standardise, omit_simulation=omit_simulation,
846
                    selection_domain=selection_domain,
847
                    selection_report=selection_report, precision=precision,
848 849
                    inventory_list=inventory_list, 
                    statistic=statistic, **sql_kw)
Romain Courteaud's avatar
Romain Courteaud committed
850

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

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

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

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

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

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

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

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

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

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

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

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

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

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

986 987 988
      total_result = 0.0
      if len(result) > 0:
        for result_line in result:
989
          if result_line.total_price is not None:
990
            total_result += result_line.total_price
991

992
      return total_result
Alexandre Boeglin's avatar
Alexandre Boeglin committed
993

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

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

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

1027
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1028
                              'getInventoryHistoryList')
1029
    def getInventoryHistoryList(self, src__=0, ignore_variation=0,
1030
                                standardise=0, omit_simulation=0, omit_input=0,
1031
                                omit_output=0, selection_domain=None,
1032
                                selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1033
      """
1034 1035 1036
      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).
1037 1038 1039 1040

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

1051
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1052
                              'getInventoryHistoryChart')
1053
    def getInventoryHistoryChart(self, src__=0, ignore_variation=0,
1054
                                 standardise=0, omit_simulation=0,
Romain Courteaud's avatar
Romain Courteaud committed
1055
                                 omit_input=0, omit_output=0,
1056
                                 selection_domain=None,
1057
                                 selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1058
      """
1059 1060 1061 1062 1063
      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
1064
      """
1065 1066
      sql_kw = self._generateSQLKeywordDict(**kw)

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

1075
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1076
                              'getMovementHistoryList')
1077
    def getMovementHistoryList(self, src__=0, ignore_variation=0,
1078
                               standardise=0, omit_simulation=0,
1079 1080
                               omit_input=0, omit_output=0,
                               selection_domain=None, selection_report=None,
1081
                               initial_running_total_quantity=0,
1082
                               initial_running_total_price=0, precision=None,
Romain Courteaud's avatar
Romain Courteaud committed
1083
                               **kw):
1084
      """Returns a list of movements which modify the inventory
1085
      for a single or a group of resource, node, section, etc.
1086 1087 1088
      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
1089
      """
1090
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
1091
      return self.Resource_zGetMovementHistoryList(
1092 1093
                         src__=src__, ignore_variation=ignore_variation,
                         standardise=standardise,
1094
                         omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1095
                         omit_input=omit_input, omit_output=omit_output,
1096
                         selection_domain=selection_domain,
1097 1098 1099 1100 1101
                         selection_report=selection_report,
                         initial_running_total_quantity=
                                  initial_running_total_quantity,
                         initial_running_total_price=
                                  initial_running_total_price,
1102
                         precision=precision, **sql_kw)
1103

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

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

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

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

1143
      return None
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1144

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

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

1162 1163 1164 1165 1166 1167 1168 1169
      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
1170 1171

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1178
      Parameters are the same as for getInventory.
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
      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)
1212
              check what we can do with buildSQLQuery
1213 1214 1215 1216

      Extra parameters for getTrackingList :

      item
1217

1218 1219 1220 1221 1222
      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
1223

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

1235 1236 1237 1238
      # 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')
1239
      new_kw['date_condition_in_join'] = not (new_kw.get('input') or new_kw.get('output'))
1240

1241 1242 1243 1244 1245
      # 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
1246

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

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

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

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

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

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

1666 1667 1668
    # Used for mergeDeliveryList.
    class MergeDeliveryListError(Exception): pass

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

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

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

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

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

1753 1754 1755 1756
      #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())))

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

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

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

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

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

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

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

      # 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

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
    #######################################################
    # 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, 
1934 1935
                         portal_type=[], node=[], 
                         resource=[], src__=0, **kw):
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947
      """
      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

1948 1949 1950
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961
      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()

1962 1963 1964 1965
      simulation_state = self.getPortalCurrentInventoryStateList() + \
                         self.getPortalTransitInventoryStateList() + \
                         self.getPortalReservedInventoryStateList()

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

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTimeSequence')
    def getAvailableTimeSequence(self, from_date, to_date,  
                                 portal_type=[], node=[],
1986
                                 resource=[], 
1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
                                 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

1999 2000 2001
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
      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()

2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
      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
2025 2026

from Products.ERP5Type.DateUtils import addToDate
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036

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

2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
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)
2073 2074
      self.item_list.append(SequenceItem(current_from_date, 
                                         current_to_date))
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091
      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)
2092 2093
InitializeClass(SequenceItem)
allow_class(SequenceItem)
2094

2095
InitializeClass(SimulationTool)