CatalogTool.py 36.4 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.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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.
#
##############################################################################

29
from ZODB.POSException import ConflictError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from Products.CMFCore.CatalogTool import CatalogTool as CMFCoreCatalogTool
from Products.ZSQLCatalog.ZSQLCatalog import ZCatalog
32
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
33
from Products.ERP5Type import Permissions
34
from Products.ERP5Type.Cache import CachingMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35 36
from AccessControl import ClassSecurityInfo, getSecurityManager
from Products.CMFCore.CatalogTool import IndexableObjectWrapper as CMFCoreIndexableObjectWrapper
37
from Products.CMFCore.utils import UniqueObject, _checkPermission, _getAuthenticatedUser, getToolByName
38
from Products.CMFCore.utils import _mergedLocalRoles
39
from Globals import InitializeClass, DTMLFile, package_home
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41
from Acquisition import aq_base, aq_inner, aq_parent
from DateTime.DateTime import DateTime
42
from Products.CMFActivity.ActiveObject import ActiveObject
43
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45 46 47 48 49

from AccessControl.PermissionRole import rolesForPermissionOn

from Products.PageTemplates.Expressions import SecureModuleImporter
from Products.CMFCore.Expression import Expression
from Products.PageTemplates.Expressions import getEngine
50
from MethodObject import Method
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51

52 53
from Products.ERP5Security.ERP5UserManager import SUPER_USER

54
import os, time, urllib, warnings
55
import sys
56
from zLOG import LOG, PROBLEM, WARNING, INFO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57

58
SECURITY_USING_NUX_USER_GROUPS, SECURITY_USING_PAS = range(2)
59
try:
60 61
  from Products.PluggableAuthService import PluggableAuthService
  PAS_meta_type = PluggableAuthService.PluggableAuthService.meta_type
62
except ImportError:
63
  PAS_meta_type = ''
64 65 66
try:
  from Products.ERP5Security import mergedLocalRoles as PAS_mergedLocalRoles
except ImportError:
67
  pass
68 69 70 71 72 73

try:
  from Products.NuxUserGroups import UserFolderWithGroups
  NUG_meta_type = UserFolderWithGroups.meta_type
except ImportError:
  NUG_meta_type = ''
74 75 76 77 78
try:
  from Products.NuxUserGroups.CatalogToolWithGroups import mergedLocalRoles
  from Products.NuxUserGroups.CatalogToolWithGroups import _getAllowedRolesAndUsers
except ImportError:
  pass
79

Aurel's avatar
Aurel committed
80 81 82
from Persistence import Persistent
from Acquisition import Implicit

83 84 85 86 87 88 89 90 91
def getSecurityProduct(acl_users):
  """returns the security used by the user folder passed.
  (NuxUserGroup, ERP5Security, or None if anything else).
  """
  if acl_users.meta_type == PAS_meta_type:
    return SECURITY_USING_PAS
  elif acl_users.meta_type == NUG_meta_type:
    return SECURITY_USING_NUX_USER_GROUPS

Aurel's avatar
Aurel committed
92

Jean-Paul Smets's avatar
Jean-Paul Smets committed
93 94 95 96 97 98 99 100 101 102 103
class IndexableObjectWrapper(CMFCoreIndexableObjectWrapper):

    def __setattr__(self, name, value):
      # We need to update the uid during the cataloging process
      if name == 'uid':
        setattr(self.__ob, name, value)
      else:
        self.__dict__[name] = value

    def allowedRolesAndUsers(self):
        """
104 105 106 107 108 109 110 111
        Return a list of roles and users with View permission.
        Used by Portal Catalog to filter out items you're not allowed to see.

        WARNING (XXX): some user base local role association is currently
        being stored (ex. to be determined). This should be prevented or it will
        make the table explode. To analyse the symptoms, look at the
        user_and_roles table. You will find some user:foo values
        which are not necessary.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
112 113
        """
        ob = self.__ob
114 115 116 117
        security_product = getSecurityProduct(ob.acl_users)
        withnuxgroups = security_product == SECURITY_USING_NUX_USER_GROUPS
        withpas = security_product == SECURITY_USING_PAS

Jean-Paul Smets's avatar
Jean-Paul Smets committed
118
        allowed = {}
119
        for r in rolesForPermissionOn('View', ob):
120
          allowed[r] = 1
121
        if withnuxgroups:
122
          localroles = mergedLocalRoles(ob, withgroups=1)
123 124
        elif withpas:
          localroles = PAS_mergedLocalRoles(ob)
125 126 127
        else:
          # CMF
          localroles = _mergedLocalRoles(ob)
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
        # For each group or user, we have a list of roles, this list
        # give in this order : [roles on object, roles acquired on the parent,
        # roles acquired on the parent of the parent....]
        # So if we have ['-Author','Author'] we should remove the role 'Author'
        # but if we have ['Author','-Author'] we have to keep the role 'Author'
        new_dict = {}
        for key in localroles.keys():
          new_list = []
          remove_list = []
          for role in localroles[key]:
            if role.startswith('-'):
              if not role[1:] in new_list and not role[1:] in remove_list:
                remove_list.append(role[1:])
            elif not role in remove_list:
              new_list.append(role)
          if len(new_list)>0:
            new_dict[key] = new_list
        localroles = new_dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146
        for user, roles in localroles.items():
147 148 149 150 151 152
          for role in roles:
            if allowed.has_key(role):
              if withnuxgroups:
                allowed[user] = 1
              else:
                allowed['user:' + user] = 1
153 154 155 156 157 158 159 160 161 162 163 164 165
              # Added for ERP5 project by JP Smets
              # The reason why we do not want to keep Owner is because we are
              # trying to reduce the number of security definitions
              # However, this is a bad idea if we start to use Owner role
              # as a kind of bamed Assignee and if we need it for worklists. Therefore
              # we may sometimes catalog the owner user ID whenever the Owner
              # has view permission (see getAllowedRolesAndUsers bellow
              # as well as getViewPermissionOwner method in Base)
              if role != 'Owner':
                if withnuxgroups:
                  allowed[user + ':' + role] = 1
                else:
                  allowed['user:' + user + ':' + role] = 1
166 167
        if allowed.has_key('Owner'):
          del allowed['Owner']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
168 169
        return list(allowed.keys())

170
class RelatedBaseCategory(Method):
171 172
    """A Dynamic Method to act as a related key.
    """
173
    def __init__(self, id,strict_membership=0):
174
      self._id = id
175
      self.strict_membership=strict_membership
176

177
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
178
      """Create the sql code for this related key."""
179 180 181 182
      base_category_uid = instance.portal_categories._getOb(self._id).getUid()
      expression_list = []
      append = expression_list.append
      append('%s.uid = %s.category_uid' % (table_1,table_0))
183 184
      if self.strict_membership:
        append('AND %s.category_strict_membership = 1' % table_0)
185 186 187 188
      append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
      append('AND %s.uid = %s.uid' % (table_0,query_table))
      return ' '.join(expression_list)

189
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
190 191 192 193 194 195 196
    """
    This is a ZSQLCatalog that filters catalog queries.
    It is based on ZSQLCatalog
    """
    id = 'portal_catalog'
    meta_type = 'ERP5 Catalog'
    security = ClassSecurityInfo()
Aurel's avatar
Aurel committed
197

198 199
    default_result_limit = 1000
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
200 201 202 203 204 205 206
    manage_options = ( { 'label' : 'Overview', 'action' : 'manage_overview' },
                     ) + ZCatalog.manage_options


    def __init__(self):
        ZCatalog.__init__(self, self.getId())

207
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
208 209 210
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

211
    security.declareProtected( Permissions.ManagePortal
Jean-Paul Smets's avatar
Jean-Paul Smets committed
212 213 214
                , 'manage_schema' )
    manage_schema = DTMLFile( 'dtml/manageSchema', globals() )

Aurel's avatar
Aurel committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    def getPreferredSQLCatalogId(self, id=None):
      """
      Get the SQL Catalog from preference.
      """
      if id is None:
        # Check if we want to use an archive
        #if getattr(aq_base(self.portal_preferences), 'uid', None) is not None:
        archive_path = self.portal_preferences.getPreferredArchive(sql_catalog_id=self.default_sql_catalog_id)
        if archive_path not in ('', None):
          try:
            archive = self.restrictedTraverse(archive_path)
          except KeyError:
            # Do not fail if archive object has been removed,
            # but preference is not up to date
            return None
          if archive is not None:
            catalog_id = archive.getCatalogId()
            if catalog_id not in ('', None):
              return catalog_id
        return None
      else:
        return id
      
238
    security.declareProtected( 'Import/Export objects', 'addDefaultSQLMethods' )
239
    def addDefaultSQLMethods(self, config_id='erp5'):
240 241 242
      """
        Add default SQL methods for a given configuration.
      """
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
      # For compatibility.
      if config_id.lower() == 'erp5':
        config_id = 'erp5_mysql'
      elif config_id.lower() == 'cps3':
        config_id = 'cps3_mysql'

      addSQLCatalog = self.manage_addProduct['ZSQLCatalog'].manage_addSQLCatalog
      if config_id not in self.objectIds():
        addSQLCatalog(config_id, '')

      catalog = self.getSQLCatalog(config_id)
      addSQLMethod = catalog.manage_addProduct['ZSQLMethods'].manage_addZSQLMethod
      product_path = package_home(globals())
      zsql_dirs = []

258 259
      # Common methods - for backward compatibility
      # SQL code distribution is supposed to be business template based nowadays
260
      if config_id.lower() == 'erp5_mysql':
261
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
        zsql_dirs.append(os.path.join(product_path, 'sql', 'erp5_mysql'))
      elif config_id.lower() == 'cps3_mysql':
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
        zsql_dirs.append(os.path.join(product_path, 'sql', 'cps3_mysql'))

      # Iterate over the sql directory. Add all sql methods in that directory.
      for directory in zsql_dirs:
        for entry in os.listdir(directory):
          if entry.endswith('.zsql'):
            id = entry[:-5]
            # Create an empty SQL method first.
            addSQLMethod(id = id, title = '', connection_id = '', arguments = '', template = '')
            #LOG('addDefaultSQLMethods', 0, 'catalog = %r' % (catalog.objectIds(),))
            sql_method = getattr(catalog, id)
            # Set parameters of the SQL method from the contents of a .zsql file.
            sql_method.fromFile(os.path.join(directory, entry))
          elif entry == 'properties.xml':
            # This sets up the attributes. The file should be generated by manage_exportProperties.
            catalog.manage_importProperties(os.path.join(directory, entry))

      # Make this the default.
      self.default_sql_catalog_id = config_id
284
     
285
    security.declareProtected( 'Import/Export objects', 'exportSQLMethods' )
286
    def exportSQLMethods(self, sql_catalog_id=None, config_id='erp5'):
287 288 289 290 291 292 293 294
      """
        Export SQL methods for a given configuration.
      """
      # For compatibility.
      if config_id.lower() == 'erp5':
        config_id = 'erp5_mysql'
      elif config_id.lower() == 'cps3':
        config_id = 'cps3_mysql'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
295

296
      catalog = self.getSQLCatalog(sql_catalog_id)
297 298 299
      product_path = package_home(globals())
      common_sql_dir = os.path.join(product_path, 'sql', 'common_mysql')
      config_sql_dir = os.path.join(product_path, 'sql', config_id)
300 301 302 303 304
      common_sql_list = ('z0_drop_record', 'z_read_recorded_object_list', 'z_catalog_paths',
                         'z_record_catalog_object', 'z_clear_reserved', 'z_record_uncatalog_object',
                         'z_create_record', 'z_related_security', 'z_delete_recorded_object_list',
                         'z_reserve_uid', 'z_getitem_by_path', 'z_show_columns', 'z_getitem_by_path',
                         'z_show_tables', 'z_getitem_by_uid', 'z_unique_values', 'z_produce_reserved_uid_list',)
305
    
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
      msg = ''
      for id in catalog.objectIds(spec=('Z SQL Method',)):
        if id in common_sql_list:
          d = common_sql_dir
        else:
          d = config_sql_dir
        sql = catalog._getOb(id)
        # First convert the skin to text
        text = sql.manage_FTPget()
        name = os.path.join(d, '%s.zsql' % (id,))
        msg += 'Writing %s\n' % (name,)
        f = open(name, 'w')
        try:
          f.write(text)
        finally:
          f.close()
322
          
323 324 325 326 327 328 329 330
      properties = self.manage_catalogExportProperties(sql_catalog_id=sql_catalog_id)
      name = os.path.join(config_sql_dir, 'properties.xml')
      msg += 'Writing %s\n' % (name,)
      f = open(name, 'w')
      try:
        f.write(properties)
      finally:
        f.close()
331
        
332
      return msg
333
        
334
    def _listAllowedRolesAndUsers(self, user):
335 336
      security_product = getSecurityProduct(self.acl_users)
      if security_product == SECURITY_USING_PAS:
337
        # We use ERP5Security PAS based authentication
338 339 340
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
341
          proxy_roles = getattr(eo, '_proxy_roles',None)
342 343 344 345 346 347 348 349
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
          result = list( proxy_roles )
        else:
          result = list( user.getRoles() )
350 351
        result.append( 'Anonymous' )
        result.append( 'user:%s' % user.getId() )
352 353 354
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
355
            groups = list(user.getGroups())
356 357 358 359 360 361
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
362
        return result
363
      elif security_product == SECURITY_USING_NUX_USER_GROUPS:
364
        return _getAllowedRolesAndUsers(user)
365
      else:
366
        return CMFCoreCatalogTool._listAllowedRolesAndUsers(self, user)
367

Jean-Paul Smets's avatar
Jean-Paul Smets committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
    # Schema Management
    def editColumn(self, column_id, sql_definition, method_id, default_value, REQUEST=None, RESPONSE=None):
      """
        Modifies a schema column of the catalog
      """
      new_schema = []
      for c in self.getIndexList():
        if c.id == index_id:
          new_c = {'id': index_id, 'sql_definition': sql_definition, 'method_id': method_id, 'default_value': default_value}
        else:
          new_c = c
        new_schema.append(new_c)
      self.setColumnList(new_schema)

    def setColumnList(self, column_list):
      """
      """
      self._sql_schema = column_list

    def getColumnList(self):
      """
      """
      if not hasattr(self, '_sql_schema'): self._sql_schema = []
      return self._sql_schema

    def getColumn(self, column_id):
      """
      """
      for c in self.getColumnList():
        if c.id == column_id:
          return c
      return None

    def editIndex(self, index_id, sql_definition, REQUEST=None, RESPONSE=None):
      """
        Modifies the schema of the catalog
      """
      new_index = []
      for c in self.getIndexList():
        if c.id == index_id:
          new_c = {'id': index_id, 'sql_definition': sql_definition}
        else:
          new_c = c
        new_index.append(new_c)
      self.setIndexList(new_index)

    def setIndexList(self, index_list):
      """
      """
      self._sql_index = index_list

    def getIndexList(self):
      """
      """
      if not hasattr(self, '_sql_index'): self._sql_index = []
      return self._sql_index

    def getIndex(self, index_id):
      """
      """
      for c in self.getIndexList():
        if c.id == index_id:
          return c
      return None


434
    security.declarePublic( 'getAllowedRolesAndUsers' )
Aurel's avatar
Aurel committed
435
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
436 437
      """
        Return allowed roles and users.
438

439
        This is supposed to be used with Z SQL Methods to check permissions
440
        when you list up documents. It is also able to take into account
441
        a parameter named local_roles so that listed documents only include
442 443
        those documents for which the user (or the group) was
        associated one of the given local roles.
444 445 446
      
        The use of getAllowedRolesAndUsers is deprecated, you should use
        getSecurityQuery instead
447 448
      """
      user = _getAuthenticatedUser(self)
449
      user_str = str(user)
450
      user_is_superuser = (user_str == SUPER_USER)
451
      allowedRolesAndUsers = self._listAllowedRolesAndUsers(user)
452
      role_column_dict = {}
Aurel's avatar
Aurel committed
453
      column_map = self.getSQLCatalog(sql_catalog_id).getColumnMap()
454 455 456 457

      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
      if kw.has_key('local_roles'):
458
        local_roles = kw['local_roles']
459
        # XXX user is not enough - we should also include groups of the user
460
        # Only consider local_roles if it is not empty
461
        if local_roles not in (None, '', []): # XXX: Maybe "if local_roles:" is enough.
462
          new_allowedRolesAndUsers = []
463
          # Turn it into a list if necessary according to ';' separator
464
          if isinstance(local_roles, str):
465
            local_roles = local_roles.split(';')
466
          local_roles = [x.lower() for x in local_roles]
467
          # Local roles now has precedence (since it comes from a WorkList)
468
          for user_or_group in allowedRolesAndUsers:
469
            for role in local_roles:
470
              # Performance optimisation
471
              if role in column_map:
472 473 474
                # If a given role exists as a column in the catalog,
                # then it is considered as single valued and indexed
                # through the catalog.
475 476 477
                if not user_is_superuser:
                  role_column_dict[role] = user_str  # XXX This should be a list
                                                     # which also includes all user groups
478
              else:
479
                # Else, we use the standard approach
480
                new_allowedRolesAndUsers.append('%s:%s' % (user_or_group, role))
481
          allowedRolesAndUsers = new_allowedRolesAndUsers
482 483 484 485
      else:
        # We only consider here the Owner role (since it was not indexed)
        # since some objects may only be visible by their owner
        # which was not indexed
486 487
        if 'owner' in column_map:
          if not user_is_superuser:
488 489 490 491
            try:
              # if called by an executable with proxy roles, we don't use
              # owner, but only roles from the proxy.
              eo = getSecurityManager()._context.stack[-1]
492 493 494
              proxy_roles = getattr(eo, '_proxy_roles', None)
              if not proxy_roles:
                role_column_dict['owner'] = user_str
495 496
            except IndexError:
              role_column_dict['owner'] = user_str
497

498
      return allowedRolesAndUsers, role_column_dict
499

Aurel's avatar
Aurel committed
500
    def getSecurityUidListAndRoleColumnDict(self, sql_catalog_id=None, **kw):
501
      """
502 503
        Return a list of security Uids and a dictionnary containing available
        role columns.
504 505 506 507

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
508 509
      """
      allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
510
      catalog = self.getSQLCatalog(sql_catalog_id)
511
      method = getattr(catalog, catalog.sql_search_security, None)
512
      if allowedRolesAndUsers:
513
        allowedRolesAndUsers.sort()
514 515 516 517 518 519 520 521 522
        cache_key = tuple(allowedRolesAndUsers)
        tv = getTransactionalVariable(self)
        try:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict']
        except KeyError:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict'] = {}
        try:
          security_uid_list = security_uid_cache[cache_key]
        except KeyError:
523 524 525 526 527 528 529 530 531 532 533 534 535 536
          if method is None:
            warnings.warn("The usage of allowedRolesAndUsers is "\
                          "deprecated. Please update your catalog "\
                          "business template.", DeprecationWarning)
            security_uid_list = [x.security_uid for x in \
              self.unrestrictedSearchResults(
                allowedRolesAndUsers=allowedRolesAndUsers,
                select_expression="security_uid",
                group_by_expression="security_uid")]
          else:
            # XXX: What with this string transformation ?! Souldn't it be done in
            # dtml instead ?
            allowedRolesAndUsers = ["'%s'" % (role, ) for role in allowedRolesAndUsers]
            security_uid_list = [x.uid for x in method(security_roles_list = allowedRolesAndUsers)]
537
          security_uid_cache[cache_key] = security_uid_list
538 539
      else:
        security_uid_list = []
540
      return security_uid_list, role_column_dict
541

542
    security.declarePublic( 'getSecurityQuery' )
Aurel's avatar
Aurel committed
543
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
544
      """
545 546 547
        Build a query based on allowed roles or on a list of security_uid
        values. The query takes into account the fact that some roles are
        catalogued with columns.
548
      """
549
      original_query = query
550 551 552 553 554 555 556 557 558 559 560 561 562 563
      security_uid_list, role_column_dict = self.getSecurityUidListAndRoleColumnDict(sql_catalog_id=sql_catalog_id, **kw)
      if role_column_dict:
        query_list = []
        for key, value in role_column_dict.items():
          new_query = Query(**{key : value})
          query_list.append(new_query)
        operator_kw = {'operator': 'AND'}
        query = ComplexQuery(*query_list, **operator_kw)
        # If security_uid_list is empty, adding it to criterions will only
        # result in "false or [...]", so avoid useless overhead by not
        # adding it at all.
        if security_uid_list:
          query = ComplexQuery(Query(security_uid=security_uid_list, operator='IN'),
                               query, operator='OR')
564
      else:
565
        query = Query(security_uid=security_uid_list, operator='IN')
566 567 568
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
569

Jean-Paul Smets's avatar
Jean-Paul Smets committed
570
    # searchResults has inherited security assertions.
571
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
572
        """
573 574
        Calls ZCatalog.searchResults with extra arguments that
        limit the results to what the user is allowed to see.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
575
        """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
576
        if not _checkPermission(
577
            Permissions.AccessInactivePortalContent, self ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
578 579 580
            now = DateTime()
            kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
            kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
581

Aurel's avatar
Aurel committed
582 583
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
584
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
585 586 587 588
        # get catalog from preference
        #LOG("searchResult", INFO, catalog_id)
        #         LOG("searchResult", INFO, ZCatalog.searchResults(self, query=query, sql_catalog_id=catalog_id, src__=1, **kw))
        return ZCatalog.searchResults(self, query=query, sql_catalog_id=catalog_id, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
589 590 591

    __call__ = searchResults

592 593 594 595 596 597
    security.declarePrivate('clear')
    def beforeCatalogClear(self):
      """
      Clears the catalog by calling a list of methods
      """
      id_tool = self.getPortalObject().portal_ids
598 599 600 601 602 603 604 605 606 607 608 609 610
      try:
        # Call generate new id in order to store the last id into
        # the zodb
        id_tool.generateNewLengthId(id_group='portal_activity')
        id_tool.generateNewLengthId(id_group='portal_activity_queue')
      except ConflictError:
        raise
      except:
        # Swallow exceptions to allow catalog clear to happen.
        # For example, is portal_ids table does not exist and exception will
        # be thrown by portal_id methods.
        LOG('ERP5Catalog.beforeCatalogClear', WARNING,
            'beforeCatalogClear failed', error=sys.exc_info())
611

612 613 614 615
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
616
        kw.setdefault('limit', self.default_result_limit)
617 618
        return ZCatalog.searchResults(self, REQUEST, **kw)

619 620
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
621 622
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
623 624 625 626 627 628 629 630 631
        """
        A method to factor common code used to search a single
        object in the database.
        """
        result = self.searchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None
632 633 634 635 636 637 638 639 640 641 642 643 644 645

    security.declarePrivate('unrestrictedGetResultValue')
    def unrestrictedGetResultValue(self, query=None, **kw):
        """
        A method to factor common code used to search a single
        object in the database. Same as getResultValue but without
        taking into account security.
        """
        result = self.unrestrictedSearchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None

646
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
647 648 649 650
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
651
        # XXX This needs to be set again
652
        #if not _checkPermission(
653
        #    Permissions.AccessInactivePortalContent, self ):
654 655 656 657
        #    base = aq_base( self )
        #    now = DateTime()
        #    #kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    #kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Aurel's avatar
Aurel committed
658 659
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))        
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
660
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
661 662
        # get catalog from preference
        return ZCatalog.countResults(self, query=query, sql_catalog_id=catalog_id, **kw)
663
    
664 665 666 667 668
    security.declarePrivate('unrestrictedCountResults')
    def unrestrictedCountResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.countResults directly without restrictions.
        """
        return ZCatalog.countResults(self, REQUEST, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
669

670 671 672 673 674 675 676 677 678 679
    def wrapObject(self, object, sql_catalog_id=None, **kw):
        """
          Return a wrapped object for reindexing.
        """
        catalog = self.getSQLCatalog(sql_catalog_id)
        if catalog is None:
          # Nothing to do.
          LOG('wrapObject', 0, 'Warning: catalog is not available')
          return (None, None)

680
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
681
        if wf is not None:
682
          vars = wf.getCatalogVariablesFor(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
683
        else:
684 685
          vars = {}
        #LOG('catalog_object vars', 0, str(vars))
686

687 688 689 690 691 692
        # This functions tells which portal_types should acquire 
        # from their parent. The behaviour is the same as
        # in previous implementations but is capable of covering
        # more cases. Only those portal types which View permission
        # is not managed by a workflow and which acquire local
        # roles acquire their permission
693
        types_tool = getToolByName(self, 'portal_types')
694
        def isViewPermissionAcquired(portal_type):
695 696 697 698 699 700 701
          type_definition = types_tool.getTypeInfo(portal_type)
          if getattr(aq_base(type_definition), 'acquire_local_roles', 0):
            for workflow in wf.getWorkflowsFor(portal_type):
              if 'View' in getattr(aq_base(workflow), 'permissions', ()):
                return 0
            # No workflow manages View and roles are acquired
            return 1
702 703
          return 0

704 705 706 707 708 709
        # This below is commented out, because caching has tremendous
        # side effect, and the performance seems to be not so different. -yo
        # 
        # isViewPermissionAcquired = CachingMethod(isViewPermissionAcquired, 
        #                                          id='CatalogTool_isViewPermissionAcquired',
        #                                          cache_factory='erp5_content_long')
710 711 712 713 714 715

        # Find the parent definition for security
        document_object = aq_inner(object)
        is_acquired = 0
        w = IndexableObjectWrapper(vars, document_object)
        while getattr(document_object, 'isRADContent', 0):
716
          if isViewPermissionAcquired(getattr(aq_base(document_object), 'portal_type', None)):
717
            document_object = document_object.aq_parent
718 719 720 721
            is_acquired = 1
          else:
            break
        if is_acquired:
722 723 724 725 726
          document_w = IndexableObjectWrapper({}, document_object)
        else:
          document_w = w

        (security_uid, optimised_roles_and_users) = catalog.getSecurityUid(document_w)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
727
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
728
        # XXX we should build vars begore building the wrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
729 730
        if optimised_roles_and_users is not None:
          vars['optimised_roles_and_users'] = optimised_roles_and_users
731
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
732
          vars['optimised_roles_and_users'] = None
733 734 735
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
          vars['predicate_property_dict'] = predicate_property_dict
736
        vars['security_uid'] = security_uid
737 738

        return w
Jean-Paul Smets's avatar
Jean-Paul Smets committed
739 740

    security.declarePrivate('reindexObject')
741
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
742 743 744 745
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
746
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
747
        url = self.__url(object)
748
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
749

750

Jean-Paul Smets's avatar
Jean-Paul Smets committed
751
    security.declarePrivate('unindexObject')
752
    def unindexObject(self, object=None, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
753 754 755
        """
          Remove from catalog.
        """
756
        if path is None and uid is None:
757 758
          if object is None:
            raise TypeError, 'One of uid, path and object parameters must not be None'
759
          path = self.__url(object)
760 761
        if uid is None:
          raise TypeError, "unindexObject supports only uid now"
762
        self.uncatalog_object(path=path, uid=uid, sql_catalog_id=sql_catalog_id)
763

Sebastien Robin's avatar
Sebastien Robin committed
764 765 766 767 768 769 770 771 772
    security.declarePrivate('beforeUnindexObject')
    def beforeUnindexObject(self, object, path=None, uid=None,sql_catalog_id=None):
        """
          Remove from catalog.
        """
        if path is None and uid is None:
          path = self.__url(object)
        self.beforeUncatalogObject(path=path,uid=uid, sql_catalog_id=sql_catalog_id)

773 774 775
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
776

Jean-Paul Smets's avatar
Jean-Paul Smets committed
777
    security.declarePrivate('moveObject')
778
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
779 780 781 782 783 784
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
785
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
786 787
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
788

789 790 791 792 793 794
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
795 796 797 798
      if not getattr(object,'isPredicate',None):
        return None
      object = object.asPredicate()
      if object is None:
799 800 801 802 803 804 805 806 807 808 809
        return None
      property_dict = {}
      identity_criterion = getattr(object,'_identity_criterion',None)
      range_criterion = getattr(object,'_range_criterion',None)
      if identity_criterion is not None:
        for property, value in identity_criterion.items():
          if value is not None:
            property_dict[property] = value
      if range_criterion is not None:
        for property, (min, max) in range_criterion.items():
          if min is not None:
810
            property_dict['%s_range_min' % property] = min
811
          if max is not None:
812
            property_dict['%s_range_max' % property] = max
813
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
814 815
      return property_dict

816
    security.declarePrivate('getDynamicRelatedKeyList')
817
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
818
      """
819
      Return the list of dynamic related keys.
820 821
      This method will try to automatically generate new related key
      by looking at the category tree.
822 823 824 825

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
826 827 828 829
      strict_destination_title | category,catalog/title/z_related_strict_destination

      strict_ related keys only returns documents which are strictly member of
      the category.
830 831
      """
      related_key_list = []
832
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
833
      default_string = 'default_'
834
      strict_string = 'strict_'
835
      for key in key_list:
836
        prefix = ''
837
        strict = 0
838 839 840
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
841 842 843 844
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
845
        splitted_key = key.split('_')
846 847
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
848 849
        for i in range(1,len(splitted_key))[::-1]:
          expected_base_cat_id = '_'.join(splitted_key[0:i])
850
          if expected_base_cat_id != 'parent' and \
851 852 853
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
854
            # accept only some catalog columns
855 856
            if end_key in ('title', 'uid', 'description',
                           'relative_url', 'id', 'portal_type'):
857 858 859 860 861 862
              if strict:
                related_key_list.append(
                      '%s%s | category,catalog/%s/z_related_strict_%s' %
                      (prefix, key, end_key, expected_base_cat_id))
              else:
                related_key_list.append(
863 864
                      '%s%s | category,catalog/%s/z_related_%s' %
                      (prefix, key, end_key, expected_base_cat_id))
865 866 867 868 869 870

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
871
      Will generate z_related_[base_category_id] if possible
872 873 874 875
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
        DYNAMIC_METHOD_NAME = 'z_related_'
876
        STRICT_DYNAMIC_METHOD_NAME = 'z_related_strict_'
877 878 879 880
        method_name_length = len(DYNAMIC_METHOD_NAME)
        zope_security = '__roles__'
        if (name.startswith(DYNAMIC_METHOD_NAME) and \
          (not name.endswith(zope_security))):
881 882
          if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
            base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):]
883
            method = RelatedBaseCategory(base_category_id, strict_membership=1)
884 885 886
          else:
            base_category_id = name[len(DYNAMIC_METHOD_NAME):]
            method = RelatedBaseCategory(base_category_id)
887
          setattr(self.__class__, name, method)
888 889 890 891 892
          klass = aq_base(self).__class__
          if hasattr(klass, 'security'):
            from Products.ERP5Type import Permissions as ERP5Permissions
            klass.security.declareProtected(ERP5Permissions.View, name)
          else:
893 894
            LOG('ERP5Catalog', PROBLEM,
                'Security not defined on %s' % klass.__name__)
895 896 897 898
          return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
899

900
InitializeClass(CatalogTool)