PredicateGroup.py 12.9 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 29 30
#
# 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.
#
##############################################################################

from Globals import InitializeClass
from AccessControl import ClassSecurityInfo
Sebastien Robin's avatar
Sebastien Robin committed
31
from Acquisition import aq_base, aq_inner
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33 34

from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
from Products.ERP5Type.Document.Folder import Folder
35
from Products.ERP5Type.Document import newTempBase
36 37 38
from Products.CMFCore.utils import getToolByName

from Products.ERP5Type.Utils import convertToUpperCase
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39

40
from Products.ERP5.Document.Predicate import Predicate
Sebastien Robin's avatar
Sebastien Robin committed
41
from zLOG import LOG
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46 47 48

class PredicateGroup(Folder, Predicate):
  """
    A predicate group allows to combine simple predicates
  """
  meta_type = 'ERP5 Predicate Group'
  portal_type = 'Predicate Group'
49
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51
  isPortalContent = 1
  isRADContent = 1
52
  isPredicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 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

  _operators = (
    {
      'id':               'AND',
      'title':            'And',
      'description':      'All predicates must be true',
      'sql_operator':     '=',
      'python_operator':  '==',
    },
    {
      'id':               'OR',
      'title':            'OR',
      'description':      'Some predicate must be true',
      'sql_operator':     '<>',
      'python_operator':  '!=',
    },
    {
      'id':               'NOR',
      'title':            'NOR',
      'description':      'All predicates must be false',
      'sql_operator':     '>',
      'python_operator':  '>',
    },
    {
      'id':               'NAND',
      'title':            'NAND',
      'description':      'Some predicate must be false',
      'sql_operator':     '<',
      'python_operator':  '<',
    },
    {
      'id':               'XOR',
      'title':            'XOR',
      'description':      'Only one predicate can be true',
      'sql_operator':     '>=',
      'python_operator':  '>=',
    },
  )

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

  # Declarative properties
  property_sheets = ( PropertySheet.Base
                    , PropertySheet.Predicate
Alexandre Boeglin's avatar
Alexandre Boeglin committed
99
                    , PropertySheet.SortIndex
Jean-Paul Smets's avatar
Jean-Paul Smets committed
100 101 102 103 104
                    )

  # Declarative interfaces
  __implements__ = ( Interface.Predicate )

105
  def test(self, context,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
106 107
    """
      A Predicate can be tested on a given context
108 109

      We can pass parameters in order to ignore some conditions.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
110
    """
111
    self = self.asPredicate()
112 113 114
    result = 1
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
Alexandre Boeglin's avatar
Alexandre Boeglin committed
115
      self._range_criterion = {}
116 117
    for property, value in self._identity_criterion.items():
      result = result and (context.getProperty(property) == value)
118
      #LOG('context.getProperty', 0, repr(( result, property, context.getProperty(property), value )))
119 120 121 122
    for property, (min, max) in self._range_criterion.items():
      value = context.getProperty(property)
      if min is not None:
        result = result and (value >= min)
123
        #LOG('self._range_criterion.items min', 0, repr(( result, property, context.getProperty(property), min )))
124 125
      if max is not None:
        result = result and (value < max)
126
        #LOG('self._range_criterion.items max', 0, repr(( result, property, context.getProperty(property), max )))
127 128 129 130 131
    multimembership_criterion_base_category_list = self.getMultimembershipCriterionBaseCategoryList()
    membership_criterion_base_category_list = self.getMembershipCriterionBaseCategoryList()
    tested_base_category = {}
    for c in self.getMembershipCriterionCategoryList():
      bc = c.split('/')[0]
132 133 134
      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:
135 136 137 138
        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)
      elif bc in membership_criterion_base_category_list:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
139
        tested_base_category[bc] = tested_base_category[bc] or context.isMemberOf(c)
140
    result = result and (0 not in tested_base_category.values())
141
    #LOG('self.getMembershipCriterionCategoryList', 0, repr(( result, tested_base_category.items() )))
142 143 144
    # Test method calls
    test_method_id = self.getTestMethodId()
    if test_method_id is not None and result:
145
      method = getattr(context,test_method_id)
146
      result = result and method()
147
      #LOG('self.getTestMethodId', 0, repr(( result, test_method_id, method() )))
Alexandre Boeglin's avatar
Alexandre Boeglin committed
148
    # XXX Add here additional method calls
149
    return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

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

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

165 166 167 168 169 170 171
  security.declareProtected( Permissions.AccessContentsInformation, 'getCriterionList' )
  def getCriterionList(self, **kw):
    """
      Returns a list of criterion
    """
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
Alexandre Boeglin's avatar
Alexandre Boeglin committed
172
      self._range_criterion = {}
173 174 175 176 177 178 179 180 181 182 183
    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
Alexandre Boeglin's avatar
Alexandre Boeglin committed
184

185
  security.declareProtected( Permissions.ModifyPortalContent, 'setCriterion' )
186 187 188
  def setCriterion(self, property, identity=None, min=None, max=None, **kw):
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
Alexandre Boeglin's avatar
Alexandre Boeglin committed
189
      self._range_criterion = {}
190
    if identity != None :
191 192 193
      self._identity_criterion[property] = identity
    if min != '' or max != '' :
      self._range_criterion[property] = (min, max)
194
    self.reindexObject()
195 196 197

  security.declareProtected( Permissions.ModifyPortalContent, 'edit' )
  def edit(self, **kwd) :
198 199 200
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
      self._range_criterion = {}
201 202 203 204 205 206 207 208 209 210 211 212 213
    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)
Alexandre Boeglin's avatar
Alexandre Boeglin committed
214

215 216
  # Predicate fusion method
  def setPredicateCategoryList(self, category_list):
Sebastien Robin's avatar
Sebastien Robin committed
217
    category_tool = aq_inner(self.portal_categories)
218 219 220 221
    base_category_id_list = category_tool.objectIds()
    membership_criterion_category_list = []
    membership_criterion_base_category_list = []
    multimembership_criterion_base_category_list = []
222
    test_method_id_list = []
223
    criterion_property_list = []
Alexandre Boeglin's avatar
Alexandre Boeglin committed
224
    for c in category_list:
225 226 227 228 229 230 231
      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)
Sebastien Robin's avatar
Sebastien Robin committed
232
        if predicate_value is not None:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
233
          criterion_property_list.extend(predicate_value.getCriterionPropertyList())
234 235 236 237 238 239
          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())
240
          test_method_id_list += list(predicate_value.getTestMethodIdList() or [])
241 242
          for p in predicate_value.getCriterionList():
            self.setCriterion(p.property, identity=p.identity, min=p.min, max=p.max)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
243
    self.setCriterionPropertyList(criterion_property_list)
244 245 246 247
    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)    
Sebastien Robin's avatar
Sebastien Robin committed
248
    self.reindexObject()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
249 250

  # Predicate handling
Jean-Paul Smets's avatar
Jean-Paul Smets committed
251 252 253 254 255
  security.declareProtected(Permissions.AccessContentsInformation, 'asPredicate')
  def asPredicate(self):
    """
    Returns a temporary Predicate based on the Resource properties
    """
256 257 258
    category_tool = getToolByName(self,'portal_categories')
    membership_criterion_category_list = list(self.getMembershipCriterionCategoryList())
    multimembership_criterion_base_category_list = list(self.getMultimembershipCriterionBaseCategoryList())
259 260 261 262 263 264 265
    # Look at local and acquired categories and make it criterion membership
    for base_category in self.getPortalCriterionBaseCategoryList():
      category_list = self.getProperty(base_category + '_list')
      if category_list is not None and len(category_list)>0:
        for category in category_list:
          membership_criterion_category_list.append(base_category + '/' + category)
        if base_category not in multimembership_criterion_base_category_list:
266 267 268 269 270
          multimembership_criterion_base_category_list.append(base_category)
    criterion_property_list =  list(self.getCriterionPropertyList())
    identity_criterion = getattr(self,'_identity_criterion',{})
    range_criterion = getattr(self,'_range_criterion',{})
    # Look at local properties and make it criterion properties
271
    for property in self.getPortalCriterionPropertyList():
272 273 274 275 276 277 278
      if property not in self.getCriterionPropertyList() \
        and property in self.propertyIds():
          criterion_property_list.append(property)
          property_min = property + '_range_min'
          property_max = property + '_range_max'
          if hasattr(self,'get%s' % convertToUpperCase(property)) \
            and self.getProperty(property) is not None:
279
            identity_criterion[property] = self.getProperty(property)
280 281 282 283 284 285 286 287 288 289 290 291 292
          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(
        membership_criterion_category=membership_criterion_category_list,
        multimembership_criterion_base_category=multimembership_criterion_base_category_list,
        criterion_property_list=criterion_property_list,
        _identity_criterion=identity_criterion,
        _range_criterion=range_criterion)

Romain Courteaud's avatar
Romain Courteaud committed
293 294 295
#     LOG('PredicateGroup.asPredicate, new_self.getMembershipCriterionCategoryList',0,new_self.getMembershipCriterionCategoryList())
#     LOG('PredicateGroup.asPredicate, new_self.getMultiMembershipCriterionBaseCategoryList',0,new_self.getMultimembershipCriterionBaseCategoryList())
#     LOG('PredicateGroup.asPredicate, new_self.__class__',0,new_self.__class__)
296 297 298 299
    return new_self



Jean-Paul Smets's avatar
Jean-Paul Smets committed
300