document.erp5.SolverProcess.py 14.1 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# 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.
#
##############################################################################

import zope.interface
from AccessControl import ClassSecurityInfo
32
from Products.ERP5Type import Permissions, PropertySheet
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33 34
from Products.ERP5Type.XMLObject import XMLObject
from Products.CMFActivity.ActiveProcess import ActiveProcess
35
from Products.ERP5Type.UnrestrictedMethod import UnrestrictedMethod
36
from erp5.component.interface.IMovement import IMovement
37 38
from erp5.component.interface.ISolver import ISolver
from erp5.component.interface.IConfigurable import IConfigurable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39

40 41
@zope.interface.implementer(ISolver,
                            IConfigurable,)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46 47 48 49 50 51 52 53 54
class SolverProcess(XMLObject, ActiveProcess):
  """
    Solver Process class represents the decision of the user
    to solve a divergence. The data structure is the following:

    Solver Process can contain:

    - Solver Decision documents which represent the decision
      of the user to solve a divergence on a given Delivery Line
      by using a certain heuristic

    - Target Solver documents which encapsulate the resolution
      heuristic in relation with DivergenceTester (ie. each
55
      DivergenceTester must provide a list of Target Solver portal
Jean-Paul Smets's avatar
Jean-Paul Smets committed
56 57 58 59 60
      types whch are suitable to solve a given divergence) and
      which may eventually use a Delivery Solver each time divergence
      is related to quantities.

    Every Simulation Movement affected by a Solver Process has a relation
61
    to the solver process through the "solver" base category.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
  """
  meta_type = 'ERP5 Solver Process'
  portal_type = 'Solver Process'
  add_permission = Permissions.AddPortalContent
  isIndexable = 0 # We do not want to fill the catalog with objects on which we need no reporting

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
Jean-Paul Smets's avatar
Jean-Paul Smets committed
77 78
                    )

79
  # Implementation
80
  security.declareProtected(Permissions.ModifyPortalContent, 'buildTargetSolverList')
81
  @UnrestrictedMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
82 83 84 85 86
  def buildTargetSolverList(self):
    """
      Builds target solvers from solver decisions
    """
    movement_dict = {}
87
    message_list = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
88

89
    # First create a mapping between simulation movements and solvers
Jean-Paul Smets's avatar
Jean-Paul Smets committed
90 91
    #   in order to know for each movements which solvers are needed
    #   and which parameters with
92 93 94 95 96
    #
    #   movement_dict[movement] = {
    #              solver : [((c1, v1), (c2, v2 )),
    #                        ((c1, v1), (c2, v2 )),
    #                       ],
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
97
    for decision in self.contentValues(portal_type="Solver Decision"):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98
      solver = decision.getSolverValue()
99 100 101
      # do nothing if solver is not yet set.
      if solver is None:
        continue
Jean-Paul Smets's avatar
Jean-Paul Smets committed
102
      solver_conviguration_dict = decision.getConfigurationPropertyDict()
103 104 105
      configuration_mapping = solver_conviguration_dict.items()
      configuration_mapping.sort() # Make sure the list is sorted in canonical way
      configuration_mapping = tuple(configuration_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
106 107
      for movement in decision.getDeliveryValueList():
        # Detect incompatibilities
108 109 110 111
        movement_solver_dict = movement_dict.setdefault(movement, {})
        movement_solver_configuration_list = movement_solver_dict.setdefault(solver, [])
        if configuration_mapping not in movement_solver_configuration_list:
          movement_solver_configuration_list.append(configuration_mapping)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
112

113
    # Second, create a mapping between solvers and movements
114 115 116 117 118 119 120 121
    # and their configuration
    #
    #   solver_dict[solver] = {
    #     movement : [((c1, v1), (c2, v2 )),
    #                 ((c1, v1), (c2, v2 )),
    #                ],
    #   }
    #
Jean-Paul Smets's avatar
Jean-Paul Smets committed
122
    solver_dict = {}
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
    for movement, movement_solver_dict in movement_dict.items():
      for solver, movement_solver_configuration_list in movement_solver_dict.items():
        solver_movement_dict = solver_dict.setdefault(solver, {})
        solver_movement_dict[movement] = movement_solver_configuration_list

    # Third, group solver configurations and make sure solvers do not conflict
    # by creating a mapping between solvers and movement configuration grouped
    # by a key which is used to aggregate multiple configurations
    #
    #   grouped_solver_dict[solver] = {
    #     solver_key: {
    #        movement : [((c1, v1), (c2, v2 )),
    #                    ((c1, v1), (c2, v2 )),
    #                   ],
    #          }
    #   }
    grouped_solver_dict = {}
    for movement, movement_solver_dict in movement_dict.items():
      for solver, movement_solver_configuration_list in movement_solver_dict.items():
        for configuration_mapping in movement_solver_configuration_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
143
          # Detect conflicts. This includes finding out that a solver which
144
          # is exclusive per movement, conflicts with another solver on the same
Jean-Paul Smets's avatar
Jean-Paul Smets committed
145
          # movement
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
146
          solver_message_list = solver.getSolverConflictMessageList(movement, configuration_mapping, solver_dict, movement_dict)
147 148 149
          if solver_message_list:
            message_list.extend(solver_message_list)
            continue # No need to keep on
Jean-Paul Smets's avatar
Jean-Paul Smets committed
150 151
          # Solver key contains only those properties which differentiate
          # solvers (ex. there should be only Production Reduction Solver)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
152
          solver_key = solver.getSolverProcessGroupingKey(movement, configuration_mapping, solver_dict, movement_dict)
153 154
          solver_key_dict = grouped_solver_dict.setdefault(solver, {})
          solver_movement_dict = solver_key_dict.setdefault(solver_key, {})
155
          movement_solver_configuration_list = solver_movement_dict.setdefault(movement, [])
156 157 158
          if configuration_mapping not in movement_solver_configuration_list:
            movement_solver_configuration_list.append(configuration_mapping)

159 160 161
    # If conflicts where detected, return them and do nothing
    if message_list:
      return message_list
162 163 164

    # Fourth, build target solvers
    for solver, solver_key_dict in grouped_solver_dict.items():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
165
      for solver_key, solver_movement_dict in solver_key_dict.items():
Nicolas Delaby's avatar
Nicolas Delaby committed
166 167 168 169 170 171
        solver_instance = self.newContent(portal_type=solver.getId())
        solver_instance._setDeliveryValueList(solver_movement_dict.keys())
        for movement, configuration_list in solver_movement_dict.iteritems():
          for configuration_mapping in configuration_list:
            if len(configuration_mapping):
              solver_instance.updateConfiguration(**dict(configuration_mapping))
172 173 174

    # Return empty list of conflicts
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
175

176
  # ISolver implementation
177
  # Solver Process Workflow Interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178
  #  NOTE: how can we consider that a workflow defines or provides an interface ?
179
  security.declareProtected(Permissions.ModifyPortalContent, 'solve')
180
  def solve(self, activate_kw=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
181 182 183
    """
      Start solving
    """
184 185 186
    portal = self.getPortalObject()
    isTransitionPossible = portal.portal_workflow.isTransitionPossible
    for solver in self.objectValues(portal_type=portal.getPortalTargetSolverTypeList()):
187
      if solver.isTempObject():
188
        solver_type = solver.getPortalTypeValue()
189 190 191
        # Since multiple documents may need the same solver, activity must be
        # executed individually. Thus SQLQueue is needed.
        solver_type.activate(activity='SQLQueue', activate_kw=activate_kw).solve(
192 193 194 195 196 197 198
          activate_kw=activate_kw,
          delivery_list=solver.getDeliveryList(),
          configuration_dict=solver.getConfigurationPropertyDict()
          )
      else:
        if isTransitionPossible(solver, 'start_solving'):
          solver.startSolving()
199 200
        # SQLQueue is needed for the same reason.
        solver.activate(activity='SQLQueue', active_process=self, activate_kw=activate_kw).solve(
201
          activate_kw=activate_kw)
202 203

  # API
204 205
  security.declareProtected(Permissions.AccessContentsInformation,
                            'isSolverDecisionListConsistent')
206 207
  def isSolverDecisionListConsistent(self):
    """
208
    Returns True is the Solver Process decisions do not
209 210 211 212 213
    need to be rebuilt, False else. This method can be
    invoked before invoking buildSolverDecisionList if
    this helps reducing CPU time.
    """

214 215
  security.declareProtected(Permissions.ModifyPortalContent,
                            'buildSolverDecisionList')
216
  def buildSolverDecisionList(self, delivery_or_movement=None):
217 218 219
    """
    Build (or rebuild) the solver decisions in the solver process

220
    delivery_or_movement -- a movement, a delivery,
221 222 223 224 225 226 227
                            or a list thereof
    """
    if delivery_or_movement is None:
      raise NotImplementedError
      # Gather all delivery lines already found
      # in already built solvers

228 229 230
    if not isinstance(delivery_or_movement, (tuple, list)):
      delivery_or_movement = [delivery_or_movement]
    movement_list = []
231
    isMovement = IMovement.providedBy
232
    for x in delivery_or_movement:
233
      if isMovement(x):
234
        movement_list.append(x)
235 236
      else:
        movement_list.extend(x.getMovementList())
237 238

    # We suppose here that movement_list is a list of
239
    # delivery movements. Let us group decisions in such way
240
    # that a single decision is created per divergence tester instance
241 242
    # and per application level list and per available target solver
    # list
243
    solver_tool = self.getPortalObject().portal_solvers
244
    solver_decision_dict = {}
245
    for movement in movement_list:
246
      for simulation_movement in movement.getDeliveryRelatedValueList():
247
        for divergence_tester in simulation_movement.getParentValue().getSpecialiseValue()._getDivergenceTesterList(exclude_quantity=False):
248 249 250
          if divergence_tester.test(simulation_movement):
            if divergence_tester.explain(simulation_movement) in (None, []):
              continue
251 252 253
            application_list = [
              x.getRelativeUrl()
              for x in solver_tool.getSolverDecisionApplicationValueList(movement, divergence_tester)]
254 255 256 257 258 259 260
            application_list.sort()
            solver_list = solver_tool.searchTargetSolverList(
              divergence_tester, simulation_movement)
            solver_list.sort(key=lambda x:x.getId())
            solver_decision_key = (divergence_tester.getRelativeUrl(), tuple(application_list), tuple(solver_list))
            movement_dict = solver_decision_dict.setdefault(solver_decision_key, {})
            movement_dict[simulation_movement] = None
261 262 263

    # Now build the solver decision instances based on the previous
    # grouping
264
    solver_decision_list = self.objectValues(portal_type='Solver Decision')
265
    unmatched_solver_decision_list = set(solver_decision_list)
266
    for solver_decision_key, movement_dict in solver_decision_dict.items():
267
      causality, _, solver_list = solver_decision_key
268 269
      movement_url_list = [x.getRelativeUrl() for x in movement_dict.keys()]
      movement_url_list.sort()
270 271
      matched_solver_decision_list = [
        x for x in solver_decision_list \
272
        if sorted(x.getDeliveryList()) == movement_url_list and \
273
        x.getCausality() == causality]
274
      unmatched_solver_decision_list.difference_update(matched_solver_decision_list)
275 276
      if len(matched_solver_decision_list) > 0:
        solver_decision_list.remove(matched_solver_decision_list[0])
277
      else:
278
        new_decision = self.newContent(portal_type='Solver Decision')
279
        new_decision._setDeliveryList(movement_url_list)
280
        new_decision._setCausality(solver_decision_key[0])
281 282
        # If we have only one available automatic solver, we just use it
        # automatically.
283
        automatic_solver_list = [x for x in solver_list if x.isAutomaticSolver()]
284 285 286 287 288 289
        if len(automatic_solver_list) == 1:
          automatic_solver = automatic_solver_list[0]
          new_decision.setSolverValue(automatic_solver)
          new_decision.updateConfiguration(
            **automatic_solver.getDefaultConfigurationPropertyDict(
            new_decision))
290 291 292 293
        # XXX We need a relation between Simulation Movement and Solver
        # Process, but ideally, the relation should be created when a
        # Target Solver processes, not when a Solver Decision is
        # created.
294 295 296 297 298
        # for simulation_movement in movement_dict.keys():
        #   solver_list = simulation_movement.getSolverValueList()
        #   if self not in solver_list:
        #     simulation_movement.setSolverValueList(
        #       solver_list + [self])
299 300 301 302 303 304 305


    # delete non-matched existing solver decisions, unless they have been
    # solved already (we detect this by the fact that the solver decision is
    # associated to a target solver)
    self.manage_delObjects(ids=[x.getId() for x in
          unmatched_solver_decision_list if not x.getCausality()])
306 307 308 309 310 311

  def _generateRandomId(self):
    # call ActiveProcess._generateRandomId() explicitly otherwise
    # Folder._generateRandomId() will be called and it returns 'str' not
    # 'int' id.
    return ActiveProcess._generateRandomId(self)