PredicateGroup.py 9.86 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
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36

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

class PredicateGroup(Folder, Predicate):
  """
    A predicate group allows to combine simple predicates
  """
  meta_type = 'ERP5 Predicate Group'
  portal_type = 'Predicate Group'
46
  add_permission = Permissions.AddPortalContent
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47 48
  isPortalContent = 1
  isRADContent = 1
49
  is_predicate = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51 52 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

  _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
96
                    , PropertySheet.SortIndex
Jean-Paul Smets's avatar
Jean-Paul Smets committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
                    )

  # Declarative interfaces
  __implements__ = ( Interface.Predicate )

  # Factory Type Information
  factory_type_information = \
    {    'id'             : portal_type
       , 'meta_type'      : meta_type
       , 'description'    : """\
A bank account number holds a collection of numbers
and codes (ex. SWIFT, RIB, etc.) which may be used to
identify a bank account."""
       , 'icon'           : 'predicate_icon.gif'
       , 'product'        : 'ERP5'
       , 'factory'        : 'addPredicateGroup'
       , 'immediate_view' : 'predicate_view'
       , 'actions'        :
      ( { 'id'            : 'view'
        , 'name'          : 'View'
        , 'category'      : 'object_view'
        , 'action'        : 'predicate_view'
        , 'permissions'   : (
            Permissions.View, )
        }
        ,
      )
    }

  def test(self, context):
    """
      A Predicate can be tested on a given context
    """
130 131 132
    result = 1
    if not hasattr(aq_base(self), '_identity_criterion'):
      self._identity_criterion = {}
Alexandre Boeglin's avatar
Alexandre Boeglin committed
133
      self._range_criterion = {}
134 135 136 137 138 139 140 141 142 143 144 145 146
    for property, value in self._identity_criterion.items():
      result = result and (context.getProperty(property) == value)
    for property, (min, max) in self._range_criterion.items():
      value = context.getProperty(property)
      if min is not None:
        result = result and (value >= min)
      if max is not None:
        result = result and (value < max)
    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]
Alexandre Boeglin's avatar
Alexandre Boeglin committed
147
      if not bc in tested_base_category.keys() :
148 149 150 151
        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
152
        tested_base_category[bc] = tested_base_category[bc] or context.isMemberOf(c)
153 154 155 156
    result = result and (0 not in tested_base_category.values())
    # Test method calls
    test_method_id = self.getTestMethodId()
    if test_method_id is not None and result:
157
      method = getattr(context,method)
158
      result = result and method()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
159
    # XXX Add here additional method calls
160
    return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

  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

176 177 178 179 180 181 182
  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
183
      self._range_criterion = {}
184 185 186 187 188 189 190 191 192 193 194
    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
195

196
  security.declareProtected( Permissions.ModifyPortalContent, 'setCriterion' )
197 198 199
  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
200
      self._range_criterion = {}
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
    if identity != [] :
      self._identity_criterion[property] = identity
    if min != '' or max != '' :
      self._range_criterion[property] = (min, max)

  security.declareProtected( Permissions.ModifyPortalContent, 'edit' )
  def edit(self, **kwd) :
    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
221

222 223
  # Predicate fusion method
  def setPredicateCategoryList(self, category_list):
Sebastien Robin's avatar
Sebastien Robin committed
224
    category_tool = aq_inner(self.portal_categories)
225 226 227 228
    base_category_id_list = category_tool.objectIds()
    membership_criterion_category_list = []
    membership_criterion_base_category_list = []
    multimembership_criterion_base_category_list = []
229
    criterion_property_list = []
Alexandre Boeglin's avatar
Alexandre Boeglin committed
230
    for c in category_list:
231 232 233 234 235 236 237
      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
238
        if predicate_value is not None:
Alexandre Boeglin's avatar
Alexandre Boeglin committed
239
          criterion_property_list.extend(predicate_value.getCriterionPropertyList())
240 241 242 243 244 245 246 247
          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())
          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
248 249 250 251
    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)
Sebastien Robin's avatar
Sebastien Robin committed
252
    self.reindexObject()
Alexandre Boeglin's avatar
Alexandre Boeglin committed
253 254

  # Predicate handling
Jean-Paul Smets's avatar
Jean-Paul Smets committed
255 256 257 258 259
  security.declareProtected(Permissions.AccessContentsInformation, 'asPredicate')
  def asPredicate(self):
    """
    Returns a temporary Predicate based on the Resource properties
    """
Alexandre Boeglin's avatar
Alexandre Boeglin committed
260
    return self
Jean-Paul Smets's avatar
Jean-Paul Smets committed
261