CatalogTool.py 38.3 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
40
from Acquisition import aq_base, aq_inner, aq_parent, ImplicitAcquisitionWrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41
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
from Products.ERP5Security.ERP5UserManager import SUPER_USER
53
from Products.ERP5Type.Utils import sqlquote
54

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

60
SECURITY_USING_NUX_USER_GROUPS, SECURITY_USING_PAS = range(2)
61 62
ACQUIRE_PERMISSION_VALUE = []

63
try:
64 65
  from Products.PluggableAuthService import PluggableAuthService
  PAS_meta_type = PluggableAuthService.PluggableAuthService.meta_type
66
except ImportError:
67
  PAS_meta_type = ''
68 69 70
try:
  from Products.ERP5Security import mergedLocalRoles as PAS_mergedLocalRoles
except ImportError:
71
  pass
72 73 74 75 76 77

try:
  from Products.NuxUserGroups import UserFolderWithGroups
  NUG_meta_type = UserFolderWithGroups.meta_type
except ImportError:
  NUG_meta_type = ''
78 79 80 81 82
try:
  from Products.NuxUserGroups.CatalogToolWithGroups import mergedLocalRoles
  from Products.NuxUserGroups.CatalogToolWithGroups import _getAllowedRolesAndUsers
except ImportError:
  pass
83

Aurel's avatar
Aurel committed
84
from Persistence import Persistent
85
from Acquisition import Implicit
Aurel's avatar
Aurel committed
86

87 88 89 90 91 92 93 94 95
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
96

97
class IndexableObjectWrapper(CMFCoreIndexableObjectWrapper):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
98 99 100 101 102 103 104 105 106 107

    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):
        """
108 109 110 111 112 113 114 115
        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
116 117
        """
        ob = self.__ob
118 119 120 121
        security_product = getSecurityProduct(ob.acl_users)
        withnuxgroups = security_product == SECURITY_USING_NUX_USER_GROUPS
        withpas = security_product == SECURITY_USING_PAS

122
        if withnuxgroups:
123
          localroles = mergedLocalRoles(ob, withgroups=1)
124 125
        elif withpas:
          localroles = PAS_mergedLocalRoles(ob)
126 127 128
        else:
          # CMF
          localroles = _mergedLocalRoles(ob)
129 130 131 132 133
        # 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'
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
        flat_localroles = {}
        skip_role_set = sets.Set()
        skip_role = skip_role_set.add
        clear_skip_role = skip_role_set.clear
        for key, role_list in localroles.iteritems():
          new_role_list = []
          new_role = new_role_list.append
          clear_skip_role()
          for role in role_list:
            if role[:1] == '-':
              skip_role(role[1:])
            elif role not in skip_role_set:
              new_role(role)
          if len(new_role_list)>0:
            flat_localroles[key] = new_role_list
        localroles = flat_localroles
150 151 152 153 154 155
        # 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.
156 157 158
        allowed = sets.Set(rolesForPermissionOn('View', ob))
        allowed.discard('Owner')
        add = allowed.add
159
        for user, roles in localroles.iteritems():
160 161 162 163
          if withnuxgroups:
            prefix = user
          else:
            prefix = 'user:' + user
164
          for role in roles:
165 166 167 168
            if role in allowed:
              add(prefix)
              add(prefix + ':' + role)
        return list(allowed)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
169

170 171 172 173
    def __repr__(self):
      return '<Products.ERP5Catalog.CatalogTool.IndexableObjectWrapper'\
          ' for %s>' % ('/'.join(self.__ob.getPhysicalPath()), )

174

175
class RelatedBaseCategory(Method):
176 177
    """A Dynamic Method to act as a related key.
    """
178
    def __init__(self, id, strict_membership=0, related=0):
179
      self._id = id
180
      self.strict_membership=strict_membership
181
      self.related = related
182

183
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
184
      """Create the sql code for this related key."""
185 186 187
      base_category_uid = instance.portal_categories._getOb(self._id).getUid()
      expression_list = []
      append = expression_list.append
188 189 190 191 192 193 194 195 196 197 198 199
      if self.related:
        append('%s.uid = %s.uid' % (table_1,table_0))
        if self.strict_membership:
          append('AND %s.category_strict_membership = 1' % table_0)
        append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
        append('AND %s.category_uid = %s.uid' % (table_0,query_table))
      else:
        append('%s.uid = %s.category_uid' % (table_1,table_0))
        if self.strict_membership:
          append('AND %s.category_strict_membership = 1' % table_0)
        append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
        append('AND %s.uid = %s.uid' % (table_0,query_table))
200 201
      return ' '.join(expression_list)

202
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
203 204 205 206 207 208 209
    """
    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
210

211
    default_result_limit = 1000
212
    default_count_limit = 1
213
    
Vincent Pelletier's avatar
Vincent Pelletier committed
214
    manage_options = ({ 'label' : 'Overview', 'action' : 'manage_overview' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
215 216 217 218 219
                     ) + ZCatalog.manage_options

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

220
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
221 222 223
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Vincent Pelletier's avatar
Vincent Pelletier committed
224 225 226
    security.declareProtected(Permissions.ManagePortal
                , 'manage_schema')
    manage_schema = DTMLFile('dtml/manageSchema', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
227

Aurel's avatar
Aurel committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    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
      
Vincent Pelletier's avatar
Vincent Pelletier committed
251
    security.declareProtected('Import/Export objects', 'addDefaultSQLMethods')
252
    def addDefaultSQLMethods(self, config_id='erp5'):
253 254 255
      """
        Add default SQL methods for a given configuration.
      """
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
      # 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 = []

271 272
      # Common methods - for backward compatibility
      # SQL code distribution is supposed to be business template based nowadays
273
      if config_id.lower() == 'erp5_mysql':
274
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
        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
297
     
Vincent Pelletier's avatar
Vincent Pelletier committed
298
    security.declareProtected('Import/Export objects', 'exportSQLMethods')
299
    def exportSQLMethods(self, sql_catalog_id=None, config_id='erp5'):
300 301 302 303 304 305 306 307
      """
        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
308

309
      catalog = self.getSQLCatalog(sql_catalog_id)
310 311 312
      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)
313 314 315 316 317
      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',)
318
    
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
      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()
335
          
336 337 338 339 340 341 342 343
      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()
344
        
345
      return msg
346
        
347
    def _listAllowedRolesAndUsers(self, user):
348 349
      security_product = getSecurityProduct(self.acl_users)
      if security_product == SECURITY_USING_PAS:
350
        # We use ERP5Security PAS based authentication
351 352 353
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
354
          proxy_roles = getattr(eo, '_proxy_roles',None)
355 356 357 358 359
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
Vincent Pelletier's avatar
Vincent Pelletier committed
360
          result = list(proxy_roles)
361
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
362 363 364
          result = list(user.getRoles())
        result.append('Anonymous')
        result.append('user:%s' % user.getId())
365 366 367
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
368
            groups = list(user.getGroups())
369 370 371 372 373 374
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
375
        return result
376
      elif security_product == SECURITY_USING_NUX_USER_GROUPS:
377
        return _getAllowedRolesAndUsers(user)
378
      else:
379
        return CMFCoreCatalogTool._listAllowedRolesAndUsers(self, user)
380

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 434 435 436 437 438 439 440 441 442 443 444 445 446
    # 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


Vincent Pelletier's avatar
Vincent Pelletier committed
447
    security.declarePublic('getAllowedRolesAndUsers')
Aurel's avatar
Aurel committed
448
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
449 450
      """
        Return allowed roles and users.
451

452
        This is supposed to be used with Z SQL Methods to check permissions
453
        when you list up documents. It is also able to take into account
454
        a parameter named local_roles so that listed documents only include
455 456
        those documents for which the user (or the group) was
        associated one of the given local roles.
457 458 459
      
        The use of getAllowedRolesAndUsers is deprecated, you should use
        getSecurityQuery instead
460 461
      """
      user = _getAuthenticatedUser(self)
462
      user_str = str(user)
463
      user_is_superuser = (user_str == SUPER_USER)
464
      allowedRolesAndUsers = self._listAllowedRolesAndUsers(user)
465
      role_column_dict = {}
466 467 468
      local_role_column_dict = {}
      catalog = self.getSQLCatalog(sql_catalog_id)
      column_map = catalog.getColumnMap()
469 470 471 472

      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
      if kw.has_key('local_roles'):
473
        local_roles = kw['local_roles']
474 475
        local_role_dict = dict(catalog.getSQLCatalogLocalRoleKeysList())
        role_dict = dict(catalog.getSQLCatalogRoleKeysList())
476
        # XXX user is not enough - we should also include groups of the user
477
        # Only consider local_roles if it is not empty
478
        if local_roles not in (None, '', []): # XXX: Maybe "if local_roles:" is enough.
479
          new_allowedRolesAndUsers = []
480
          # Turn it into a list if necessary according to ';' separator
481
          if isinstance(local_roles, str):
482 483
            local_roles = local_roles.split(';')
          # Local roles now has precedence (since it comes from a WorkList)
484
          for user_or_group in allowedRolesAndUsers:
485
            for role in local_roles:
486
              # Performance optimisation
487 488
              if local_role_dict.has_key(role):
                # XXX This should be a list
489 490 491
                # If a given role exists as a column in the catalog,
                # then it is considered as single valued and indexed
                # through the catalog.
492
                if not user_is_superuser:
493 494 495 496 497 498 499 500 501 502 503 504 505 506
                  # XXX This should be a list
                  # which also includes all user groups
                  column_id = local_role_dict[role]
                  local_role_column_dict[column_id] = user_str
              if role_dict.has_key(role):
                # XXX This should be a list
                # If a given role exists as a column in the catalog,
                # then it is considered as single valued and indexed
                # through the catalog.
                if not user_is_superuser:
                  # XXX This should be a list
                  # which also includes all user groups
                  column_id = role_dict[role]
                  role_column_dict[column_id] = user_str
507
              else:
508
                # Else, we use the standard approach
509
                new_allowedRolesAndUsers.append('%s:%s' % (user_or_group, role))
510 511 512
          if local_role_column_dict == {}:
            allowedRolesAndUsers = new_allowedRolesAndUsers

513 514 515 516
      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
517 518
        for role, column_id in catalog.getSQLCatalogRoleKeysList():
          # XXX This should be a list
519
          if not user_is_superuser:
520 521 522 523
            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]
524 525
              proxy_roles = getattr(eo, '_proxy_roles', None)
              if not proxy_roles:
526
                role_column_dict[column_id] = user_str
527
            except IndexError:
528
              role_column_dict[column_id] = user_str
529

530
      return allowedRolesAndUsers, role_column_dict, local_role_column_dict
531

Aurel's avatar
Aurel committed
532
    def getSecurityUidListAndRoleColumnDict(self, sql_catalog_id=None, **kw):
533
      """
534 535
        Return a list of security Uids and a dictionnary containing available
        role columns.
536 537 538 539

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
540
      """
541 542
      allowedRolesAndUsers, role_column_dict, local_role_column_dict = \
          self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
543
      catalog = self.getSQLCatalog(sql_catalog_id)
544
      method = getattr(catalog, catalog.sql_search_security, None)
545
      if allowedRolesAndUsers:
546
        allowedRolesAndUsers.sort()
547 548 549 550 551 552 553 554 555
        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:
556 557 558 559 560 561 562 563 564 565 566 567
          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 ?
568
            allowedRolesAndUsers = [sqlquote(role) for role in allowedRolesAndUsers]
569
            security_uid_list = [x.uid for x in method(security_roles_list = allowedRolesAndUsers)]
570
          security_uid_cache[cache_key] = security_uid_list
571 572
      else:
        security_uid_list = []
573
      return security_uid_list, role_column_dict, local_role_column_dict
574

Vincent Pelletier's avatar
Vincent Pelletier committed
575
    security.declarePublic('getSecurityQuery')
Aurel's avatar
Aurel committed
576
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
577
      """
578 579 580
        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.
581
      """
582
      original_query = query
583 584 585
      security_uid_list, role_column_dict, local_role_column_dict = \
          self.getSecurityUidListAndRoleColumnDict(
              sql_catalog_id=sql_catalog_id, **kw)
586 587 588 589 590 591 592 593 594 595 596 597 598
      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')
599
      else:
600
        query = Query(security_uid=security_uid_list, operator='IN')
601 602 603 604 605 606 607 608 609 610

      if local_role_column_dict:
        query_list = []
        for key, value in local_role_column_dict.items():
          new_query = Query(**{key : value})
          query_list.append(new_query)
        operator_kw = {'operator': 'AND'}
        local_role_query = ComplexQuery(*query_list, **operator_kw)
        query = ComplexQuery(query, local_role_query, operator='AND')

611 612 613
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
614

Jean-Paul Smets's avatar
Jean-Paul Smets committed
615
    # searchResults has inherited security assertions.
616
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
617
        """
618 619
        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
620
        """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
621
        if not _checkPermission(
Vincent Pelletier's avatar
Vincent Pelletier committed
622
            Permissions.AccessInactivePortalContent, self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623 624 625
            now = DateTime()
            kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
            kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
626

Aurel's avatar
Aurel committed
627 628
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
629
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
630 631 632 633
        # 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
634 635 636

    __call__ = searchResults

637
    security.declarePrivate('beforeCatalogClear')
638 639 640 641 642
    def beforeCatalogClear(self):
      """
      Clears the catalog by calling a list of methods
      """
      id_tool = self.getPortalObject().portal_ids
643
      try:
644
        id_tool.dumpDictLengthIdsItems()
645 646 647 648 649 650 651 652
      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())
653

654 655 656 657
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
658
        kw.setdefault('limit', self.default_result_limit)
659 660
        return ZCatalog.searchResults(self, REQUEST, **kw)

661 662
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
663 664
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
665 666 667 668 669 670 671 672 673
        """
        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
674 675 676 677 678 679 680 681 682 683 684 685 686 687

    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

688
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
689 690 691 692
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
693
        # XXX This needs to be set again
694
        #if not _checkPermission(
Vincent Pelletier's avatar
Vincent Pelletier committed
695 696
        #    Permissions.AccessInactivePortalContent, self):
        #    base = aq_base(self)
697 698 699
        #    now = DateTime()
        #    #kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    #kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Aurel's avatar
Aurel committed
700 701
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))        
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
702
        kw.setdefault('limit', self.default_count_limit)
Aurel's avatar
Aurel committed
703 704
        # get catalog from preference
        return ZCatalog.countResults(self, query=query, sql_catalog_id=catalog_id, **kw)
705
    
706 707 708 709 710
    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
711

712 713 714 715 716 717 718 719 720 721
    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)

722
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
723
        if wf is not None:
724
          vars = wf.getCatalogVariablesFor(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
725
        else:
726 727
          vars = {}
        #LOG('catalog_object vars', 0, str(vars))
728

729 730 731 732 733
        # 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):
734 735 736
          # This condition tells which object should acquire 
          # from their parent.
          # XXX Hardcode _View_Permission for a performance point of view
737 738
          if getattr(aq_base(document_object), '_View_Permission', ACQUIRE_PERMISSION_VALUE) == ACQUIRE_PERMISSION_VALUE\
             and document_object._getAcquireLocalRoles():
739
            document_object = document_object.aq_parent
740 741 742 743
            is_acquired = 1
          else:
            break
        if is_acquired:
744 745 746 747 748
          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
749
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
750
        # XXX we should build vars begore building the wrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
751 752
        if optimised_roles_and_users is not None:
          vars['optimised_roles_and_users'] = optimised_roles_and_users
753
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
754
          vars['optimised_roles_and_users'] = None
755 756 757
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
          vars['predicate_property_dict'] = predicate_property_dict
758
        vars['security_uid'] = security_uid
759 760

        return ImplicitAcquisitionWrapper(w, aq_parent(document_object))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
761 762

    security.declarePrivate('reindexObject')
763
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
764 765 766 767
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
768
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
769
        url = self.__url(object)
770
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
771

772

Jean-Paul Smets's avatar
Jean-Paul Smets committed
773
    security.declarePrivate('unindexObject')
774
    def unindexObject(self, object=None, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
775 776 777
        """
          Remove from catalog.
        """
778
        if path is None and uid is None:
779 780
          if object is None:
            raise TypeError, 'One of uid, path and object parameters must not be None'
781
          path = self.__url(object)
782 783
        if uid is None:
          raise TypeError, "unindexObject supports only uid now"
784
        self.uncatalog_object(path=path, uid=uid, sql_catalog_id=sql_catalog_id)
785

Sebastien Robin's avatar
Sebastien Robin committed
786 787 788 789 790 791 792 793 794
    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)

795 796 797
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
798

Jean-Paul Smets's avatar
Jean-Paul Smets committed
799
    security.declarePrivate('moveObject')
800
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
801 802 803 804 805 806
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
807
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
808 809
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
810

811 812 813 814 815 816
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
817 818 819 820
      if not getattr(object,'isPredicate',None):
        return None
      object = object.asPredicate()
      if object is None:
821 822 823 824 825 826 827 828 829 830 831
        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:
832
            property_dict['%s_range_min' % property] = min
833
          if max is not None:
834
            property_dict['%s_range_max' % property] = max
835
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
836 837
      return property_dict

838
    security.declarePrivate('getDynamicRelatedKeyList')
839
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
840
      """
841
      Return the list of dynamic related keys.
842 843
      This method will try to automatically generate new related key
      by looking at the category tree.
844 845 846 847

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
848 849 850 851
      strict_destination_title | category,catalog/title/z_related_strict_destination

      strict_ related keys only returns documents which are strictly member of
      the category.
852 853
      """
      related_key_list = []
854
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
855
      default_string = 'default_'
856
      strict_string = 'strict_'
857
      for key in key_list:
858
        prefix = ''
859
        strict = 0
860 861 862
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
863 864 865 866
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
867
        splitted_key = key.split('_')
868 869
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
870 871
        for i in range(1,len(splitted_key))[::-1]:
          expected_base_cat_id = '_'.join(splitted_key[0:i])
872
          if expected_base_cat_id != 'parent' and \
873 874 875
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903

            if end_key.startswith('related_'):
              end_key = end_key[len('related_'):]
              # accept only some catalog columns
              if end_key in ('title', 'uid', 'description', 'reference',
                             'relative_url', 'id', 'portal_type',
                             'simulation_state'):
                if strict:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_strict_%s_related' %
                        (prefix, key, end_key, expected_base_cat_id))
                else:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_%s_related' %
                        (prefix, key, end_key, expected_base_cat_id))
            else:
              # accept only some catalog columns
              if end_key in ('title', 'uid', 'description', 'reference',
                             'relative_url', 'id', 'portal_type',
                             'simulation_state'):
                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(
                        '%s%s | category,catalog/%s/z_related_%s' %
                        (prefix, key, end_key, expected_base_cat_id))
904 905 906 907 908 909

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
910
      Will generate z_related_[base_category_id] if possible
911 912 913 914
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
        DYNAMIC_METHOD_NAME = 'z_related_'
915
        STRICT_DYNAMIC_METHOD_NAME = 'z_related_strict_'
916 917 918 919
        method_name_length = len(DYNAMIC_METHOD_NAME)
        zope_security = '__roles__'
        if (name.startswith(DYNAMIC_METHOD_NAME) and \
          (not name.endswith(zope_security))):
920 921 922 923 924 925 926 927 928

          if name.endswith('_related'):
            if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
              base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):-len('_related')]
              method = RelatedBaseCategory(base_category_id,
                                           strict_membership=1, related=1)
            else:
              base_category_id = name[len(DYNAMIC_METHOD_NAME):-len('_related')]
              method = RelatedBaseCategory(base_category_id, related=1)
929
          else:
930 931 932 933 934 935 936
            if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
              base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):]
              method = RelatedBaseCategory(base_category_id, strict_membership=1)
            else:
              base_category_id = name[len(DYNAMIC_METHOD_NAME):]
              method = RelatedBaseCategory(base_category_id)

937
          setattr(self.__class__, name, method)
938 939 940 941 942
          klass = aq_base(self).__class__
          if hasattr(klass, 'security'):
            from Products.ERP5Type import Permissions as ERP5Permissions
            klass.security.declareProtected(ERP5Permissions.View, name)
          else:
943 944
            LOG('ERP5Catalog', PROBLEM,
                'Security not defined on %s' % klass.__name__)
945 946 947 948
          return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
949

950
InitializeClass(CatalogTool)