SimulationTool.py 114 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 52
from Shared.DC.ZRDB.Results import Results

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


    Examples of applications:

    -

    -
    ERP5 main purpose:

    -

    -

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

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

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

102 103 104 105 106 107 108 109 110 111 112 113
      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)
114

115
    def solveDelivery(self, delivery, dsolver_name, tsolver_name,
116 117 118 119 120 121
                                     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)
122 123

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

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

148
          if movement:
149
            return solver.solveMovement(obj)
150
          if delivery:
151
            return solver.solveDelivery(obj)
152

Jean-Paul Smets's avatar
Jean-Paul Smets committed
153 154
    #######################################################
    # Stock Management
155

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

203 204
    def _getSimulationStateQuery(self, **kw):
      simulation_state_dict = self._getSimulationStateDict(**kw)
205
      return self._buildSimulationStateQuery(simulation_state_dict=simulation_state_dict)
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 238 239
      
    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,
240 241 242 243 244 245 246 247 248 249 250 251
                                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
252
      simulation_dict = {}
253 254 255
      if strict_simulation_state:
        if isinstance(simulation_state, string_or_list)\
                and simulation_state:
256 257
           simulation_query = Query(
                   **{'stock.simulation_state': simulation_state})
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 311 312
      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:
313
              simulation_dict['simulation_state'] = input_simulation_state
314
            else:
315 316
              simulation_dict['input_simulation_state'] = input_simulation_state
              simulation_dict['output_simulation_state'] = output_simulation_state
317
          else:
318
            simulation_dict['input_simulation_state'] = input_simulation_state
319
        elif output_simulation_state is not None:
320 321
          simulation_dict['simulation_state'] = output_simulation_state
      return simulation_dict
322 323

    def _getOmitQuery(self, query_table=None, omit_input=0, omit_output=0, **kw):
324 325 326 327
      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):
328 329 330 331 332 333
      """
      Build a specific query in order to take:
      - negatives quantity values if omit_input
      - postives quantity values if omit_output
      """
      omit_query = None
334 335
      omit_input = omit_dict.get('input', False)
      omit_output = omit_dict.get('output', False)
336 337
      if omit_input or omit_output:
        # Make sure to check some conditions
338 339 340 341 342 343 344
        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}
345
        if omit_input:
346
          quantity_query = Query(**{'%s.quantity' % query_table: '<0'})
347 348 349
          omit_query = ComplexQuery(quantity_query, condition_expression,
                                    operator='AND')
        if omit_output:
350
          quantity_query = Query(**{'%s.quantity' % query_table: '>0'})
351 352 353 354 355 356 357 358 359 360
          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

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

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

369 370
    def _generateSQLKeywordDictFromKeywordDict(self, table='stock', sql_kw={},
                                               new_kw={}):
371 372
        sql_kw = sql_kw.copy()
        new_kw = new_kw.copy()
373 374
        # Some columns cannot be found automatically, prepend table name to
        # avoid ambiguities.
375
        # Group-by expression
376 377
        group_by = new_kw.pop('group_by', [])
        if len(group_by):
378 379
          new_kw['group_by_expression'] = ', '.join(['%s.%s' % (table, x) \
                                                     for x in group_by])
380
        # Column values
381 382 383
        column_value_dict = new_kw.pop('column_value_dict', {})
        for key, value in column_value_dict.iteritems():
          new_kw['%s.%s' % (table, key)] = value
384
        # Related keys
385 386 387 388 389 390
        # 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():
391
          new_kw['%s_%s' % (table, key)] = value
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
        # 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
420 421 422 423 424 425 426 427 428
        # Sort on
        if 'sort_on' in new_kw:
          sort_on = new_kw['sort_on']
          new_sort_on = []
          for column_id, sort_direction in sort_on:
            if '.' not in column_id:
              column_id = '%s.%s' % (table, column_id)
            new_sort_on.append((column_id, sort_direction))
          new_kw['sort_on'] = tuple(new_sort_on)
429 430 431
        sql_kw.update(self.portal_catalog.buildSQLQuery(**new_kw))
        return sql_kw

432
    def _generateKeywordDict(self,
433
        # dates
434
        from_date=None, to_date=None, at_date=None,
435
        omit_mirror_date=1,
436
        # instances
Alexandre Boeglin's avatar
Alexandre Boeglin committed
437
        resource=None, node=None, payment=None,
438 439 440 441
        section=None, mirror_section=None, item=None,
        # used for tracking
        input=0, output=0,
        # categories
Alexandre Boeglin's avatar
Alexandre Boeglin committed
442
        resource_category=None, node_category=None, payment_category=None,
443
        section_category=None, mirror_section_category=None,
444 445 446 447 448 449 450
        # 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
451
        strict_simulation_state=0,
Alexandre Boeglin's avatar
Alexandre Boeglin committed
452
        simulation_state=None, transit_simulation_state = None, omit_transit=0,
453
        input_simulation_state=None, output_simulation_state=None,
454
        reserved_kw=None,
455
        # variations
456
        variation_text=None, sub_variation_text=None,
457 458
        variation_category=None,
        # uids
459 460
        resource_uid=None, node_uid=None, section_uid=None, payment_uid=None,
        mirror_node_uid=None, mirror_section_uid=None,
461 462 463 464 465 466 467 468 469 470 471 472
        # 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,
473
        group_by_resource=0,
474 475
        # sort_on
        sort_on=None,
476 477
        # keywords for related keys
        **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
478
      """
479 480 481 482
      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
483 484 485 486
      """
      new_kw = {}
      sql_kw = {}

487 488 489
      # input and output are used by getTrackingList
      sql_kw['input'] = input
      sql_kw['output'] = output
490 491 492
      # Add sort_on parameter if defined
      if sort_on is not None:
        new_kw['sort_on'] = sort_on
493

494 495 496 497 498 499 500 501 502 503 504 505
      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()
506 507 508 509 510 511 512 513 514 515 516 517 518

      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
519
          date_dict['query'].append(to_date)
520
          date_dict['range'] = 'max'
521 522
        elif at_date :
          date_dict['query'].append(at_date)
523
          date_dict['range'] = 'ngt'
524
        column_value_dict['date'] = date_dict
525
      else:
526 527
        column_value_dict['date'] = {'query': [to_date], 'range': 'ngt'}
        column_value_dict['mirror_date'] = {'query': [from_date], 'range': 'nlt'}
528

529
      column_value_dict.set('resource_uid', resource_uid)
530
      column_value_dict.set('payment_uid', payment_uid)
531
      if column_value_dict.set('section_uid', section_uid):
532
        sql_kw['section_filtered'] = 1
533
      column_value_dict.set('node_uid', node_uid)
534 535
      column_value_dict.set('mirror_node_uid', mirror_node_uid)
      column_value_dict.set('mirror_section_uid', mirror_section_uid)
536 537 538 539 540
      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):
541
        sql_kw['section_filtered'] = 1
542 543 544 545 546 547 548 549
      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()
550
      # category membership
551 552 553 554 555
      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):
556
        sql_kw['section_filtered'] = 1
557 558
      related_key_dict.setUIDList('mirror_section_category_uid',
                                  mirror_section_category)
559
      # category strict membership
560 561 562 563 564 565 566 567
      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):
568
        sql_kw['section_filtered'] = 1
569 570 571 572 573
      related_key_dict.setUIDList(
        'mirror_section_category_strict_membership_uid',
        mirror_section_category_strict_membership)
      
      new_kw['related_key_dict'] = related_key_dict.copy()
574
      new_kw['related_key_dict_passthrough'] = kw
575

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

Sebastien Robin's avatar
Sebastien Robin committed
627 628
      # build the group by expression
      group_by_expression_list = []
629
      if group_by_node:
630
        group_by_expression_list.append('node_uid')
631
      if group_by_mirror_node:
632
        group_by_expression_list.append('mirror_node_uid')
633
      if group_by_section:
634
        group_by_expression_list.append('section_uid')
635
      if group_by_mirror_section:
636
        group_by_expression_list.append('mirror_section_uid')
637
      if group_by_payment:
638
        group_by_expression_list.append('payment_uid')
639
      if group_by_sub_variation:
640
        group_by_expression_list.append('sub_variation_text')
641
      if group_by_variation:
642
        group_by_expression_list.append('variation_text')
643
      if group_by_movement:
644
        group_by_expression_list.append('uid')
645 646
      if group_by_resource:
        group_by_expression_list.append('resource_uid')
647
      if group_by_expression_list:
648 649
        new_kw['group_by'] = group_by_expression_list
      return sql_kw, new_kw 
650

Jean-Paul Smets's avatar
Jean-Paul Smets committed
651
    #######################################################
652 653
    # Inventory management
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
654
                              'getInventory')
655
    def getInventory(self, src__=0, simulation_period='', **kw):
656
      """
657 658
      Returns an inventory of a single or multiple resources on a single or
      multiple nodes as a single float value
659

660
      from_date (>=) - only take rows which date is >= from_date
661

662
      to_date   (<)  - only take rows which date is < to_date
663 664 665 666 667

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

      resource (only in generic API in simulation)

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

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

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

677 678
      mirror_section -  only take rows in stock table which mirror_section_uid is
                        mirror_section
679

680 681
      resource_category  -  only take rows in stock table which
                        resource_uid is member of resource_category
682

683 684
      node_category   - only take rows in stock table which node_uid is
                        member of section_category
685

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

689
      section_category -  only take rows in stock table which section_uid is
690 691 692 693 694 695 696 697 698 699 700
                          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
701

702 703 704
      section_filter  - only take rows in stock table which section_uid
                        matches section_filter

705 706
      mirror_section_filter - only take rows in stock table which
                              mirror_section_uid matches mirror_section_filter
707

708 709 710 711 712 713
      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
714

715 716
      sub_variation_text - only take rows in stock table with specified
                        variation_text
717

718 719
      variation_category - variation or list of possible variations (it is not
                        a cross-search ; SQL query uses OR)
720 721 722

      simulation_state - only take rows with specified simulation_state

723
      transit_simulation_state - specifies which states are transit states
724

725
      omit_transit   -  do not evaluate transit_simulation_state
726

727 728
      input_simulation_state - only take rows with specified simulation_state
                        and quantity > 0
729

730 731
      output_simulation_state - only take rows with specified simulation_state
                        and quantity < 0
732

733 734 735
      ignore_variation -  do not take into account variation in inventory
                        calculation (useless on getInventory, but useful on
                        getInventoryList)
736

737 738
      standardise    -  provide a standard quantity rather than an SKU (XXX
                        not implemented yet)
739

740 741
      omit_simulation - doesn't take into account simulation movements

742
      omit_input     -  doesn't take into account movement with quantity < 0
743

744
      omit_output    -  doesn't take into account movement with quantity > 0
745 746 747

      selection_domain, selection_report - see ListBox

748 749
      group_by_variation - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
750

751 752
      group_by_node  -  (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
753

754 755
      group_by_mirror_node - (useless on getInventory, but useful on
                        getInventoryList)
Sebastien Robin's avatar
Sebastien Robin committed
756

757 758
      group_by_sub_variation - (useless on getInventory, but useful on
                        getInventoryList)
759

760 761 762
      group_by_movement - (useless on getInventory, but useful on
                        getInventoryList)

763 764
      precision - the precision used to round quantities and prices.

765 766
      **kw           -  if we want extended selection with more keywords (but
                        bad performance) check what we can do with
767
                        buildSQLQuery
768

769 770
      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.)
771
      """
772 773 774 775 776 777 778 779
      # 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
780 781
      method = getattr(self,'get%sInventoryList' % simulation_period)
      result = method(inventory_list=0, ignore_group_by=1, src__=src__, **kw)
782
      if src__:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
783 784
        return result

785 786
      total_result = 0.0
      if len(result) > 0:
787 788
        if len(result) != 1:
          raise ValueError, 'Sorry we must have only one'
789
        inventory = result[0].total_quantity
790 791
        if inventory is not None:
          total_result = inventory
792 793

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

795
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
796
                              'getCurrentInventory')
797
    def getCurrentInventory(self, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
798 799 800
      """
      Returns current inventory
      """
801
      return self.getInventory(simulation_period='Current', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
802

803
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
804
                              'getAvailableInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
805 806 807
    def getAvailableInventory(self, **kw):
      """
      Returns available inventory
808
      (current inventory - reserved_inventory)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
809
      """
810
      return self.getInventory(simulation_period='Available', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
811

812
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
813
                              'getFutureInventory')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
814 815 816 817
    def getFutureInventory(self, **kw):
      """
      Returns future inventory
      """
818
      return self.getInventory(simulation_period='Future', **kw)
819
    
820 821 822 823 824 825
    def _getDefaultGroupByParameters(self, ignore_group_by=0, 
        group_by_node=0, group_by_mirror_node=0,
        group_by_section=0, group_by_mirror_section=0,
        group_by_payment=0,
        group_by_variation=0, group_by_sub_variation=0,
        group_by_movement=0,
826
        group_by_resource=None,
827
        **ignored):
828 829
      """
      Set defaults group_by parameters
830 831 832 833 834 835

      If ignore_group_by is true, this function returns an empty dict.

      If any group-by is provided, automatically group by resource aswell
      unless group_by_resource is explicitely set to false.
      If no group by is provided, group by movement, node and resource.
836
      """
837 838 839 840 841
      new_group_by_dict = {}
      if not ignore_group_by:
        if group_by_node or group_by_mirror_node or group_by_section or \
           group_by_mirror_section or group_by_payment or \
           group_by_sub_variation or group_by_variation or group_by_movement:
842 843
          if group_by_resource is None:
            group_by_resource = 1
844
          new_group_by_dict['group_by_resource'] = group_by_resource
845
        elif group_by_resource is None:
846 847 848 849
          new_group_by_dict['group_by_movement'] = 1
          new_group_by_dict['group_by_node'] = 1
          new_group_by_dict['group_by_resource'] = 1
      return new_group_by_dict
Alexandre Boeglin's avatar
Alexandre Boeglin committed
850

851
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
852
                              'getInventoryList')
853 854
    def getInventoryList(self, src__=0, optimisation__=True,
                         ignore_variation=0, standardise=0,
855
                         omit_simulation=0, 
856
                         selection_domain=None, selection_report=None,
857
                         statistic=0, inventory_list=1, 
Aurel's avatar
Aurel committed
858
                         precision=None, connection_id=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
859
      """
860 861 862
        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
863
        a given group of resource, node, section.
864 865
        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
866
        average, cost, etc.)
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891

        Optimisation queries.
        Optimisation of a stock lookup is done to avoid a table scan
        of all lines corresponding to a given node, section or payment,
        because they grow with time and query time should not.
        First query: Fetch fitting full inventory dates.
          For each node, section or payment, find the first anterior full
          inventory.
        Second query: Fetch full inventory amounts.
          Fetch values of inventory identified in the first query.
        Tird query: Classic stock table read.
          Fetch all rows in stock table which are posterior to the inventory.
        Final result
          Add results of the second and third queries, and return it.

        Missing optimisations:
         - In a getInventory case where everything is specified for the
           resource, it's not required for the inventory to be full, it
           just need to be done for the right resource.
           If the resource isn't completely defined, we require inventory
           to be full, which is implemented.
         - Querying multiple nodes/categories/payments in one call prevents
           from using optimisation, it should be equivalent to multiple calls
           on individual nodes/categories/payments.
         - 
Alexandre Boeglin's avatar
Alexandre Boeglin committed
892
      """
893 894
      if src__:
        sql_source_list = []
895
      # If no group at all, give a default sort group by
896
      kw.update(self._getDefaultGroupByParameters(**kw))
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
      sql_kw, new_kw = self._generateKeywordDict(**kw)
      stock_sql_kw = self._generateSQLKeywordDictFromKeywordDict(
                       table='stock', sql_kw=sql_kw, new_kw=new_kw)
      Resource_zGetFullInventoryDate = \
        getattr(self, 'Resource_zGetFullInventoryDate', None)
      optimisation_success = optimisation__ and \
                             Resource_zGetFullInventoryDate is not None
      # Generate first query parameter dict
      if optimisation_success:
        def getFirstQueryParameterDict(query_generator_kw):
          AVAILABLE_CRITERIONS_IN_INVENTORY_TABLE = ['node_uid',
                                                     'section_uid',
                                                     'payment_uid']
          group_by_list = query_generator_kw.get('group_by', [])
          column_value_dict = query_generator_kw.get('column_value_dict', {})
          new_group_by_list = []
          new_column_value_dict = {}
          for criterion_id in AVAILABLE_CRITERIONS_IN_INVENTORY_TABLE:
            criterion_value_list = column_value_dict.get(criterion_id, [])
            if not isinstance(criterion_value_list, (list, tuple)):
              criterion_value_list = [criterion_value_list]
            if len(criterion_value_list) > 0:
              if len(criterion_value_list) > 1:
                # Impossible to optimise if there is more than one possible
                # value per criterion.
                optimisation_success = False
                break
              new_column_value_dict[criterion_id] = criterion_value_list
              new_group_by_list.append(criterion_id)
            elif criterion_id in group_by_list:
              new_group_by_list.append(criterion_id)
          group_by_expression = ', '.join(new_group_by_list)
          column_id_list = new_column_value_dict.keys()
          column_value_list_list = new_column_value_dict.values()
          date_value_list = column_value_dict.get('date', {}).get('query', [])
          if len(date_value_list) > 0:
            date = min(date_value_list)
            if isinstance(date, DateTime):
              date = date.ISO()
          else:
            date = None
          return {'group_by_expression': group_by_expression,
                  'column_id_list': column_id_list,
                  'column_value_list_list': column_value_list_list,
                  'date': date}
        first_query_param_dict = getFirstQueryParameterDict(new_kw)
        if optimisation_success:
          if len(first_query_param_dict['column_id_list']):
            inventory_date_line_list = self.Resource_zGetFullInventoryDate(
                                         **first_query_param_dict)
            if src__:
              sql_source_list.append(
                self.Resource_zGetFullInventoryDate(src__=src__,
                  **first_query_param_dict))
            # Check that all expected uids have been found, otherwise a full
            # inventory of a node/section/payment might be missing.
            if len(inventory_date_line_list) >= max([len(x) for x in \
               first_query_param_dict['column_value_list_list']]):
              # Generate a where expression which filters on dates retrieved
              # in the first query to be used in the second query.
              # Also, generate a where expression to use in the third query,
              # since it is based on the same data.
              # XXX: uggly duplicated query generation code
              # XXX: duplicates SQL variable formatting present in
              #      ERP5Type/patches/sqlvar.py about datetime SQL columns.
              equal_date_query_list = []
              greater_than_date_query_list = []
              EQUAL_DATE_TABLE_ID = 'inventory_stock'
              GREATER_THAN_DATE_TABLE_ID = 'stock'
              for inventory_date_line_dict in \
                  inventory_date_line_list.dictionaries():
                date = inventory_date_line_dict['date']
                non_date_value_dict = dict([(k, v) for k, v \
                  in inventory_date_line_dict.iteritems() if k != 'date'])
                equal_date_query_list.append(
                  ComplexQuery(
                    ComplexQuery(operator='AND',
                      *[Query(**{'%s.%s' % (EQUAL_DATE_TABLE_ID, k): v}) \
                        for k, v in non_date_value_dict.iteritems()]),
                    Query(**{'%s.date' % (EQUAL_DATE_TABLE_ID, ): date}),
                    operator='AND'))
                greater_than_date_query_list.append(
                  ComplexQuery(
                    ComplexQuery(operator='AND',
                      *[Query(**{'%s.%s' % (GREATER_THAN_DATE_TABLE_ID, k): \
                                 v}) \
                        for k, v in non_date_value_dict.iteritems()]),
                    Query(**{'%s.date' % (GREATER_THAN_DATE_TABLE_ID, ): \
                             '>%s' % (date.ISO(), )}),
                    operator='AND'))
              assert len(equal_date_query_list) == \
                     len(greater_than_date_query_list)
              assert len(equal_date_query_list) > 0
              equal_date_query = ComplexQuery(operator='OR',
                *equal_date_query_list).asSQLExpression()\
                ['where_expression']
              greater_than_date_query = ComplexQuery(operator='OR',
                *greater_than_date_query_list).asSQLExpression()\
                ['where_expression']
              inventory_stock_sql_kw = \
                self._generateSQLKeywordDictFromKeywordDict(
                  table=EQUAL_DATE_TABLE_ID, sql_kw=sql_kw, new_kw=new_kw)
              inventory_stock_where_query = \
                inventory_stock_sql_kw.get('where_expression', '(1)')
              assert isinstance(inventory_stock_where_query, basestring) \
                     and len(inventory_stock_where_query)
              inventory_stock_sql_kw['where_expression'] = '(%s) AND (%s)' % \
                (inventory_stock_where_query, equal_date_query)
              where_query = stock_sql_kw.get('where_expression', '(1)')
              assert isinstance(where_query, basestring) and len(where_query)
              stock_sql_kw['where_expression'] = '(%s) AND (%s)' % \
                (where_query, greater_than_date_query)
              # Get initial inventory amount
              initial_inventory_line_list = self.Resource_zGetInventoryList(
                stock_table_id='inventory_stock',
                src__=src__, ignore_variation=ignore_variation,
                standardise=standardise, omit_simulation=omit_simulation,
                selection_domain=selection_domain,
                selection_report=selection_report, precision=precision,
                inventory_list=inventory_list,
                statistic=statistic, **inventory_stock_sql_kw)
              # Get delta inventory
              delta_inventory_line_list = self.Resource_zGetInventoryList(
                stock_table_id='stock',
                src__=src__, ignore_variation=ignore_variation,
                standardise=standardise, omit_simulation=omit_simulation,
                selection_domain=selection_domain,
                selection_report=selection_report, precision=precision,
                inventory_list=inventory_list,
                statistic=statistic, **stock_sql_kw)
              # Match & add initial and delta inventories
              if src__:
                sql_source_list.extend((initial_inventory_line_list,
                                        delta_inventory_line_list))
              else:
                if 'group_by' in new_kw:
                  group_by_id_list = []
                  group_by_id_list_append = group_by_id_list.append
                  for group_by_id in new_kw['group_by']:
                    if group_by_id == 'uid':
                      group_by_id_list_append('stock_uid')
                    else:
                      group_by_id_list_append(group_by_id)
                  def getInventoryListKey(line):
                    """
                      Generate a key based on values used in SQL group_by
                    """
                    return tuple([line[x] for x in group_by_id_list])
                else:
                  def getInventoryListKey(line):
                    """
                      No group by criterion, regroup everything.
                    """
                    return 'dummy_key'
                result_column_id_dict = {}
                result_column_id_dict['inventory'] = None
                result_column_id_dict['total_quantity'] = None
                result_column_id_dict['total_price'] = None
                def addLineValues(line_a=None, line_b=None):
                  """
                    Addition columns of 2 lines and return a line with same
                    schema. If one of the parameters is None, returns the
                    other parameters.

                    Arythmetic modifications on additions:
                      None + x = x
                      None + None = None
                  """
                  if line_a is None:
                    return line_b
                  if line_b is None:
                    return line_a
                  result = {}
                  for key, value in line_a.iteritems():
                    if key in result_column_id_dict:
                      value_b = line_b[key]
                      if None not in (value, value_b):
                        result[key] = value + value_b
                      elif value is not None:
                        result[key] = value
                      else:
                        result[key] = value_b
                    elif line_a[key] == line_b[key]:
                      result[key] = line_a[key]
                    else:
                      LOG('InventoryTool.getInventoryList.addLineValues', 0,
                          'missmatch for %s column: %s and %s' % \
                          (key, line_a[key], line_b[key]))
                  return result
                inventory_list_dict = {}
                for line_list in (initial_inventory_line_list,
                                  delta_inventory_line_list):
                  for line in line_list.dictionaries():
                    line_key = getInventoryListKey(line)
                    line_a = inventory_list_dict.get(line_key)
                    inventory_list_dict[line_key] = addLineValues(line_a,
                                                                  line)
                ## XXX: Returns a dict instead of an <r> instance
                ## As long as they are accessed like dicts it's ok, but...
                #result = inventory_list_dict.values()
                sorted_inventory_list = inventory_list_dict.values()
                sort_on = new_kw.get('sort_on', tuple())
                if len(sort_on) != 0:
                  def cmp_inventory_line(line_a, line_b):
                    """
                      Compare 2 inventory lines and sort them according to
                      sort_on parameter.
                    """
                    result = 0
                    for key, sort_direction in sort_on:
                      if not(key in line_a and key in line_b):
                        raise Exception, "Impossible to sort result since " \
                          "columns sort happens on are not available in " \
                          "result."
                      result = cmp(line_a[key], line_b[key])
                      if result != 0:
                        if len(sort_direction[0]) and \
                           sort_direction[0].upper() != 'A':
                          # Default sort is ascending, if a sort is given and
                          # it does not start with an 'A' then reverse sort.
                          # Tedious syntax checking is MySQL's job, and
                          # happened when queries were executed.
                          result *= -1
                        break
                    return result
                  sorted_inventory_list.sort(cmp_inventory_line)
                result = Results((delta_inventory_line_list.\
                                    _searchable_result_columns(),
                                 tuple(sorted_inventory_list)))
            else:
              # Not all required full inventories are found
              optimisation_success = False
          else:
            # Not enough criterions to trigger optimisation
            optimisation_success = False
      if not optimisation_success:
        result = self.Resource_zGetInventoryList(
                    stock_table_id='stock',
1135
                    src__=src__, ignore_variation=ignore_variation,
1136
                    standardise=standardise, omit_simulation=omit_simulation,
1137
                    selection_domain=selection_domain,
1138
                    selection_report=selection_report, precision=precision,
Aurel's avatar
Aurel committed
1139
                    inventory_list=inventory_list, connection_id=connection_id,
1140 1141 1142 1143 1144 1145
                    statistic=statistic, **stock_sql_kw)
        if src__:
          sql_source_list.append(result)
      if src__:
        result = ';\n-- NEXT QUERY\n'.join(sql_source_list)
      return result
Romain Courteaud's avatar
Romain Courteaud committed
1146

1147
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1148
                              'getCurrentInventoryList')
1149 1150
    def getCurrentInventoryList(self, omit_transit=1, 
                                transit_simulation_state=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1151
      """
Romain Courteaud's avatar
Romain Courteaud committed
1152
        Returns list of current inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1153
      """
1154 1155 1156 1157 1158 1159 1160 1161 1162
      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
1163

1164
    security.declareProtected(Permissions.AccessContentsInformation,
1165
                              'getAvailableInventoryList')
1166
    def getAvailableInventoryList(self, omit_transit=1, transit_simulation_state=None, **kw):
1167 1168 1169
      """
        Returns list of current inventory grouped by section or site
      """
1170 1171 1172 1173 1174 1175 1176 1177 1178
      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)
1179 1180

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1181
                              'getFutureInventoryList')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1182 1183
    def getFutureInventoryList(self, **kw):
      """
Romain Courteaud's avatar
Romain Courteaud committed
1184
        Returns list of future inventory grouped by section or site
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1185
      """
Romain Courteaud's avatar
Romain Courteaud committed
1186
      kw['simulation_state'] = tuple(
Romain Courteaud's avatar
Romain Courteaud committed
1187
                 list(self.getPortalFutureInventoryStateList()) + \
1188
                 list(self.getPortalTransitInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
1189
                 list(self.getPortalReservedInventoryStateList()) + \
Romain Courteaud's avatar
Romain Courteaud committed
1190
                 list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1191 1192
      return self.getInventoryList(**kw)

1193
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1194
                              'getInventoryStat')
1195
    def getInventoryStat(self, simulation_period='', **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1196
      """
1197
      getInventoryStat is the pending to getInventoryList in order to
Romain Courteaud's avatar
Romain Courteaud committed
1198
      provide statistics on getInventoryList lines in ListBox such as:
1199
      total of inventories, number of variations, number of different
Romain Courteaud's avatar
Romain Courteaud committed
1200
      nodes, etc.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1201
      """
Romain Courteaud's avatar
Romain Courteaud committed
1202
      kw['group_by_variation'] = 0
1203
      method = getattr(self,'get%sInventoryList' % simulation_period)
1204
      return method(statistic=1, inventory_list=0, 
1205
                                   ignore_group_by=1, **kw)
1206 1207

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1208
                              'getCurrentInventoryStat')
1209
    def getCurrentInventoryStat(self, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1210 1211 1212
      """
      Returns statistics of current inventory grouped by section or site
      """
1213
      return self.getInventoryStat(simulation_period='Current', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1214

1215
    security.declareProtected(Permissions.AccessContentsInformation,
1216 1217 1218 1219 1220
                              'getAvailableInventoryStat')
    def getAvailableInventoryStat(self, **kw):
      """
      Returns statistics of current inventory grouped by section or site
      """
1221
      return self.getInventoryStat(simulation_period='Available', **kw)
1222 1223

    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1224
                              'getFutureInventoryStat')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1225 1226 1227 1228
    def getFutureInventoryStat(self, **kw):
      """
      Returns statistics of future inventory grouped by section or site
      """
1229
      return self.getInventoryStat(simulation_period='Future', **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1230

1231
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1232
                              'getInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1233
    def getInventoryChart(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1234
      """
1235 1236
      Returns a list of couples derived from getInventoryList in order
      to feed a chart renderer. Each couple consist of a label
1237
      (node, section, payment, combination of node & section, etc.)
Romain Courteaud's avatar
Romain Courteaud committed
1238
      and an inventory value.
1239

1240
      Mostly useful for charts in ERP5 forms.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1241
      """
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1242
      result = self.getInventoryList(src__=src__, **kw)
1243
      if src__ :
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1244
        return result
1245

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

1248
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1249
                              'getCurrentInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1250 1251 1252 1253
    def getCurrentInventoryChart(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
1254
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1255 1256
      return self.getInventoryChart(**kw)

1257
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1258
                              'getFutureInventoryChart')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1259 1260 1261 1262
    def getFutureInventoryChart(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
1263 1264 1265 1266
      kw['simulation_state'] = tuple(
                      list(self.getPortalFutureInventoryStateList()) + \
                      list(self.getPortalReservedInventoryStateList()) + \
                      list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1267 1268
      return self.getInventoryChart(**kw)

1269
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1270
                              'getInventoryAssetPrice')
1271 1272
    def getInventoryAssetPrice(self, src__=0, 
                               simulation_period='', **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1273
      """
1274
      Same thing as getInventory but returns an asset
1275
      price rather than an inventory.
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1276
      """
1277 1278
      method = getattr(self,'get%sInventoryList' % simulation_period)
      result = method( src__=src__, inventory_list=0, ignore_group_by=1, **kw)
1279 1280
      if src__ :
        return result
1281

1282 1283 1284
      total_result = 0.0
      if len(result) > 0:
        for result_line in result:
1285
          if result_line.total_price is not None:
1286
            total_result += result_line.total_price
1287

1288
      return total_result
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1289

1290
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1291
                              'getCurrentInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1292 1293 1294 1295
    def getCurrentInventoryAssetPrice(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
1296
      kw['simulation_state'] = self.getPortalCurrentInventoryStateList()
1297
      return self.getInventoryAssetPrice(simulation_period='Current',**kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1298

1299
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1300
                              'getAvailableInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1301 1302 1303 1304 1305
    def getAvailableInventoryAssetPrice(self, **kw):
      """
      Returns list of available inventory grouped by section or site
      (current inventory - deliverable)
      """
1306 1307 1308
      kw['simulation_state'] = tuple(
                    list(self.getPortalReservedInventoryStateList()) + \
                    list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1309 1310
      return self.getInventoryAssetPrice(**kw)

1311
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1312
                              'getFutureInventoryAssetPrice')
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1313 1314 1315 1316
    def getFutureInventoryAssetPrice(self, **kw):
      """
      Returns list of future inventory grouped by section or site
      """
Romain Courteaud's avatar
Romain Courteaud committed
1317 1318 1319 1320
      kw['simulation_state'] = tuple(
               list(self.getPortalFutureInventoryStateList()) + \
               list(self.getPortalReservedInventoryStateList()) + \
               list(self.getPortalCurrentInventoryStateList()))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1321 1322
      return self.getInventoryAssetPrice(**kw)

1323
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1324
                              'getInventoryHistoryList')
1325
    def getInventoryHistoryList(self, src__=0, ignore_variation=0,
1326
                                standardise=0, omit_simulation=0, omit_input=0,
1327
                                omit_output=0, selection_domain=None,
1328
                                selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1329
      """
1330 1331 1332
      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).
1333 1334 1335 1336

      TODO:
        - make sure getInventoryHistoryList can return
	  cumulative values calculated by SQL (JPS)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1337
      """
1338
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
1339
      return self.Resource_getInventoryHistoryList(
1340
                      src__=src__, ignore_variation=ignore_variation,
1341
                      standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1342
                      omit_input=omit_input, omit_output=omit_output,
1343
                      selection_domain=selection_domain,
1344 1345
                      selection_report=selection_report, precision=precision,
                      **sql_kw)
1346

1347
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1348
                              'getInventoryHistoryChart')
1349
    def getInventoryHistoryChart(self, src__=0, ignore_variation=0,
1350
                                 standardise=0, omit_simulation=0,
Romain Courteaud's avatar
Romain Courteaud committed
1351
                                 omit_input=0, omit_output=0,
1352
                                 selection_domain=None,
1353
                                 selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1354
      """
1355 1356 1357 1358 1359
      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
1360
      """
1361 1362
      sql_kw = self._generateSQLKeywordDict(**kw)

Romain Courteaud's avatar
Romain Courteaud committed
1363
      return self.Resource_getInventoryHistoryChart(
1364
                    src__=src__, ignore_variation=ignore_variation,
1365
                    standardise=standardise, omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1366
                    omit_input=omit_input, omit_output=omit_output,
1367
                    selection_domain=selection_domain,
1368 1369
                    selection_report=selection_report, precision=precision,
                    **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1370

1371
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1372
                              'getMovementHistoryList')
1373
    def getMovementHistoryList(self, src__=0, ignore_variation=0,
1374
                               standardise=0, omit_simulation=0,
1375 1376
                               omit_input=0, omit_output=0,
                               selection_domain=None, selection_report=None,
1377
                               initial_running_total_quantity=0,
1378
                               initial_running_total_price=0, precision=None,
Romain Courteaud's avatar
Romain Courteaud committed
1379
                               **kw):
1380
      """Returns a list of movements which modify the inventory
1381
      for a single or a group of resource, node, section, etc.
1382 1383 1384
      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
1385
      """
1386
      sql_kw = self._generateSQLKeywordDict(**kw)
Romain Courteaud's avatar
Romain Courteaud committed
1387
      return self.Resource_zGetMovementHistoryList(
1388 1389
                         src__=src__, ignore_variation=ignore_variation,
                         standardise=standardise,
1390
                         omit_simulation=omit_simulation,
Romain Courteaud's avatar
Romain Courteaud committed
1391
                         omit_input=omit_input, omit_output=omit_output,
1392
                         selection_domain=selection_domain,
1393 1394 1395 1396 1397
                         selection_report=selection_report,
                         initial_running_total_quantity=
                                  initial_running_total_quantity,
                         initial_running_total_price=
                                  initial_running_total_price,
1398
                         precision=precision, **sql_kw)
1399

1400
    security.declareProtected(Permissions.AccessContentsInformation,
Romain Courteaud's avatar
Romain Courteaud committed
1401
                              'getMovementHistoryStat')
1402
    def getMovementHistoryStat(self, src__=0, ignore_variation=0,
1403
                               standardise=0, omit_simulation=0, omit_input=0,
1404
                               omit_output=0, selection_domain=None,
1405
                               selection_report=None, precision=None, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1406
      """
Romain Courteaud's avatar
Romain Courteaud committed
1407 1408
      getMovementHistoryStat is the pending to getMovementHistoryList
      for ListBox stat
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1409
      """
1410
      sql_kw = self._generateSQLKeywordDict(**kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1411
      return self.Resource_zGetInventory(src__=src__,
1412
          ignore_variation=ignore_variation, standardise=standardise,
1413
          omit_simulation=omit_simulation, omit_input=omit_input,
1414
          omit_output=omit_output, selection_domain=selection_domain,
1415
          selection_report=selection_report, precision=precision, **sql_kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1416

1417 1418
    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getNextNegativeInventoryDate')
1419
    def getNextNegativeInventoryDate(self, src__=0, **kw):
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1420 1421 1422
      """
      Returns statistics of inventory grouped by section or site
      """
1423 1424 1425
      #sql_kw = self._generateSQLKeywordDict(order_by_expression='stock.date', **kw)
      #sql_kw['group_by_expression'] = 'stock.uid'
      #sql_kw['order_by_expression'] = 'stock.date'
1426

1427
      result = self.getInventoryList(src__=src__,
1428
          sort_on = (('date', 'ascending'),), group_by_movement=1, **kw)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1429 1430
      if src__ :
        return result
1431

1432
      total_inventory = 0.
1433
      for inventory in result:
1434 1435 1436 1437 1438
        if inventory['inventory'] is not None:
          total_inventory += inventory['inventory']
          if total_inventory < 0:
            return inventory['date']

1439
      return None
Alexandre Boeglin's avatar
Alexandre Boeglin committed
1440

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1441
    #######################################################
1442
    # Traceability management
1443
    security.declareProtected(Permissions.AccessContentsInformation, 'getTrackingList')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1444
    def getTrackingList(self, src__=0,
1445 1446
        selection_domain=None, selection_report=None,
        strict_simulation_state=1, **kw) :
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1447
      """
1448
      Returns a list of items in the form
1449

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1450 1451 1452 1453 1454 1455
        uid (of item)
        date
        node_uid
        section_uid
        resource_uid
        variation_text
1456
        delivery_uid
1457

1458 1459 1460 1461 1462 1463 1464 1465
      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
1466 1467

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

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

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

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
      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)
1508
              check what we can do with buildSQLQuery
1509 1510 1511 1512

      Extra parameters for getTrackingList :

      item
1513

1514 1515 1516 1517 1518
      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
1519

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1520
      """
1521
      new_kw = self._generateSQLKeywordDict(table='item',strict_simulation_state=strict_simulation_state,**kw)
1522 1523 1524 1525
      at_date = kw.get('at_date',None)
      if at_date is not None:
        query_mixin = QueryMixin()
        at_date = query_mixin._quoteSQLString(at_date)
1526
        at_date = at_date.strip("'")
1527 1528 1529
      # 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
1530

1531 1532 1533 1534
      # 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')
1535
      new_kw['date_condition_in_join'] = not (new_kw.get('input') or new_kw.get('output'))
1536

1537 1538 1539 1540 1541
      # 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
1542

1543
      return self.Resource_zGetTrackingList(src__=src__,
1544 1545 1546
                                            selection_domain=selection_domain,
                                            selection_report=selection_report,
                                            **new_kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1547 1548 1549 1550 1551 1552

    security.declareProtected(Permissions.AccessContentsInformation, 'getCurrentTrackingList')
    def getCurrentTrackingList(self, **kw):
      """
      Returns list of current inventory grouped by section or site
      """
1553
      kw['item.simulation_state'] = self.getPortalCurrentInventoryStateList()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1554 1555 1556 1557 1558 1559 1560
      return self.getTrackingList(**kw)

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
    #######################################################
    # 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()
1592 1593
      start_date = movement.getStartDate()
      stop_date = movement.getStopDate()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
      # 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.
1731
            if not isinstance(resource_aggregation_base_category, (tuple, list)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
              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
1786 1787
    # Asset Price Calculation
    def updateAssetPrice(self, resource, variation_text, section_category, node_category,
1788 1789 1790
                         strict_membership=0, simulation_state=None):
      if simulation_state is None:
        simulation_state = self.getPortalCurrentInventoryStateList()
1791 1792 1793
      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
1794 1795 1796 1797
      # 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
1798
      brain_list = self.Resource_zGetMovementHistoryList(resource=[resource],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1799 1800 1801 1802
                             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
1803 1804 1805 1806
                             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
1807 1808
        m = b.getObject()
        if m is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
          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(),
1827
                          m.getQuantity(), 'Production or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1828 1829 1830 1831 1832 1833
                        ))
          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(),
1834
                          m.getQuantity(), 'Consumption or Inventory', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1835
                        ))
1836
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and m.getDestinationValue().isAcquiredMemberOf(node_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1837 1838 1839 1840
            # 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(),
1841
                          m.getQuantity(), 'Internal', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1842
                        ))
1843
          elif m.getSourceValue().isAcquiredMemberOf(node_category) and quantity < 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1844 1845 1846 1847
            # 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
1848
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1849
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1850
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1851 1852 1853 1854
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1855
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1856
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1857
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1858
                          ))
1859
            elif m.getDestinationSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1860
              current_inventory += inventory_quantity # Update inventory
1861
              if m.getDestinationValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1862 1863 1864 1865
                # 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(),
1866
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1867
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1868 1869 1870
              else:
                # Inbound from same section
                asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1871
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1872
                              m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1873
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1874
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1875 1876 1877
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1878
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1879
                          ))
1880
          elif m.getDestinationValue().isAcquiredMemberOf(node_category) and quantity > 0:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1881 1882 1883 1884 1885 1886
            # 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(),
1887
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1888 1889 1890 1891
                          ))
            elif m.getDestinationSectionValue() is None:
              # No meaning
              current_inventory += inventory_quantity # Update inventory
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1892
              asset_price = current_asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1893
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1894
                            m.getQuantity(), 'Error', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1895
                          ))
1896
            elif m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1897
              current_inventory += inventory_quantity # Update inventory
1898
              if m.getSourceValue().isAcquiredMemberOf('site/Piquage'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1899 1900 1901 1902
                # 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(),
1903
                              m.getQuantity(), 'Production', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1904
                            ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1905
              else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1906 1907 1908
                # Inbound from same section
                asset_price = current_asset_price
                result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1909
                            m.getQuantity(), 'Inbound same section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1910
                          ))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1911
            else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1912 1913 1914
              current_inventory += inventory_quantity # Update inventory
              asset_price = m.getPrice()
              result.append((m.getRelativeUrl(),m.getStartDate(), m.getSource(), m.getSourceSection(), m.getDestination(), m.getDestinationSection(),
1915
                            m.getQuantity(), 'Inbound different section', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1916 1917 1918 1919 1920 1921
                          ))
          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(),
1922
                            m.getQuantity(), 'Outbound', 'Price: %s' % asset_price
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
                          ))

          # 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
1937
          if m.getSourceSectionValue() is not None and m.getSourceSectionValue().isAcquiredMemberOf(section_category):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1938 1939
            # 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
1940 1941 1942 1943 1944 1945 1946
            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
1947 1948
            # 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
1949 1950 1951 1952 1953
            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)
1954 1955 1956
          # 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
1957
          m.reindexObject()
1958
          #m.activate(priority=7).immediateReindexObject() # Too slow
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1959 1960

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

1962 1963 1964
    # Used for mergeDeliveryList.
    class MergeDeliveryListError(Exception): pass

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
    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:
1976
        raise self.MergeDeliveryListError, "No delivery is passed"
1977
      elif len(delivery_list) == 1:
1978
        raise self.MergeDeliveryListError, "Only one delivery is passed"
1979 1980 1981 1982

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

1983
      # Another sanity check. It is necessary for them to be identical in some attributes.
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
      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:
1994 1995 1996 1997
            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.
1998
      main_discount_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
1999
      for delivery in delivery_list:
2000
        discount_list = delivery.contentValues(filter = {'portal_type': self.getPortalDiscountTypeList()})
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
        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.
2014
      main_payment_condition_list = main_delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
2015
      for delivery in delivery_list:
2016
        payment_condition_list = delivery.contentValues(filter = {'portal_type': self.getPortalPaymentConditionTypeList()})
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
        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())
2030 2031 2032

      # Make sure that all activities are flushed, to get simulation movements from delivery cells.
      for delivery in delivery_list:
2033
        for order in delivery.getCausalityValueList(portal_type = self.getPortalOrderTypeList()):
2034 2035
          for applied_rule in order.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
2036
        for causality_related_delivery in delivery.getCausalityValueList(portal_type = self.getPortalDeliveryTypeList()):
2037 2038
          for applied_rule in causality_related_delivery.getCausalityRelatedValueList(portal_type = 'Applied Rule'):
            applied_rule.flushActivity(invoke = 1)
2039

2040 2041 2042 2043 2044
      # 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[:]
2045
      for delivery in delivery_list:
2046 2047 2048
        simulated_movement_list.extend(delivery.getSimulatedMovementList())
        invoice_movement_list.extend(delivery.getInvoiceMovementList())

2049 2050 2051 2052
      #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())))

2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
      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)
2065 2066 2067 2068 2069 2070 2071 2072 2073
        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)))

2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
        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:
2088 2089
                  if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                    or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
2090 2091 2092 2093 2094
                    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
2095

2096 2097 2098
              if delivery_line is None:
                # Not found. So create a new delivery line.
                movement = base_variant_group.movement_list[0]
2099 2100
                if movement.aq_parent.getPortalType() in self.getPortalSimulatedMovementTypeList() \
                  or movement.aq_parent.getPortalType() in self.getPortalInvoiceMovementTypeList():
2101
                  delivery_line_type = movement.aq_parent.getPortalType()
2102
                else:
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
                  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)

2113
              object_to_update = None
2114 2115 2116 2117 2118 2119
              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()
2120
                    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)))
2121 2122 2123 2124 2125 2126 2127
                    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
2128

2129
                #LOG('mergeDeliveryList', 0, 'object_to_update = %s' % repr(object_to_update))
2130
                if object_to_update is not None:
2131
                  cell_price = object_to_update.getPrice() or 0.0
2132
                  cell_quantity = object_to_update.getQuantity() or 0.0
2133
                  cell_target_quantity = object_to_update.getNetConvertedTargetQuantity() or 0.0 # XXX What to do ?
2134
                  cell_total_price = cell_target_quantity * cell_price
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
                  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
2145 2146
                      cell_price = movement.getPrice()
                      cell_total_price += movement.getNetConvertedTargetQuantity() * cell_price
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2147
                    except TypeError:
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169
                      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

2170
                  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)))
2171
                  object_to_update.setCategoryList(cell_category_list)
2172
                  if object_to_update.getPortalType() in self.getPortalSimulatedMovementTypeList():
2173 2174 2175 2176
                    object_to_update.edit(target_quantity = cell_target_quantity,
                                          quantity = cell_quantity,
                                          price = average_price,
                                          )
2177
                  elif object_to_update.getPortalType() in self.getPortalInvoiceMovementTypeList():
2178 2179 2180 2181 2182 2183 2184
                    # 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()
2185 2186 2187 2188 2189
                else:
                  raise self.MergeDeliveryListError, "No object to update"

      # Merge containers. Just copy them from other deliveries into the main.
      for delivery in delivery_list:
2190
        container_id_list = delivery.contentIds(filter = {'portal_type': self.getPortalContainerTypeList()})
2191 2192 2193
        if len(container_id_list) > 0:
          copy_data = delivery.manage_copyObjects(ids = container_id_list)
          new_id_list = main_delivery.manage_pasteObjects(copy_data)
2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213

      # 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

2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
    #######################################################
    # 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, 
2230 2231
                         portal_type=[], node=[], 
                         resource=[], src__=0, **kw):
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
      """
      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

2244 2245 2246
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
      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()

2258 2259 2260 2261
      simulation_state = self.getPortalCurrentInventoryStateList() + \
                         self.getPortalTransitInventoryStateList() + \
                         self.getPortalReservedInventoryStateList()

2262
      sql_result = self.Person_zGetAvailableTime(
2263 2264 2265 2266
                          from_date=from_date,
                          to_date=to_date,
                          portal_type=portal_type,
                          node=node,
2267
                          resource=resource,
2268
                          simulation_state=simulation_state,
2269 2270
                          src__=src__, **kw)
      if not src__:
2271
        result = 0
2272 2273 2274 2275
        if len(sql_result) == 1:
          result = sql_result[0].total_quantity
      else:
        result = sql_result
2276 2277 2278 2279 2280 2281
      return result

    security.declareProtected(Permissions.AccessContentsInformation, 
                              'getAvailableTimeSequence')
    def getAvailableTimeSequence(self, from_date, to_date,  
                                 portal_type=[], node=[],
2282
                                 resource=[], 
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
                                 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

2295 2296 2297
      resource       - only take rows in stock table which resource_uid is
                       equivalent to resource

2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
      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()

2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320
      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
2321 2322

from Products.ERP5Type.DateUtils import addToDate
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332

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

2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368
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)
2369 2370
      self.item_list.append(SequenceItem(current_from_date, 
                                         current_to_date))
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
      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)
2388 2389
InitializeClass(SequenceItem)
allow_class(SequenceItem)
2390

2391
InitializeClass(SimulationTool)