CatalogTool.py 36 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 122
        if 'Owner' in allowed:
          del allowed['Owner']
123
        if withnuxgroups:
124
          localroles = mergedLocalRoles(ob, withgroups=1)
125 126
        elif withpas:
          localroles = PAS_mergedLocalRoles(ob)
127 128 129
        else:
          # CMF
          localroles = _mergedLocalRoles(ob)
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
        # 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
148 149 150 151 152 153 154
        # For each local role of a user:
        #   If the local role grants View permission, add it.
        # Every addition implies 2 lines:
        #   user:<user_id>
        #   user:<user_id>:<role_id>
        # A line must not be present twice in final result.
        for user, roles in localroles.iteritems():
155 156 157 158
          if withnuxgroups:
            prefix = user
          else:
            prefix = 'user:' + user
159 160
          for role in roles:
            if allowed.has_key(role):
161
              allowed[prefix] = 1
162
              allowed[prefix + ':' + role] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
163 164
        return list(allowed.keys())

165
class RelatedBaseCategory(Method):
166 167
    """A Dynamic Method to act as a related key.
    """
168
    def __init__(self, id,strict_membership=0):
169
      self._id = id
170
      self.strict_membership=strict_membership
171

172
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
173
      """Create the sql code for this related key."""
174 175 176 177
      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))
178 179
      if self.strict_membership:
        append('AND %s.category_strict_membership = 1' % table_0)
180 181 182 183
      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)

184
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
185 186 187 188 189 190 191
    """
    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
192

193 194
    default_result_limit = 1000
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
195 196 197 198 199 200 201
    manage_options = ( { 'label' : 'Overview', 'action' : 'manage_overview' },
                     ) + ZCatalog.manage_options


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

202
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
203 204 205
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

206
    security.declareProtected( Permissions.ManagePortal
Jean-Paul Smets's avatar
Jean-Paul Smets committed
207 208 209
                , 'manage_schema' )
    manage_schema = DTMLFile( 'dtml/manageSchema', globals() )

Aurel's avatar
Aurel committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    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
      
233
    security.declareProtected( 'Import/Export objects', 'addDefaultSQLMethods' )
234
    def addDefaultSQLMethods(self, config_id='erp5'):
235 236 237
      """
        Add default SQL methods for a given configuration.
      """
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
      # 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 = []

253 254
      # Common methods - for backward compatibility
      # SQL code distribution is supposed to be business template based nowadays
255
      if config_id.lower() == 'erp5_mysql':
256
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
        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
279
     
280
    security.declareProtected( 'Import/Export objects', 'exportSQLMethods' )
281
    def exportSQLMethods(self, sql_catalog_id=None, config_id='erp5'):
282 283 284 285 286 287 288 289
      """
        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
290

291
      catalog = self.getSQLCatalog(sql_catalog_id)
292 293 294
      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)
295 296 297 298 299
      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',)
300
    
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
      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()
317
          
318 319 320 321 322 323 324 325
      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()
326
        
327
      return msg
328
        
329
    def _listAllowedRolesAndUsers(self, user):
330 331
      security_product = getSecurityProduct(self.acl_users)
      if security_product == SECURITY_USING_PAS:
332
        # We use ERP5Security PAS based authentication
333 334 335
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
336
          proxy_roles = getattr(eo, '_proxy_roles',None)
337 338 339 340 341 342 343 344
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
          result = list( proxy_roles )
        else:
          result = list( user.getRoles() )
345 346
        result.append( 'Anonymous' )
        result.append( 'user:%s' % user.getId() )
347 348 349
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
350
            groups = list(user.getGroups())
351 352 353 354 355 356
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
357
        return result
358
      elif security_product == SECURITY_USING_NUX_USER_GROUPS:
359
        return _getAllowedRolesAndUsers(user)
360
      else:
361
        return CMFCoreCatalogTool._listAllowedRolesAndUsers(self, user)
362

Jean-Paul Smets's avatar
Jean-Paul Smets committed
363 364 365 366 367 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
    # 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


429
    security.declarePublic( 'getAllowedRolesAndUsers' )
Aurel's avatar
Aurel committed
430
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
431 432
      """
        Return allowed roles and users.
433

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

      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
      if kw.has_key('local_roles'):
453
        local_roles = kw['local_roles']
454
        # XXX user is not enough - we should also include groups of the user
455
        # Only consider local_roles if it is not empty
456
        if local_roles not in (None, '', []): # XXX: Maybe "if local_roles:" is enough.
457
          new_allowedRolesAndUsers = []
458
          # Turn it into a list if necessary according to ';' separator
459
          if isinstance(local_roles, str):
460
            local_roles = local_roles.split(';')
461
          local_roles = [x.lower() for x in local_roles]
462
          # Local roles now has precedence (since it comes from a WorkList)
463
          for user_or_group in allowedRolesAndUsers:
464
            for role in local_roles:
465
              # Performance optimisation
466
              if role in column_map:
467 468 469
                # If a given role exists as a column in the catalog,
                # then it is considered as single valued and indexed
                # through the catalog.
470 471 472
                if not user_is_superuser:
                  role_column_dict[role] = user_str  # XXX This should be a list
                                                     # which also includes all user groups
473
              else:
474
                # Else, we use the standard approach
475
                new_allowedRolesAndUsers.append('%s:%s' % (user_or_group, role))
476
          allowedRolesAndUsers = new_allowedRolesAndUsers
477 478 479 480
      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
481 482
        if 'owner' in column_map:
          if not user_is_superuser:
483 484 485 486
            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]
487 488 489
              proxy_roles = getattr(eo, '_proxy_roles', None)
              if not proxy_roles:
                role_column_dict['owner'] = user_str
490 491
            except IndexError:
              role_column_dict['owner'] = user_str
492

493
      return allowedRolesAndUsers, role_column_dict
494

Aurel's avatar
Aurel committed
495
    def getSecurityUidListAndRoleColumnDict(self, sql_catalog_id=None, **kw):
496
      """
497 498
        Return a list of security Uids and a dictionnary containing available
        role columns.
499 500 501 502

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
503 504
      """
      allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
505
      catalog = self.getSQLCatalog(sql_catalog_id)
506
      method = getattr(catalog, catalog.sql_search_security, None)
507
      if allowedRolesAndUsers:
508
        allowedRolesAndUsers.sort()
509 510 511 512 513 514 515 516 517
        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:
518 519 520 521 522 523 524 525 526 527 528 529 530 531
          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)]
532
          security_uid_cache[cache_key] = security_uid_list
533 534
      else:
        security_uid_list = []
535
      return security_uid_list, role_column_dict
536

537
    security.declarePublic( 'getSecurityQuery' )
Aurel's avatar
Aurel committed
538
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
539
      """
540 541 542
        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.
543
      """
544
      original_query = query
545 546 547 548 549 550 551 552 553 554 555 556 557 558
      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')
559
      else:
560
        query = Query(security_uid=security_uid_list, operator='IN')
561 562 563
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
564

Jean-Paul Smets's avatar
Jean-Paul Smets committed
565
    # searchResults has inherited security assertions.
566
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
567
        """
568 569
        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
570
        """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
571
        if not _checkPermission(
572
            Permissions.AccessInactivePortalContent, self ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
573 574 575
            now = DateTime()
            kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
            kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
576

Aurel's avatar
Aurel committed
577 578
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
579
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
580 581 582 583
        # 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
584 585 586

    __call__ = searchResults

587 588 589 590 591 592
    security.declarePrivate('clear')
    def beforeCatalogClear(self):
      """
      Clears the catalog by calling a list of methods
      """
      id_tool = self.getPortalObject().portal_ids
593 594 595 596 597 598 599 600 601 602 603 604 605
      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())
606

607 608 609 610
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
611
        kw.setdefault('limit', self.default_result_limit)
612 613
        return ZCatalog.searchResults(self, REQUEST, **kw)

614 615
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
616 617
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
618 619 620 621 622 623 624 625 626
        """
        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
627 628 629 630 631 632 633 634 635 636 637 638 639 640

    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

641
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
642 643 644 645
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
646
        # XXX This needs to be set again
647
        #if not _checkPermission(
648
        #    Permissions.AccessInactivePortalContent, self ):
649 650 651 652
        #    base = aq_base( self )
        #    now = DateTime()
        #    #kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    #kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Aurel's avatar
Aurel committed
653 654
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))        
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
655
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
656 657
        # get catalog from preference
        return ZCatalog.countResults(self, query=query, sql_catalog_id=catalog_id, **kw)
658
    
659 660 661 662 663
    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
664

665 666 667 668 669 670 671 672 673 674
    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)

675
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
676
        if wf is not None:
677
          vars = wf.getCatalogVariablesFor(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
678
        else:
679 680
          vars = {}
        #LOG('catalog_object vars', 0, str(vars))
681

682 683 684 685 686 687
        # 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
688
        types_tool = getToolByName(self, 'portal_types')
689
        def isViewPermissionAcquired(portal_type):
690 691 692 693 694 695 696
          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
697 698
          return 0

699 700 701 702 703 704
        # 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')
705 706 707 708 709 710

        # 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):
711
          if isViewPermissionAcquired(getattr(aq_base(document_object), 'portal_type', None)):
712
            document_object = document_object.aq_parent
713 714 715 716
            is_acquired = 1
          else:
            break
        if is_acquired:
717 718 719 720 721
          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
722
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
723
        # XXX we should build vars begore building the wrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
724 725
        if optimised_roles_and_users is not None:
          vars['optimised_roles_and_users'] = optimised_roles_and_users
726
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
727
          vars['optimised_roles_and_users'] = None
728 729 730
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
          vars['predicate_property_dict'] = predicate_property_dict
731
        vars['security_uid'] = security_uid
732 733

        return w
Jean-Paul Smets's avatar
Jean-Paul Smets committed
734 735

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

745

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

Sebastien Robin's avatar
Sebastien Robin committed
759 760 761 762 763 764 765 766 767
    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)

768 769 770
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
771

Jean-Paul Smets's avatar
Jean-Paul Smets committed
772
    security.declarePrivate('moveObject')
773
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
774 775 776 777 778 779
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
780
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
781 782
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
783

784 785 786 787 788 789
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
790 791 792 793
      if not getattr(object,'isPredicate',None):
        return None
      object = object.asPredicate()
      if object is None:
794 795 796 797 798 799 800 801 802 803 804
        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:
805
            property_dict['%s_range_min' % property] = min
806
          if max is not None:
807
            property_dict['%s_range_max' % property] = max
808
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
809 810
      return property_dict

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

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
821 822 823 824
      strict_destination_title | category,catalog/title/z_related_strict_destination

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

      return related_key_list

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

895
InitializeClass(CatalogTool)