CatalogTool.py 38.1 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
from AccessControl import ClassSecurityInfo, getSecurityManager
36
from Products.CMFCore.utils import UniqueObject, _checkPermission, _getAuthenticatedUser, getToolByName
37
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, package_home
38
from Acquisition import aq_base, aq_inner, aq_parent, ImplicitAcquisitionWrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from DateTime.DateTime import DateTime
40
from Products.CMFActivity.ActiveObject import ActiveObject
41
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46 47

from AccessControl.PermissionRole import rolesForPermissionOn

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

50
from Products.ERP5Security import mergedLocalRoles
51
from Products.ERP5Security.ERP5UserManager import SUPER_USER
52
from Products.ERP5Type.Utils import sqlquote
53

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 59
ACQUIRE_PERMISSION_VALUE = []

Aurel's avatar
Aurel committed
60
from Persistence import Persistent
61
from Acquisition import Implicit
Aurel's avatar
Aurel committed
62 63


64
class IndexableObjectWrapper(object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
65

66
    def __init__(self, ob):
67 68
        self.__ob = ob

69 70 71 72 73 74
    def __getattr__(self, name):
        return getattr(self.__ob, name)

    # We need to update the uid during the cataloging process
    uid = property(lambda self: self.__ob.uid,
                   lambda self, value: setattr(self.__ob, 'uid', value))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
75

76
    def _getSecurityParameterList(self):
77 78
      result = self.__dict__.get('_cache_result', None)
      if result is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79
        ob = self.__ob
80 81 82 83 84
        # 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'
85 86
        localroles = {}
        skip_role_set = set()
87 88
        skip_role = skip_role_set.add
        clear_skip_role = skip_role_set.clear
89
        for key, role_list in mergedLocalRoles(ob).iteritems():
90 91 92 93 94 95 96 97 98
          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:
99
            localroles[key] = new_role_list
100

101
        portal = ob.getPortalObject()
102 103 104 105
        role_dict = dict(portal.portal_catalog.getSQLCatalog().\
                                              getSQLCatalogRoleKeysList())
        getUserById = portal.acl_users.getUserById

106 107 108 109 110 111
        # 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.
112
        allowed = set(rolesForPermissionOn('View', ob))
113 114 115 116 117 118
        # XXX the permission name is included by default for verbose
        # logging of security errors, but the catalog does not need to
        # index it. Unfortunately, rolesForPermissionOn does not have
        # an option to disable this behavior at calling time, so
        # discard it explicitly.
        allowed.discard('_View_Permission')
119 120
        # XXX Owner is hardcoded, in order to prevent searching for user on the
        # site root.
121 122
        allowed.discard('Owner')
        add = allowed.add
123 124
        user_role_dict = {}
        user_view_permission_role_dict = {}
125
        for user, roles in localroles.iteritems():
126
          prefix = 'user:' + user
127
          for role in roles:
128
            if (role in role_dict) and (getUserById(user) is not None):
129 130 131 132 133 134
              # If role is monovalued, check if key is a user.
              # If not, continue to index it in roles_and_users table.
              user_role_dict[role] = user
              if role in allowed:
                user_view_permission_role_dict[role] = user
            elif role in allowed:
135 136
              add(prefix)
              add(prefix + ':' + role)
137

138 139 140
        self._cache_result = result = (sorted(allowed), user_role_dict,
                                       user_view_permission_role_dict)
      return result
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

    def allowedRolesAndUsers(self):
      """
      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.
      """
      return self._getSecurityParameterList()[0]

    def getAssignee(self):
      """Returns the user ID of the user with 'Assignee' local role on this
      document.

      If there is more than one Assignee local role, the result is undefined.
      """
      return self._getSecurityParameterList()[1].get('Assignee', None)

    def getViewPermissionAssignee(self):
      """Returns the user ID of the user with 'Assignee' local role on this
      document, if the Assignee role has View permission.

      If there is more than one Assignee local role, the result is undefined.
      """
      return self._getSecurityParameterList()[2].get('Assignee', None)

    def getViewPermissionAssignor(self):
      """Returns the user ID of the user with 'Assignor' local role on this
      document, if the Assignor role has View permission.

      If there is more than one Assignor local role, the result is undefined.
      """
      return self._getSecurityParameterList()[2].get('Assignor', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178

179 180 181 182
    def __repr__(self):
      return '<Products.ERP5Catalog.CatalogTool.IndexableObjectWrapper'\
          ' for %s>' % ('/'.join(self.__ob.getPhysicalPath()), )

183

184
class RelatedBaseCategory(Method):
185 186
    """A Dynamic Method to act as a related key.
    """
187
    def __init__(self, id, strict_membership=0, related=0):
188
      self._id = id
189
      self.strict_membership=strict_membership
190
      self.related = related
191

192
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
193
      """Create the sql code for this related key."""
194 195 196
      base_category_uid = instance.portal_categories._getOb(self._id).getUid()
      expression_list = []
      append = expression_list.append
197 198 199 200 201 202 203 204 205 206 207 208
      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))
209 210
      return ' '.join(expression_list)

211
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
212 213 214 215 216 217 218
    """
    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
219

Mame Coumba Sall's avatar
Mame Coumba Sall committed
220
    default_result_limit = None
221
    default_count_limit = 1
222
    
Vincent Pelletier's avatar
Vincent Pelletier committed
223
    manage_options = ({ 'label' : 'Overview', 'action' : 'manage_overview' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
224 225 226 227 228
                     ) + ZCatalog.manage_options

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

229
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
230 231 232
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Vincent Pelletier's avatar
Vincent Pelletier committed
233 234 235
    security.declareProtected(Permissions.ManagePortal
                , 'manage_schema')
    manage_schema = DTMLFile('dtml/manageSchema', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
236

Aurel's avatar
Aurel committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
    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
260
    security.declareProtected('Import/Export objects', 'addDefaultSQLMethods')
261
    def addDefaultSQLMethods(self, config_id='erp5'):
262 263 264
      """
        Add default SQL methods for a given configuration.
      """
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
      # 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 = []

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 447 448 449
    # 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
450
    security.declarePublic('getAllowedRolesAndUsers')
Aurel's avatar
Aurel committed
451
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
452 453
      """
        Return allowed roles and users.
454

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

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
      # 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
      for role, column_id in catalog.getSQLCatalogRoleKeysList():
        # XXX This should be a list
        if not user_is_superuser:
          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]
            proxy_roles = getattr(eo, '_proxy_roles', None)
            if not proxy_roles:
              role_column_dict[column_id] = user_str
          except IndexError:
            role_column_dict[column_id] = user_str

489 490
      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
491 492
      local_roles = kw.get('local_roles', None)
      if local_roles:
493 494
        local_role_dict = dict(catalog.getSQLCatalogLocalRoleKeysList())
        role_dict = dict(catalog.getSQLCatalogRoleKeysList())
495
        # XXX user is not enough - we should also include groups of the user
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
        new_allowedRolesAndUsers = []
        new_role_column_dict = {}
        # Turn it into a list if necessary according to ';' separator
        if isinstance(local_roles, str):
          local_roles = local_roles.split(';')
        # Local roles now has precedence (since it comes from a WorkList)
        for user_or_group in allowedRolesAndUsers:
          for role in local_roles:
            # Performance optimisation
            if local_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:
511
                # XXX This should be a list
512 513 514 515 516 517 518 519 520
                # 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:
521
                # XXX This should be a list
522 523 524 525 526 527 528
                # which also includes all user groups
                column_id = role_dict[role]
                new_role_column_dict[column_id] = user_str
            new_allowedRolesAndUsers.append('%s:%s' % (user_or_group, role))
        if local_role_column_dict == {}:
          allowedRolesAndUsers = new_allowedRolesAndUsers
          role_column_dict = new_role_column_dict
529

530

531
      return allowedRolesAndUsers, role_column_dict, local_role_column_dict
532

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

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

Vincent Pelletier's avatar
Vincent Pelletier committed
576
    security.declarePublic('getSecurityQuery')
Aurel's avatar
Aurel committed
577
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
578
      """
579 580 581
        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.
582
      """
583
      original_query = query
584 585 586
      security_uid_list, role_column_dict, local_role_column_dict = \
          self.getSecurityUidListAndRoleColumnDict(
              sql_catalog_id=sql_catalog_id, **kw)
587 588 589 590 591
      if role_column_dict:
        query_list = []
        for key, value in role_column_dict.items():
          new_query = Query(**{key : value})
          query_list.append(new_query)
592
        operator_kw = {'operator': 'OR'}
593 594 595 596 597 598 599
        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')
600
      elif security_uid_list:
601
        query = Query(security_uid=security_uid_list, operator='IN')
602 603 604 605 606 607 608 609
      else:
        # XXX A false query has to be generated. 
        # As it is not possible to use SQLKey for now, pass impossible value
        # on uid (which will be detected as False by MySQL, as it is not in the
        # column range)
        # Do not pass security_uid_list as empty in order to prevent useless
        # overhead
        query = Query(uid=-1)
610 611 612 613 614 615 616 617 618 619

      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')

620 621 622
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
623

Jean-Paul Smets's avatar
Jean-Paul Smets committed
624
    # searchResults has inherited security assertions.
625
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
626
        """
627 628
        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
629
        """
630 631 632 633 634
        #if not _checkPermission(
        #    Permissions.AccessInactivePortalContent, self):
        #    now = DateTime()
        #    kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
635

Aurel's avatar
Aurel committed
636 637
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
638
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
639 640 641 642
        # 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
643 644 645

    __call__ = searchResults

646 647 648 649
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
650
        kw.setdefault('limit', self.default_result_limit)
651 652
        return ZCatalog.searchResults(self, REQUEST, **kw)

653 654
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
655 656
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
657 658 659 660
        """
        A method to factor common code used to search a single
        object in the database.
        """
661
        kw.setdefault('limit', 1)
662 663 664 665 666
        result = self.searchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None
667 668 669 670 671 672 673 674

    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.
        """
675
        kw.setdefault('limit', 1)
676 677 678 679 680 681
        result = self.unrestrictedSearchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None

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

706 707 708 709 710 711 712 713 714 715
    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)

716 717 718
        document_object = aq_inner(object)
        w = IndexableObjectWrapper(document_object)

719
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
720
        if wf is not None:
721
          w.__dict__.update(wf.getCatalogVariablesFor(object))
722

723 724 725
        # Find the parent definition for security
        is_acquired = 0
        while getattr(document_object, 'isRADContent', 0):
726 727 728
          # This condition tells which object should acquire 
          # from their parent.
          # XXX Hardcode _View_Permission for a performance point of view
729 730
          if getattr(aq_base(document_object), '_View_Permission', ACQUIRE_PERMISSION_VALUE) == ACQUIRE_PERMISSION_VALUE\
             and document_object._getAcquireLocalRoles():
731
            document_object = document_object.aq_parent
732 733 734 735
            is_acquired = 1
          else:
            break
        if is_acquired:
736
          document_w = IndexableObjectWrapper(document_object)
737 738 739 740
        else:
          document_w = w

        (security_uid, optimised_roles_and_users) = catalog.getSecurityUid(document_w)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
741
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
742
        # XXX we should build vars begore building the wrapper
743
        w.optimised_roles_and_users = optimised_roles_and_users
744 745
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
746 747
          w.predicate_property_dict = predicate_property_dict
        w.security_uid = security_uid
748 749

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

    security.declarePrivate('reindexObject')
752
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
753 754 755 756
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
757
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
758
        url = self.__url(object)
759
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
760

761

Jean-Paul Smets's avatar
Jean-Paul Smets committed
762
    security.declarePrivate('unindexObject')
763
    def unindexObject(self, object=None, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
764 765 766
        """
          Remove from catalog.
        """
767
        if path is None and uid is None:
768 769
          if object is None:
            raise TypeError, 'One of uid, path and object parameters must not be None'
770
          path = self.__url(object)
771 772
        if uid is None:
          raise TypeError, "unindexObject supports only uid now"
773
        self.uncatalog_object(path=path, uid=uid, sql_catalog_id=sql_catalog_id)
774

Sebastien Robin's avatar
Sebastien Robin committed
775 776 777 778 779 780 781 782 783
    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)

784 785 786
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
787

Jean-Paul Smets's avatar
Jean-Paul Smets committed
788
    security.declarePrivate('moveObject')
789
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
790 791 792 793 794 795
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
796
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
797 798
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
799

800 801 802 803 804 805
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
806
      if not object.providesIPredicate():
807 808 809
        return None
      object = object.asPredicate()
      if object is None:
810 811 812 813 814 815 816 817 818 819 820
        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:
821
            property_dict['%s_range_min' % property] = min
822
          if max is not None:
823
            property_dict['%s_range_max' % property] = max
824
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
825 826
      return property_dict

827
    security.declarePrivate('getDynamicRelatedKeyList')
828
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
829
      """
830
      Return the list of dynamic related keys.
831 832
      This method will try to automatically generate new related key
      by looking at the category tree.
833 834 835 836

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
837 838 839 840
      strict_destination_title | category,catalog/title/z_related_strict_destination

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

            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))
893 894 895 896 897 898

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
899
      Will generate z_related_[base_category_id] if possible
900 901 902 903
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
        DYNAMIC_METHOD_NAME = 'z_related_'
904
        STRICT_DYNAMIC_METHOD_NAME = 'z_related_strict_'
905 906 907 908
        method_name_length = len(DYNAMIC_METHOD_NAME)
        zope_security = '__roles__'
        if (name.startswith(DYNAMIC_METHOD_NAME) and \
          (not name.endswith(zope_security))):
909 910 911 912 913 914 915 916 917

          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)
918
          else:
919 920 921 922 923 924 925
            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)

926
          setattr(self.__class__, name, method)
927 928 929 930 931
          klass = aq_base(self).__class__
          if hasattr(klass, 'security'):
            from Products.ERP5Type import Permissions as ERP5Permissions
            klass.security.declareProtected(ERP5Permissions.View, name)
          else:
932 933
            LOG('ERP5Catalog', PROBLEM,
                'Security not defined on %s' % klass.__name__)
934 935 936 937
          return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
938

939
InitializeClass(CatalogTool)