CatalogTool.py 38.5 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 29 30
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from Products.CMFCore.CatalogTool import CatalogTool as CMFCoreCatalogTool
from Products.ZSQLCatalog.ZSQLCatalog import ZCatalog
31
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
32
from Products.ERP5Type import Permissions
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33
from AccessControl import ClassSecurityInfo, getSecurityManager
34
from AccessControl.User import system as system_user
Aurel's avatar
Aurel committed
35 36
from Products.CMFCore.utils import UniqueObject, _getAuthenticatedUser, getToolByName
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
37
from Acquisition import aq_base, aq_inner, aq_parent, ImplicitAcquisitionWrapper
38
from Products.CMFActivity.ActiveObject import ActiveObject
39
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
40 41 42

from AccessControl.PermissionRole import rolesForPermissionOn

43
from MethodObject import Method
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44

45
from Products.ERP5Security import mergedLocalRoles
46
from Products.ERP5Security.ERP5UserManager import SUPER_USER
47
from Products.ERP5Type.Utils import sqlquote
48

Aurel's avatar
Aurel committed
49
import warnings
50
from zLOG import LOG, PROBLEM, WARNING, INFO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
51

52
ACQUIRE_PERMISSION_VALUE = []
53
DYNAMIC_METHOD_NAME = 'z_related_'
54
DYNAMIC_METHOD_NAME_LEN = len(DYNAMIC_METHOD_NAME)
55
STRICT_DYNAMIC_METHOD_NAME = DYNAMIC_METHOD_NAME + 'strict_'
56
STRICT_DYNAMIC_METHOD_NAME_LEN = len(STRICT_DYNAMIC_METHOD_NAME)
57
RELATED_DYNAMIC_METHOD_NAME = '_related'
58 59
# Negative as it's used as a slice end offset
RELATED_DYNAMIC_METHOD_NAME_LEN = -len(RELATED_DYNAMIC_METHOD_NAME)
60
ZOPE_SECURITY_SUFFIX = '__roles__'
Aurel's avatar
Aurel committed
61

62
class IndexableObjectWrapper(object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63

64
    def __init__(self, ob):
65 66
        self.__ob = ob

67 68 69 70
    def __getattr__(self, name):
        return getattr(self.__ob, name)

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

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

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

104 105
        allowed_dict = dict()

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_role_set = set(rolesForPermissionOn('View', ob))
113 114 115 116 117
        # 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.
118
        allowed_role_set.discard('_View_Permission')
119 120
        # XXX Owner is hardcoded, in order to prevent searching for user on the
        # site root.
121 122 123 124 125 126 127 128 129
        allowed_role_set.discard('Owner')

        # XXX make this a method of base ?
        local_roles_group_id_group_id = getattr(ob,
          '__ac_local_roles_group_id_dict__', dict())

        allowed_by_local_roles_group_id = dict()
        allowed_by_local_roles_group_id[''] = allowed_role_set

130 131
        user_role_dict = {}
        user_view_permission_role_dict = {}
132
        for user, roles in localroles.iteritems():
133
          prefix = 'user:' + user
134
          for role in roles:
135
            if (role in role_dict) and (getUserById(user) is not None):
136 137 138
              # 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
139
              if role in allowed_role_set:
140
                user_view_permission_role_dict[role] = user
141 142 143 144 145 146 147 148 149 150 151 152 153 154
            elif role in allowed_role_set:
              for group in local_roles_group_id_group_id.get(user, ('', )):
                allowed_by_local_roles_group_id.setdefault(group, set()).update(
                   (prefix, '%s:%s' % (prefix, role)))

        # sort `allowed` principals
        sorted_allowed_by_local_roles_group_id = dict()
        for local_roles_group_id, allowed in \
                allowed_by_local_roles_group_id.items():
          sorted_allowed_by_local_roles_group_id[local_roles_group_id] = tuple(
            sorted(allowed))

        self._cache_result = result = (sorted_allowed_by_local_roles_group_id,
                                       user_role_dict,
155 156
                                       user_view_permission_role_dict)
      return result
157

158 159 160
    def getLocalRolesGroupIdDict(self):
      """Returns a mapping of local roles group id to roles and users with View
      permission.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
      """
      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
187

188 189 190 191 192 193 194 195
    def getViewPermissionAssociate(self):
      """Returns the user ID of the user with 'Associate' local role on this
      document, if the Associate role has View permission.

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

196 197 198 199
    def __repr__(self):
      return '<Products.ERP5Catalog.CatalogTool.IndexableObjectWrapper'\
          ' for %s>' % ('/'.join(self.__ob.getPhysicalPath()), )

200

201
class RelatedBaseCategory(Method):
202 203
    """A Dynamic Method to act as a related key.
    """
204
    def __init__(self, id, strict_membership=0, related=0):
205
      self._id = id
206 207 208 209 210 211 212
      if strict_membership:
        strict = 'AND %(category_table)s.category_strict_membership = 1\n'
      else:
        strict = ''
      # From the point of view of query_table, we are looking up objects...
      if related:
        # ... which have a relation toward us
Vincent Pelletier's avatar
Vincent Pelletier committed
213 214 215 216
        # query_table's uid = category table's category_uid
        query_table_side = 'category_uid'
        # category table's uid = foreign_table's uid
        foreign_side = 'uid'
217 218
      else:
        # ... toward which we have a relation
Vincent Pelletier's avatar
Vincent Pelletier committed
219 220 221 222
        # query_table's uid = category table's uid
        query_table_side = 'uid'
        # category table's category_uid = foreign_table's uid
        foreign_side = 'category_uid'
223 224
      self._template = """\
%%(category_table)s.base_category_uid = %%(base_category_uid)s
Vincent Pelletier's avatar
Vincent Pelletier committed
225
%(strict)sAND %%(foreign_catalog)s.uid = %%(category_table)s.%(foreign_side)s
226 227
%%(RELATED_QUERY_SEPARATOR)s
%%(category_table)s.%(query_table_side)s = %%(query_table)s.uid""" % {
228
          'strict': strict,
Vincent Pelletier's avatar
Vincent Pelletier committed
229 230
          'foreign_side': foreign_side,
          'query_table_side': query_table_side,
231
      }
232

233 234
    def __call__(self, instance, table_0, table_1, query_table='catalog',
        RELATED_QUERY_SEPARATOR=' AND ', **kw):
235
      """Create the sql code for this related key."""
236 237 238 239 240
      # Note: in normal conditions, our category's uid will not change from
      # one invocation to the next.
      return self._template % {
        'base_category_uid': instance.getPortalObject().portal_categories.\
          _getOb(self._id).getUid(),
Vincent Pelletier's avatar
Vincent Pelletier committed
241
        'query_table': query_table,
242
        'category_table': table_0,
Vincent Pelletier's avatar
Vincent Pelletier committed
243
        'foreign_catalog': table_1,
244
        'RELATED_QUERY_SEPARATOR': RELATED_QUERY_SEPARATOR,
245
      }
246

247
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
248 249 250 251 252 253 254
    """
    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
255

Mame Coumba Sall's avatar
Mame Coumba Sall committed
256
    default_result_limit = None
257
    default_count_limit = 1
Aurel's avatar
Aurel committed
258

Vincent Pelletier's avatar
Vincent Pelletier committed
259
    manage_options = ({ 'label' : 'Overview', 'action' : 'manage_overview' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
260 261 262 263 264
                     ) + ZCatalog.manage_options

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

265
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
266 267 268
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Vincent Pelletier's avatar
Vincent Pelletier committed
269 270 271
    security.declareProtected(Permissions.ManagePortal
                , 'manage_schema')
    manage_schema = DTMLFile('dtml/manageSchema', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
272

Aurel's avatar
Aurel committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
    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
295

296
    def _listAllowedRolesAndUsers(self, user):
297
        # We use ERP5Security PAS based authentication
298 299 300
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
301
          proxy_roles = getattr(eo, '_proxy_roles',None)
302 303 304 305 306
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
Vincent Pelletier's avatar
Vincent Pelletier committed
307
          result = list(proxy_roles)
308
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
309 310 311
          result = list(user.getRoles())
        result.append('Anonymous')
        result.append('user:%s' % user.getId())
312 313 314
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
315
            groups = list(user.getGroups())
316 317 318 319 320 321
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
322
        return result
323

Jean-Paul Smets's avatar
Jean-Paul Smets committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 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
    # 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
390
    security.declarePublic('getAllowedRolesAndUsers')
Aurel's avatar
Aurel committed
391
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
392 393
      """
        Return allowed roles and users.
394

395
        This is supposed to be used with Z SQL Methods to check permissions
396
        when you list up documents. It is also able to take into account
397
        a parameter named local_roles so that listed documents only include
398 399
        those documents for which the user (or the group) was
        associated one of the given local roles.
Aurel's avatar
Aurel committed
400

401 402
        The use of getAllowedRolesAndUsers is deprecated, you should use
        getSecurityQuery instead
403 404
      """
      user = _getAuthenticatedUser(self)
405
      user_str = str(user)
406
      user_is_superuser = (user == system_user) or (user_str == SUPER_USER)
407
      allowedRolesAndUsers = self._listAllowedRolesAndUsers(user)
408
      role_column_dict = {}
409 410 411
      local_role_column_dict = {}
      catalog = self.getSQLCatalog(sql_catalog_id)
      column_map = catalog.getColumnMap()
412

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
      # 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

429 430
      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
431 432
      local_roles = kw.get('local_roles', None)
      if local_roles:
433 434
        local_role_dict = dict(catalog.getSQLCatalogLocalRoleKeysList())
        role_dict = dict(catalog.getSQLCatalogRoleKeysList())
435
        # XXX user is not enough - we should also include groups of the user
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
        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:
451
                # XXX This should be a list
452 453 454 455 456 457 458 459 460
                # 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:
461
                # XXX This should be a list
462 463 464 465 466 467 468
                # 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
469 470

      return allowedRolesAndUsers, role_column_dict, local_role_column_dict
471

472
    def getSecurityUidDictAndRoleColumnDict(self, sql_catalog_id=None, **kw):
473
      """
474 475
        Return a dict of local_roles_group_id -> security Uids and a
        dictionnary containing available role columns.
476 477 478 479

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
480
      """
481 482
      allowedRolesAndUsers, role_column_dict, local_role_column_dict = \
          self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
483
      catalog = self.getSQLCatalog(sql_catalog_id)
484
      method = getattr(catalog, catalog.sql_search_security, None)
485
      if allowedRolesAndUsers:
486
        allowedRolesAndUsers.sort()
487
        cache_key = tuple(allowedRolesAndUsers)
488
        tv = getTransactionalVariable()
489
        try:
490
          security_uid_cache = tv['getSecurityUidDictAndRoleColumnDict']
491
        except KeyError:
492
          security_uid_cache = tv['getSecurityUidDictAndRoleColumnDict'] = {}
493
        try:
494
          security_uid_dict = security_uid_cache[cache_key]
495
        except KeyError:
496 497 498 499
          if method is None:
            warnings.warn("The usage of allowedRolesAndUsers is "\
                          "deprecated. Please update your catalog "\
                          "business template.", DeprecationWarning)
500
            security_uid_dict = {None: [x.security_uid for x in \
501 502 503
              self.unrestrictedSearchResults(
                allowedRolesAndUsers=allowedRolesAndUsers,
                select_expression="security_uid",
504
                group_by_expression="security_uid")] }
505 506
          else:
            # XXX: What with this string transformation ?! Souldn't it be done in
507
            # dtml instead ? ... yes, but how to be bw compatible ?
508
            allowedRolesAndUsers = [sqlquote(role) for role in allowedRolesAndUsers]
509 510 511 512 513 514 515 516 517 518 519 520 521

            security_uid_dict = dict()
            for brain in method(security_roles_list=allowedRolesAndUsers):
              try:
                local_roles_group_id = brain.local_roles_group_id
              except AttributeError:
                LOG("ERP5Catalog", PROBLEM,
                    "sql_search_security is not up to date, falling back.")
                local_roles_group_id = ''
              security_uid_dict.setdefault(local_roles_group_id,
                  []).append(brain.uid)

          security_uid_cache[cache_key] = security_uid_dict
522
      else:
523 524
        security_uid_dict = []
      return security_uid_dict, role_column_dict, local_role_column_dict
525

Vincent Pelletier's avatar
Vincent Pelletier committed
526
    security.declarePublic('getSecurityQuery')
Aurel's avatar
Aurel committed
527
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
528
      """
529 530 531
        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.
532
      """
533 534 535 536 537 538
      user = _getAuthenticatedUser(self)
      user_str = str(user)
      user_is_superuser = (user == system_user) or (user_str == SUPER_USER)
      if user_is_superuser:
        # We need no security check for super user.
        return query
539
      original_query = query
540 541 542 543 544
      security_uid_dict, role_column_dict, local_role_column_dict = \
          self.getSecurityUidDictAndRoleColumnDict(sql_catalog_id=sql_catalog_id, **kw)

      role_query = None
      security_uid_query = None
545 546 547 548 549
      if role_column_dict:
        query_list = []
        for key, value in role_column_dict.items():
          new_query = Query(**{key : value})
          query_list.append(new_query)
550
        operator_kw = {'operator': 'OR'}
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
        role_query = ComplexQuery(*query_list, **operator_kw)
      if security_uid_dict:
        catalog_security_uid_groups_columns_dict = \
            self.getSQLCatalog().getSQLCatalogSecurityUidGroupsColumnsDict()

        query_list = []
        for local_roles_group_id, security_uid_list in\
                 security_uid_dict.iteritems():
          assert security_uid_list
          query_list.append(Query(**{
            catalog_security_uid_groups_columns_dict[local_roles_group_id]:
                  security_uid_list,
            'operator': 'IN'}))

        security_uid_query = ComplexQuery(*query_list, operator='OR')

      if role_query:
        if security_uid_query:
          # merge
          query = ComplexQuery(security_uid_query, role_query, operator='OR')
        else:
          query = role_query
      elif security_uid_query:
        query = security_uid_query

576
      else:
Aurel's avatar
Aurel committed
577
        # XXX A false query has to be generated.
578 579 580 581 582 583
        # 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)
584 585 586 587 588 589 590 591 592 593

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

594 595 596
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
597

Jean-Paul Smets's avatar
Jean-Paul Smets committed
598
    # searchResults has inherited security assertions.
599
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
600
        """
601 602
        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
603
        """
604 605 606 607 608
        #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
609

Aurel's avatar
Aurel committed
610 611
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
612
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
613 614 615 616
        # 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
617 618 619

    __call__ = searchResults

620 621 622 623
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
624
        kw.setdefault('limit', self.default_result_limit)
625 626
        return ZCatalog.searchResults(self, REQUEST, **kw)

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

    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.
        """
649
        kw.setdefault('limit', 1)
650 651 652 653 654 655
        result = self.unrestrictedSearchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None

656
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
657 658 659 660
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
661
        # XXX This needs to be set again
662
        #if not _checkPermission(
Vincent Pelletier's avatar
Vincent Pelletier committed
663 664
        #    Permissions.AccessInactivePortalContent, self):
        #    base = aq_base(self)
665 666 667
        #    now = DateTime()
        #    #kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    #kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Aurel's avatar
Aurel committed
668
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
Aurel's avatar
Aurel committed
669
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
670
        kw.setdefault('limit', self.default_count_limit)
Aurel's avatar
Aurel committed
671 672
        # get catalog from preference
        return ZCatalog.countResults(self, query=query, sql_catalog_id=catalog_id, **kw)
Aurel's avatar
Aurel committed
673

674 675 676 677 678
    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
679

680 681 682 683 684 685 686 687 688 689
    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)

690 691 692
        document_object = aq_inner(object)
        w = IndexableObjectWrapper(document_object)

693
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
694
        if wf is not None:
695
          w.__dict__.update(wf.getCatalogVariablesFor(object))
696

697 698 699
        # Find the parent definition for security
        is_acquired = 0
        while getattr(document_object, 'isRADContent', 0):
Aurel's avatar
Aurel committed
700
          # This condition tells which object should acquire
701 702
          # from their parent.
          # XXX Hardcode _View_Permission for a performance point of view
703 704
          if getattr(aq_base(document_object), '_View_Permission', ACQUIRE_PERMISSION_VALUE) == ACQUIRE_PERMISSION_VALUE\
             and document_object._getAcquireLocalRoles():
705
            document_object = document_object.aq_parent
706 707 708 709
            is_acquired = 1
          else:
            break
        if is_acquired:
710
          document_w = IndexableObjectWrapper(document_object)
711 712 713
        else:
          document_w = w

714 715 716 717
        (security_uid_dict, optimised_roles_and_users) = \
              catalog.getSecurityUidDict(document_w)


718
        w.optimised_roles_and_users = optimised_roles_and_users
719 720 721 722 723 724 725 726 727 728 729

        catalog_security_uid_groups_columns_dict = \
            catalog.getSQLCatalogSecurityUidGroupsColumnsDict()
        default_security_uid_column = catalog_security_uid_groups_columns_dict['']
        for local_roles_group_id, security_uid in security_uid_dict.items():
          catalog_column = catalog_security_uid_groups_columns_dict.get(
                local_roles_group_id, default_security_uid_column)
          setattr(w, catalog_column, security_uid)

        # XXX we should build vars begore building the wrapper

730 731
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
732
          w.predicate_property_dict = predicate_property_dict
733
        else:
Aurel's avatar
Aurel committed
734
          w.predicate_property_dict = {}
735

736 737 738
        (subject_set_uid, optimised_subject_list) = catalog.getSubjectSetUid(document_w)
        w.optimised_subject_list = optimised_subject_list
        w.subject_set_uid = subject_set_uid
739 740

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

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

752

753 754
    def catalogObjectList(self, object_list, *args, **kw):
        """Catalog a list of objects"""
755 756
        m = object_list[0]
        if type(m) is list:
757
          tmp_object_list = [x[0] for x in object_list]
758 759 760 761 762
          super(CatalogTool, self).catalogObjectList(tmp_object_list, **m[2])
          if tmp_object_list:
            for x in object_list:
              if x[0] in tmp_object_list:
                del object_list[3] # no result means failed
763 764 765
        else:
          super(CatalogTool, self).catalogObjectList(object_list, *args, **kw)

766 767 768
    security.declarePrivate('uncatalogObjectList')
    def uncatalogObjectList(self, message_list):
      """Uncatalog a list of objects"""
769 770
      # XXX: this is currently only a placeholder for further optimization
      #      (for the moment, it's not faster than the dummy group method)
771 772
      for m in message_list:
        self.unindexObject(*m[1], **m[2])
773

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

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

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

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

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

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

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

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

      strict_ related keys only returns documents which are strictly member of
      the category.
853 854
      """
      related_key_list = []
855
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
856
      default_string = 'default_'
857
      strict_string = 'strict_'
858
      for key in key_list:
859
        prefix = ''
860
        strict = 0
861 862 863
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
864 865 866 867
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
868
        splitted_key = key.split('_')
869 870
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
871 872
        for i in range(1,len(splitted_key))[::-1]:
          expected_base_cat_id = '_'.join(splitted_key[0:i])
873
          if expected_base_cat_id != 'parent' and \
874 875 876
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
877 878 879

            if end_key.startswith('related_'):
              end_key = end_key[len('related_'):]
880
              suffix = '_related'
881
            else:
882 883 884 885 886 887 888 889 890 891 892
              suffix = ''
            # accept only some catalog columns
            if end_key in ('title', 'uid', 'description', 'reference',
                           'relative_url', 'id', 'portal_type',
                           'simulation_state'):
              if strict:
                pattern = '%s%s | category,catalog/%s/z_related_strict_%s%s'
              else:
                pattern = '%s%s | category,catalog/%s/z_related_%s%s'
              related_key_list.append(pattern %
                (prefix, key, end_key, expected_base_cat_id, suffix))
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
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
901 902 903
      result = None
      if name.startswith(DYNAMIC_METHOD_NAME) and \
          not name.endswith(ZOPE_SECURITY_SUFFIX):
904
        kw = {}
Vincent Pelletier's avatar
Vincent Pelletier committed
905
        if name.endswith(RELATED_DYNAMIC_METHOD_NAME):
906 907
          end_offset = RELATED_DYNAMIC_METHOD_NAME_LEN
          kw['related'] = 1
908
        else:
909 910 911 912 913 914 915
          end_offset = None
        if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
          start_offset = STRICT_DYNAMIC_METHOD_NAME_LEN
          kw['strict_membership'] = 1
        else:
          start_offset = DYNAMIC_METHOD_NAME_LEN
        method = RelatedBaseCategory(name[start_offset:end_offset], **kw)
Vincent Pelletier's avatar
Vincent Pelletier committed
916
        setattr(self.__class__, name, method)
917 918 919 920 921 922
        # This getattr has 2 purposes:
        # - wrap in acquisition context
        #   This alone should be explicitly done rather than through getattr.
        # - wrap (if needed) class attribute on the instance
        #   (for the sake of not relying on current implementation details
        #   "too much")
Vincent Pelletier's avatar
Vincent Pelletier committed
923 924
        result = getattr(self, name)
      return result
925

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
    def _searchAndActivate(self, method_id, method_args=(), method_kw={},
                           activate_kw={}, min_uid=None, **kw):
      """Search the catalog and run a script by activity on all found objects

      This method is configurable (via 'packet_size' & 'activity_count'
      parameters) so that it can work efficiently with databases of any size.

      'activate_kw' may specify an active process to collect results.
      """
      catalog_kw = dict(kw)
      packet_size = catalog_kw.pop('packet_size', 30)
      limit = packet_size * catalog_kw.pop('activity_count', 100)
      if min_uid:
        catalog_kw['uid'] = {'query': min_uid, 'range': 'nlt'}
      if catalog_kw.pop('restricted', False):
        search = self
      else:
        search = self.unrestrictedSearchResults
      r = search(sort_on=(('uid','ascending'),), limit=limit, **catalog_kw)
      result_count = len(r)
      if result_count:
        if result_count == limit:
948 949
          next_kw = dict(activate_kw, priority=1+activate_kw.get('priority', 1))
          self.activate(activity='SQLQueue', **next_kw) \
950
              ._searchAndActivate(method_id,method_args, method_kw,
951
                                  activate_kw, r[-1].getUid(), **kw)
952 953 954 955 956 957 958 959 960 961 962 963
        r = [x.getPath() for x in r]
        r.sort()
        activate = self.getPortalObject().portal_activities.activate
        for i in xrange(0, result_count, packet_size):
          activate(activity='SQLQueue', **activate_kw).callMethodOnObjectList(
            r[i:i+packet_size], method_id, *method_args, **method_kw)

    security.declarePublic('searchAndActivate')
    def searchAndActivate(self, *args, **kw):
      """Restricted version of _searchAndActivate"""
      return self._searchAndActivate(restricted=True, *args, **kw)

964
InitializeClass(CatalogTool)