solver.py 4.83 KB
Newer Older
1 2 3 4 5 6 7
# -*- 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
8
# programmers who take the whole responsibility of assessing all potential
9 10
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
11
# guarantees and support are strongly adviced to contract a Free Software
12 13 14 15 16 17 18 19 20 21 22 23 24 25
# 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
26
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 28 29
#
##############################################################################

30 31
import zope.interface
from AccessControl import ClassSecurityInfo
32
from AccessControl.class_init import InitializeClass
33
from Products.ERP5Type import Permissions, PropertySheet, interfaces
34
from Products.ERP5Type.UnrestrictedMethod import super_user
35 36
from Products.ERP5Type.XMLObject import XMLObject
from Products.ERP5.mixin.configurable import ConfigurableMixin
37

38
class SolverMixin(object):
39
  """
40
  Provides generic methods and helper methods to implement ISolver.
41
  """
42 43 44 45 46 47 48
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  # Declarative interfaces
  zope.interface.implements(interfaces.ISolver,)

49 50 51
  def _solve(self, activate_kw=None):
    raise NotImplementedError

52
  # Implementation of ISolver
53 54 55 56
  security.declarePrivate('solve')
  def solve(self, activate_kw=None):
    with super_user():
      self._solve(activate_kw=activate_kw)
57

58
  def getPortalTypeValue(self):
59
    return self.getPortalObject().portal_solvers._getOb(self.getPortalType())
60 61 62 63 64 65 66 67 68 69 70 71

  def searchDeliverySolverList(self, **kw):
    """
    this method returns a list of delivery solvers

    XXX here we cannot test delivery solver as a predicate, because
    predicate's context should be Solver Decision, not a target
    solver.
    """
    target_solver_type = self.getPortalTypeValue()
    solver_list = target_solver_type.getDeliverySolverValueList()
    return solver_list
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

class ConfigurablePropertySolverMixin(SolverMixin,
                                      ConfigurableMixin,
                                      XMLObject):
  """
  Base class for Target Solvers that can be applied to many
  solver-decisions of a solver process, and need to accumulate the
  tested_property_list configuration among all solver-decisions
  """

  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)

  zope.interface.implements(interfaces.ISolver,
                            interfaces.IConfigurable,)

  # Default Properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.XMLObject
                    , PropertySheet.CategoryCore
                    , PropertySheet.DublinCore
                    , PropertySheet.TargetSolver
                    )

100 101 102 103 104 105 106 107 108 109 110 111 112
  def updateConfiguration(self, **kw):
    # This method is called once for each 'Solver Decision' of a
    # 'Solver Process' that maps into this solver for the same
    # Simulation Movement, so we need to take care not to lose
    # information by overwriting.
    configuration = self._getConfigurationPropertyDict()
    tested_property_list = configuration.get('tested_property_list')
    if tested_property_list is not None:
      tested_property_set = set(tested_property_list)
      tested_property_set.update(kw.get('tested_property_list', ()))
      kw['tested_property_list'] = list(tested_property_set)
    super(ConfigurablePropertySolverMixin, self).updateConfiguration(**kw)

113 114 115 116 117 118 119
  def getTestedPropertyList(self):
    configuration_dict = self.getConfigurationPropertyDict()
    tested_property_list = configuration_dict.get('tested_property_list')
    if tested_property_list is None:
      portal_type = self.getPortalObject().portal_types.getTypeInfo(self)
      tested_property_list = portal_type.getTestedPropertyList()
    return tested_property_list
120 121

InitializeClass(SolverMixin)