Predicate.py 13.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# 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.
#
##############################################################################

Jean-Paul Smets's avatar
Jean-Paul Smets committed
29
from Globals import InitializeClass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30
from AccessControl import ClassSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
31 32
from Acquisition import aq_base, aq_inner

Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
Jean-Paul Smets's avatar
Jean-Paul Smets committed
34 35 36 37 38 39
from Products.ERP5Type.Document.Folder import Folder
from Products.ERP5Type.Document import newTempBase
from Products.CMFCore.utils import getToolByName

from Products.ERP5Type.Utils import convertToUpperCase

40 41
from string import join,replace

Jean-Paul Smets's avatar
Jean-Paul Smets committed
42
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
43

Jean-Paul Smets's avatar
Jean-Paul Smets committed
44
class Predicate(Folder):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
46
    A predicate group allows to combine simple predicates
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47
  """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48 49 50 51 52 53 54
  meta_type = 'ERP5 Predicate'
  portal_type = 'Predicate'
  add_permission = Permissions.AddPortalContent
  isPortalContent = 1
  isRADContent = 1
  isPredicate = 1
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
55 56 57 58
  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.View)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61 62 63 64 65 66 67
  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.Predicate
                    , PropertySheet.SortIndex
                    )

  # Declarative interfaces
  __implements__ = ( Interface.Predicate )

68
  def test(self, context, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69 70 71 72 73 74 75 76 77 78
    """
      A Predicate can be tested on a given context

      We can pass parameters in order to ignore some conditions.
    """
    self = self.asPredicate()
    result = 1
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
      self._range_criterion = {}
79
    # LOG('PREDICATE TEST', 0, 'testing %s on context of %s' % (self.getRelativeUrl(), context.getRelativeUrl()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
80 81
    for property, value in self._identity_criterion.items():
      result = result and (context.getProperty(property) == value)
82
      # LOG('predicate test', 0, '%s after prop %s : %s == %s' % (result, property, context.getProperty(property), value))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
83 84 85 86
    for property, (min, max) in self._range_criterion.items():
      value = context.getProperty(property)
      if min is not None:
        result = result and (value >= min)
87
        # LOG('predicate test', 0, '%s after prop %s : %s >= %s' % (result, property, value, min))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
88 89
      if max is not None:
        result = result and (value < max)
90
        # LOG('predicate test', 0, '%s after prop %s : %s < %s' % (result, property, value, max))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
91 92 93
    multimembership_criterion_base_category_list = self.getMultimembershipCriterionBaseCategoryList()
    membership_criterion_base_category_list = self.getMembershipCriterionBaseCategoryList()
    tested_base_category = {}
94
    # LOG('predicate test', 0, 'categories will be tested in multi %s single %s as %s' % (multimembership_criterion_base_category_list, membership_criterion_base_category_list, self.getMembershipCriterionCategoryList()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
95 96 97 98 99 100 101 102
    for c in self.getMembershipCriterionCategoryList():
      bc = c.split('/')[0]
      if not bc in tested_base_category.keys() and bc in multimembership_criterion_base_category_list:
        tested_base_category[bc] = 1
      elif not bc in tested_base_category.keys() and bc in membership_criterion_base_category_list:
        tested_base_category[bc] = 0
      if bc in multimembership_criterion_base_category_list:
        tested_base_category[bc] = tested_base_category[bc] and context.isMemberOf(c)
103
        # LOG('predicate test', 0, '%s after multi membership to %s' % (tested_base_category[bc], c))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
104 105
      elif bc in membership_criterion_base_category_list:
        tested_base_category[bc] = tested_base_category[bc] or context.isMemberOf(c)
106
        # LOG('predicate test', 0, '%s after single membership to %s' % (tested_base_category[bc], c))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
107
    result = result and (0 not in tested_base_category.values())
108
    # LOG('predicate test', 0, '%s after category %s ' % (result, tested_base_category.items()))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
109 110 111 112 113
    # Test method calls
    test_method_id = self.getTestMethodId()
    if test_method_id is not None and result:
      method = getattr(context,test_method_id)
      result = result and method()
114
    # LOG('predicate test', 0, '%s after method %s ' % (result, test_method_id))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
115 116 117 118 119 120 121 122 123 124 125
    # XXX Add here additional method calls
    return result

  def asPythonExpression():
    """
      A Predicate can be rendered as a python expression. This
      is the preferred approach within Zope.
    """
    pass

  def asSqlExpression():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
126
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127 128
      A Predicate can be rendered as a python expression. This
      is the preferred approach within Zope.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
129
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
130
    pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131

Jean-Paul Smets's avatar
Jean-Paul Smets committed
132 133
  security.declareProtected( Permissions.AccessContentsInformation, 'getCriterionList' )
  def getCriterionList(self, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
134
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
135
      Returns a list of criterion
Jean-Paul Smets's avatar
Jean-Paul Smets committed
136
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
      self._range_criterion = {}
    criterion_dict = {}
    for p in self.getCriterionPropertyList():
      criterion_dict[p] = newTempBase(self, 'new_%s' % p)
      criterion_dict[p].identity = self._identity_criterion.get(p, None)
      criterion_dict[p].uid = 'new_%s' % p
      criterion_dict[p].property = p
      criterion_dict[p].min = self._range_criterion.get(p, (None, None))[0]
      criterion_dict[p].max = self._range_criterion.get(p, (None, None))[1]
    criterion_list = criterion_dict.values()
    criterion_list.sort()
    return criterion_list

  security.declareProtected( Permissions.ModifyPortalContent, 'setCriterion' )
  def setCriterion(self, property, identity=None, min=None, max=None, **kw):
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
      self._range_criterion = {}
    if identity != None :
      self._identity_criterion[property] = identity
    if min != '' or max != '' :
      self._range_criterion[property] = (min, max)
    self.reindexObject()

  security.declareProtected( Permissions.ModifyPortalContent, 'edit' )
  def edit(self, **kwd) :
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
      self._range_criterion = {}
    if 'criterion_property_list' in kwd.keys() :
      criterion_property_list = kwd['criterion_property_list']
      identity_criterion = {}
      range_criterion = {}
      for criterion in self._identity_criterion.keys() :
        if criterion in criterion_property_list :
          identity_criterion[criterion] = self._identity_criterion[criterion]
      for criterion in self._range_criterion.keys() :
        if criterion in criterion_property_list :
          range_criterion[criterion] = self._range_criterion[criterion]
      self._identity_criterion = identity_criterion
      self._range_criterion = range_criterion
    return self._edit(**kwd)

  # Predicate fusion method
  def setPredicateCategoryList(self, category_list):
    category_tool = aq_inner(self.portal_categories)
    base_category_id_list = category_tool.objectIds()
    membership_criterion_category_list = []
    membership_criterion_base_category_list = []
    multimembership_criterion_base_category_list = []
    test_method_id_list = []
    criterion_property_list = []
    for c in category_list:
      bc = c.split('/')[0]
      if bc in base_category_id_list:
        # This is a category
        membership_criterion_category_list.append(c)
        membership_criterion_base_category_list.append(bc)
      else:
        predicate_value = category_tool.resolveCategory(c)
        if predicate_value is not None:
          criterion_property_list.extend(predicate_value.getCriterionPropertyList())
          membership_criterion_category_list.extend(
                      predicate_value.getMembershipCriterionCategoryList())
          membership_criterion_base_category_list.extend(
                      predicate_value.getMembershipCriterionBaseCategoryList())
          multimembership_criterion_base_category_list.extend(
                      predicate_value.getMultimembershipCriterionBaseCategoryList())
          test_method_id_list += list(predicate_value.getTestMethodIdList() or [])
          for p in predicate_value.getCriterionList():
            self.setCriterion(p.property, identity=p.identity, min=p.min, max=p.max)
    self.setCriterionPropertyList(criterion_property_list)
    self._setMembershipCriterionCategoryList(membership_criterion_category_list)
    self._setMembershipCriterionBaseCategoryList(membership_criterion_base_category_list)
    self._setMultimembershipCriterionBaseCategoryList(multimembership_criterion_base_category_list)
    self._setTestMethodIdList(test_method_id_list)    
    self.reindexObject()

217 218 219
  def generatePredicate(self,multimembership_criterion_base_category_list=(),
                        membership_criterion_base_category_list=(),
                        criterion_property_list=()):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
220
    """
221 222 223 224
    This generate a new temporary predicate based on local properties

    It can be used in a script called PortalType_asPredicate if we only
    want to create a new predicate with local properties.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
225
    """
226 227 228
    new_membership_criterion_category_list = list(self.getMembershipCriterionCategoryList())
    new_multimembership_criterion_base_category_list = list(self.getMultimembershipCriterionBaseCategoryList())
    for base_category in multimembership_criterion_base_category_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
229 230 231
      category_list = self.getProperty(base_category + '_list')
      if category_list is not None and len(category_list)>0:
        for category in category_list:
232
          new_membership_criterion_category_list.append(base_category + '/' + category)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
233
        if base_category not in multimembership_criterion_base_category_list:
234 235 236 237 238 239 240 241 242
          new_multimembership_criterion_base_category_list.append(base_category)
    for base_category in membership_criterion_base_category_list:
      category_list = self.getProperty(base_category + '_list')
      if category_list is not None and len(category_list)>0:
        for category in category_list:
          new_membership_criterion_category_list.append(base_category + '/' + category)
        if base_category not in membership_criterion_base_category_list:
          new_membership_criterion_base_category_list.append(base_category)
    new_criterion_property_list =  list(self.getCriterionPropertyList())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
243 244 245
    identity_criterion = getattr(self,'_identity_criterion',{})
    range_criterion = getattr(self,'_range_criterion',{})
    # Look at local properties and make it criterion properties
246
    for property in criterion_property_list:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
247 248
      if property not in self.getCriterionPropertyList() \
        and property in self.propertyIds():
249
          new_criterion_property_list.append(property)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
250 251 252 253 254 255 256 257 258 259 260 261
          property_min = property + '_range_min'
          property_max = property + '_range_max'
          if hasattr(self,'get%s' % convertToUpperCase(property)) \
            and self.getProperty(property) is not None:
            identity_criterion[property] = self.getProperty(property)
          elif hasattr(self,'get%s' % convertToUpperCase(property_min)):
            min = self.getProperty(property_min)
            max = self.getProperty(property_max)
            range_criterion[property] = (min,max)
    # Return a new context with new properties, like if
    # we have a predicate with local properties
    new_self = self.asContext(
262 263 264
        membership_criterion_category=new_membership_criterion_category_list,
        multimembership_criterion_base_category=new_multimembership_criterion_base_category_list,
        criterion_property_list=new_criterion_property_list,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
265 266 267
        _identity_criterion=identity_criterion,
        _range_criterion=range_criterion)

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
    return new_self

  # Predicate handling
  security.declareProtected(Permissions.AccessContentsInformation, 'asPredicate')
  def asPredicate(self,script_id=None):
    """
    We will look if we can find a script in order to generate
    a new predicate.
    """
    category_tool = getToolByName(self,'portal_categories')
    # Look at local and acquired categories and make it criterion membership
    script_name = ''
    script = None
    script_name_end = '_asPredicate'
    # Look at a local script which
    # can return a new predicate.
    if script_id is not None:
      script = getattr(self, script_id)
    else:
      for script_name_begin in [self.getPortalType(), self.getMetaType(), self.__class__.__name__]:
        script_name = join( [ replace(script_name_begin, ' ','') , script_name_end ], '')
        if hasattr(self, script_name):
          script = getattr(self, script_name)
          break
    new_self = self
    if script is not None:
      new_self = script()

Jean-Paul Smets's avatar
Jean-Paul Smets committed
296 297 298 299 300 301 302
    return new_self

# Just for compatibility    
class PredicateGroup(Predicate):
  meta_type = 'ERP5 Predicate Group'
  portal_type = 'Predicate Group'