CatalogTool.py 42 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
import sys
30
from copy import deepcopy
31
from collections import defaultdict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33
from Products.CMFCore.CatalogTool import CatalogTool as CMFCoreCatalogTool
from Products.ZSQLCatalog.ZSQLCatalog import ZCatalog
34
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery, SimpleQuery
35
from Products.ERP5Type import Permissions
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36
from AccessControl import ClassSecurityInfo, getSecurityManager
37
from AccessControl.User import system as system_user
Aurel's avatar
Aurel committed
38 39
from Products.CMFCore.utils import UniqueObject, _getAuthenticatedUser, getToolByName
from Products.ERP5Type.Globals import InitializeClass, DTMLFile
40
from Acquisition import aq_base, aq_inner, aq_parent, ImplicitAcquisitionWrapper
41
from Products.CMFActivity.ActiveObject import ActiveObject
42
from Products.CMFActivity.ActivityTool import GroupedMessage
43
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
44 45 46

from AccessControl.PermissionRole import rolesForPermissionOn

47
from MethodObject import Method
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48

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

Aurel's avatar
Aurel committed
53
import warnings
54
from zLOG import LOG, PROBLEM, WARNING, INFO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
55

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

66
class IndexableObjectWrapper(object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

68
    def __init__(self, ob):
69 70
        self.__ob = ob

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

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

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

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

108
        allowed_dict = {}
109

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

        # XXX make this a method of base ?
128
        local_roles_group_id_group_id = deepcopy(getattr(ob,
129
          '__ac_local_roles_group_id_dict__', {}))
130 131 132 133 134 135 136 137 138 139

        # If we acquire a permission, then we also want to acquire the local
        # roles group ids
        local_roles_container = ob
        while getattr(local_roles_container, 'isRADContent', 0):
          if local_roles_container._getAcquireLocalRoles():
            local_roles_container = local_roles_container.aq_parent
            for role_definition_group, user_and_role_list in \
                getattr(local_roles_container,
                        '__ac_local_roles_group_id_dict__',
140
                        {}).items():
141 142 143 144
              local_roles_group_id_group_id.setdefault(role_definition_group, set()
                ).update(user_and_role_list)
          else:
            break
145

146
        allowed_by_local_roles_group_id = {}
147 148
        allowed_by_local_roles_group_id[''] = allowed_role_set

149 150
        user_role_dict = {}
        user_view_permission_role_dict = {}
151 152 153
        optimized_role_set = set()
        # First parse optimized roles and build optimized_role_set
        for role_definition_group, user_and_role_list in local_roles_group_id_group_id.items():
154 155
          group_allowed_set = allowed_by_local_roles_group_id.setdefault(
            role_definition_group, set())
156
          for user, role in user_and_role_list:
157 158 159 160
            if role in allowed_role_set:
              prefix = 'user:' + user
              group_allowed_set.update((prefix, '%s:%s' % (prefix, role)))
              optimized_role_set.add((user, role))
161

162
        # Then parse other roles
163
        for user, roles in localroles.iteritems():
164
          prefix = 'user:' + user
Jérome Perrin's avatar
Jérome Perrin committed
165
          for role in roles:
166
            if (role in role_dict) and (getUserById(user) is not None):
167 168
              # If role is monovalued, check if key is a user.
              # If not, continue to index it in roles_and_users table.
169 170
              if (user, role) not in optimized_role_set:
                user_role_dict[role] = user # Only add to user_role_dict if not in optimized_role_set (double check)
171 172 173 174
              if role in allowed_role_set:
                user_view_permission_role_dict[role] = user
            elif role in allowed_role_set:
              for group in local_roles_group_id_group_id.get(user, ('', )):
175 176
                group_allowed_set = allowed_by_local_roles_group_id.setdefault(
                  group, set())
177 178 179
                if (user, role) not in optimized_role_set:
                  # add only if not already added to optimized_role_set to avoid polluting indexation table
                  group_allowed_set.update((prefix, '%s:%s' % (prefix, role)))
180

181
        # sort `allowed` principals
182
        sorted_allowed_by_local_roles_group_id = {}
183 184 185 186 187 188 189
        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,
190 191
                                       user_view_permission_role_dict)
      return result
192

193 194 195
    def getLocalRolesGroupIdDict(self):
      """Returns a mapping of local roles group id to roles and users with View
      permission.
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
      """
      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
222

223 224 225 226 227 228 229 230
    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)

231 232 233 234
    def __repr__(self):
      return '<Products.ERP5Catalog.CatalogTool.IndexableObjectWrapper'\
          ' for %s>' % ('/'.join(self.__ob.getPhysicalPath()), )

235

236
class RelatedBaseCategory(Method):
237 238
    """A Dynamic Method to act as a related key.
    """
239
    def __init__(self, id, strict_membership=0, related=0):
240
      self._id = id
241 242 243 244 245 246 247
      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
248 249 250 251
        # 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'
252 253
      else:
        # ... toward which we have a relation
254 255 256 257
        # 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'
258 259
      self._template = """\
%%(category_table)s.base_category_uid = %%(base_category_uid)s
260
%(strict)sAND %%(foreign_catalog)s.uid = %%(category_table)s.%(foreign_side)s
261 262
%%(RELATED_QUERY_SEPARATOR)s
%%(category_table)s.%(query_table_side)s = %%(query_table)s.uid""" % {
263
          'strict': strict,
264 265
          'foreign_side': foreign_side,
          'query_table_side': query_table_side,
266
      }
267 268 269 270 271 272
      self._monotable_template = """\
%%(category_table)s.base_category_uid = %%(base_category_uid)s
%(strict)sAND %%(category_table)s.%(query_table_side)s = %%(query_table)s.uid""" % {
          'strict': strict,
          'query_table_side': query_table_side,
      }
273

274
    def __call__(self, instance, table_0, table_1=None, query_table='catalog',
275
        RELATED_QUERY_SEPARATOR=' AND ', **kw):
276
      """Create the sql code for this related key."""
277 278
      # Note: in normal conditions, our category's uid will not change from
      # one invocation to the next.
279 280 281
      return (
        self._monotable_template if table_1 is None else self._template
      ) % {
282 283
        'base_category_uid': instance.getPortalObject().portal_categories.\
          _getOb(self._id).getUid(),
284
        'query_table': query_table,
285
        'category_table': table_0,
286
        'foreign_catalog': table_1,
287
        'RELATED_QUERY_SEPARATOR': RELATED_QUERY_SEPARATOR,
288
      }
289

290
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
291 292 293 294 295 296 297
    """
    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
298

299
    default_result_limit = None
300
    default_count_limit = 1
Aurel's avatar
Aurel committed
301

Vincent Pelletier's avatar
Vincent Pelletier committed
302
    manage_options = ({ 'label' : 'Overview', 'action' : 'manage_overview' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
303 304 305 306 307
                     ) + ZCatalog.manage_options

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

308
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
309 310 311
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Vincent Pelletier's avatar
Vincent Pelletier committed
312 313 314
    security.declareProtected(Permissions.ManagePortal
                , 'manage_schema')
    manage_schema = DTMLFile('dtml/manageSchema', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
315

Aurel's avatar
Aurel committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    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
338

339
    def _listAllowedRolesAndUsers(self, user):
340
        # We use ERP5Security PAS based authentication
341 342 343
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
344
          proxy_roles = getattr(eo, '_proxy_roles',None)
345 346 347 348 349
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
Vincent Pelletier's avatar
Vincent Pelletier committed
350
          result = list(proxy_roles)
351
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
352 353 354
          result = list(user.getRoles())
        result.append('Anonymous')
        result.append('user:%s' % user.getId())
355 356 357
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
358
            groups = list(user.getGroups())
359 360 361 362 363 364
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
Jérome Perrin's avatar
Jérome Perrin committed
365
        return result
366

Jean-Paul Smets's avatar
Jean-Paul Smets committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    # 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
433
    security.declarePublic('getAllowedRolesAndUsers')
Aurel's avatar
Aurel committed
434
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
435 436
      """
        Return allowed roles and users.
437

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

444 445
        The use of getAllowedRolesAndUsers is deprecated, you should use
        getSecurityQuery instead
446 447
      """
      user = _getAuthenticatedUser(self)
448
      user_str = str(user)
449
      user_is_superuser = (user == system_user) or (user_str == SUPER_USER)
450
      allowedRolesAndUsers = self._listAllowedRolesAndUsers(user)
451
      role_column_dict = {}
452 453 454
      local_role_column_dict = {}
      catalog = self.getSQLCatalog(sql_catalog_id)
      column_map = catalog.getColumnMap()
455

456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
      # 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

472 473
      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
474 475
      local_roles = kw.get('local_roles', None)
      if local_roles:
476 477
        local_role_dict = dict(catalog.getSQLCatalogLocalRoleKeysList())
        role_dict = dict(catalog.getSQLCatalogRoleKeysList())
478
        # XXX user is not enough - we should also include groups of the user
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
        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:
494
                # XXX This should be a list
495 496 497 498 499 500 501 502 503
                # 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:
504
                # XXX This should be a list
505 506 507 508 509 510 511
                # 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
512 513

      return allowedRolesAndUsers, role_column_dict, local_role_column_dict
514

515
    def getSecurityUidDictAndRoleColumnDict(self, sql_catalog_id=None, **kw):
516
      """
517 518
        Return a dict of local_roles_group_id -> security Uids and a
        dictionnary containing available role columns.
519 520 521 522

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
523
      """
524 525
      allowedRolesAndUsers, role_column_dict, local_role_column_dict = \
          self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
526
      catalog = self.getSQLCatalog(sql_catalog_id)
527
      method = getattr(catalog, catalog.sql_search_security, None)
528
      if allowedRolesAndUsers:
529
        allowedRolesAndUsers.sort()
530
        cache_key = tuple(allowedRolesAndUsers)
531
        tv = getTransactionalVariable()
532
        try:
533
          security_uid_cache = tv['getSecurityUidDictAndRoleColumnDict']
534
        except KeyError:
535
          security_uid_cache = tv['getSecurityUidDictAndRoleColumnDict'] = {}
536
        try:
537
          security_uid_dict = security_uid_cache[cache_key]
538
        except KeyError:
539 540 541 542
          if method is None:
            warnings.warn("The usage of allowedRolesAndUsers is "\
                          "deprecated. Please update your catalog "\
                          "business template.", DeprecationWarning)
543
            security_uid_dict = {None: [x.security_uid for x in \
544 545 546
              self.unrestrictedSearchResults(
                allowedRolesAndUsers=allowedRolesAndUsers,
                select_expression="security_uid",
547
                group_by_expression="security_uid")] }
548 549
          else:
            # XXX: What with this string transformation ?! Souldn't it be done in
550
            # dtml instead ? ... yes, but how to be bw compatible ?
551
            allowedRolesAndUsers = [sqlquote(role) for role in allowedRolesAndUsers]
552

553
            security_uid_dict = defaultdict(list)
554
            for brain in method(security_roles_list=allowedRolesAndUsers):
555 556
              security_uid_dict[getattr(brain, 'local_roles_group_id', '')
                ].append(brain.uid)
557 558

          security_uid_cache[cache_key] = security_uid_dict
559
      else:
560 561
        security_uid_dict = []
      return security_uid_dict, role_column_dict, local_role_column_dict
562

Vincent Pelletier's avatar
Vincent Pelletier committed
563
    security.declarePublic('getSecurityQuery')
Aurel's avatar
Aurel committed
564
    def getSecurityQuery(self, query=None, sql_catalog_id=None, **kw):
565
      """
566 567 568
        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.
569
      """
570 571 572 573 574 575
      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
576
      original_query = query
577 578 579 580 581
      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
582 583 584 585 586
      if role_column_dict:
        query_list = []
        for key, value in role_column_dict.items():
          new_query = Query(**{key : value})
          query_list.append(new_query)
587
        operator_kw = {'operator': 'OR'}
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
        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

613
      else:
Aurel's avatar
Aurel committed
614
        # XXX A false query has to be generated.
615 616 617 618 619 620
        # 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)
621 622 623 624 625 626 627 628 629 630

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

631 632 633
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
634

Jean-Paul Smets's avatar
Jean-Paul Smets committed
635
    # searchResults has inherited security assertions.
636
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
637
        """
638 639
        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
640
        """
641 642 643 644 645
        #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
646

Aurel's avatar
Aurel committed
647 648
        catalog_id = self.getPreferredSQLCatalogId(kw.pop("sql_catalog_id", None))
        query = self.getSecurityQuery(query=query, sql_catalog_id=catalog_id, **kw)
649
        kw.setdefault('limit', self.default_result_limit)
Aurel's avatar
Aurel committed
650 651 652 653
        # 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
654 655 656

    __call__ = searchResults

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

664 665
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
666 667
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
668 669 670 671
        """
        A method to factor common code used to search a single
        object in the database.
        """
672
        kw.setdefault('limit', 1)
673 674 675 676 677
        result = self.searchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None
678 679 680 681 682 683 684 685

    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.
        """
686
        kw.setdefault('limit', 1)
687 688 689 690 691 692
        result = self.unrestrictedSearchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None

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

711 712 713 714 715
    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
716

717 718 719 720 721 722 723 724 725 726
    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)

727 728 729
        document_object = aq_inner(object)
        w = IndexableObjectWrapper(document_object)

730
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
731
        if wf is not None:
732
          w.__dict__.update(wf.getCatalogVariablesFor(object))
733

734 735 736
        # Find the parent definition for security
        is_acquired = 0
        while getattr(document_object, 'isRADContent', 0):
Aurel's avatar
Aurel committed
737
          # This condition tells which object should acquire
738 739
          # from their parent.
          # XXX Hardcode _View_Permission for a performance point of view
740 741
          if getattr(aq_base(document_object), '_View_Permission', ACQUIRE_PERMISSION_VALUE) == ACQUIRE_PERMISSION_VALUE\
             and document_object._getAcquireLocalRoles():
742
            document_object = document_object.aq_parent
743 744 745 746
            is_acquired = 1
          else:
            break
        if is_acquired:
747
          document_w = IndexableObjectWrapper(document_object)
748 749 750
        else:
          document_w = w

751 752 753 754
        (security_uid_dict, optimised_roles_and_users) = \
              catalog.getSecurityUidDict(document_w)


755
        w.optimised_roles_and_users = optimised_roles_and_users
756 757 758 759 760 761 762 763 764 765 766

        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

767 768
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
769
          w.predicate_property_dict = predicate_property_dict
770
        else:
Aurel's avatar
Aurel committed
771
          w.predicate_property_dict = {}
772

773 774 775
        (subject_set_uid, optimised_subject_list) = catalog.getSubjectSetUid(document_w)
        w.optimised_subject_list = optimised_subject_list
        w.subject_set_uid = subject_set_uid
776 777

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

    security.declarePrivate('reindexObject')
780
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
781 782 783 784
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
785
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
786
        url = self.__url(object)
787
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
788

789

790 791
    def catalogObjectList(self, object_list, *args, **kw):
        """Catalog a list of objects"""
792
        m = object_list[0]
793 794 795
        if isinstance(m, GroupedMessage):
          tmp_object_list = [x.object for x in object_list]
          super(CatalogTool, self).catalogObjectList(tmp_object_list, **m.kw)
796
          if tmp_object_list:
797 798
            exc_info = sys.exc_info()
          for x in object_list:
799 800
            if x.object in tmp_object_list:
              x.raised(exc_info)
801
            else:
802
              x.result = None
803 804 805
        else:
          super(CatalogTool, self).catalogObjectList(object_list, *args, **kw)

806 807 808
    security.declarePrivate('uncatalogObjectList')
    def uncatalogObjectList(self, message_list):
      """Uncatalog a list of objects"""
809
      # TODO: this is currently only a placeholder for further optimization
810 811
      try:
        for m in message_list:
812
          m.result = self.unindexObject(*m.args, **m.kw)
813
      except Exception:
814
        m.raised()
815

Jean-Paul Smets's avatar
Jean-Paul Smets committed
816
    security.declarePrivate('unindexObject')
817
    def unindexObject(self, object=None, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
818 819 820
        """
          Remove from catalog.
        """
821
        if path is None and uid is None:
822 823
          if object is None:
            raise TypeError, 'One of uid, path and object parameters must not be None'
824
          path = self.__url(object)
825 826
        if uid is None:
          raise TypeError, "unindexObject supports only uid now"
827
        self.uncatalog_object(path=path, uid=uid, sql_catalog_id=sql_catalog_id)
828

829 830 831 832 833 834 835 836 837
    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)

838 839 840
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
841

Jean-Paul Smets's avatar
Jean-Paul Smets committed
842
    security.declarePrivate('moveObject')
843
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
844 845 846 847 848 849
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
850
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
851 852
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
853

854 855 856 857 858 859
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
860
      if not object.providesIPredicate():
861 862 863
        return None
      object = object.asPredicate()
      if object is None:
864 865 866 867 868 869 870 871 872 873 874
        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:
875
            property_dict['%s_range_min' % property] = min
876
          if max is not None:
877
            property_dict['%s_range_max' % property] = max
878
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
879 880
      return property_dict

881
    security.declarePrivate('getDynamicRelatedKeyList')
882
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
883
      """
884
      Return the list of dynamic related keys.
885 886
      This method will try to automatically generate new related key
      by looking at the category tree.
887 888

      For exemple it will generate:
889 890 891
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
      strict_destination_title | category,catalog/title/z_related_strict_destination
892 893 894

      strict_ related keys only returns documents which are strictly member of
      the category.
895 896
      """
      related_key_list = []
897
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
898
      default_string = 'default_'
899
      strict_string = 'strict_'
900
      related_string = 'related_'
901
      column_map = self.getSQLCatalog(sql_catalog_id).getColumnMap()
902
      for key in key_list:
903
        prefix = ''
904
        strict = 0
905 906 907
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
908 909 910 911
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
912
        splitted_key = key.split('_')
913 914
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
915
        for i in xrange(len(splitted_key) - 1, 0, -1):
916
          expected_base_cat_id = '_'.join(splitted_key[0:i])
917
          if expected_base_cat_id != 'parent' and \
918 919 920
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
921 922 923
            related = end_key.startswith(related_string)
            if related:
              end_key = end_key[len(related_string):]
924
            # XXX: joining with non-catalog tables is not trivial and requires
925 926 927
            # ZSQLCatalog's ColumnMapper cooperation, so only allow catalog
            # columns.
            if 'catalog' in column_map.get(end_key, ()):
928 929 930 931 932 933 934 935 936 937 938 939 940
              is_uid = end_key == 'uid'
              if is_uid:
                end_key = 'uid' if related else 'category_uid'
              related_key_list.append(
                prefix + key + ' | category' +
                ('' if is_uid else ',catalog') +
                '/' +
                end_key +
                '/z_related_' +
                ('strict_' if strict else '') +
                expected_base_cat_id +
                ('_related' if related else '')
              )
941 942 943 944 945 946

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
947
      Will generate z_related_[base_category_id] if possible
948
      """
949 950 951
      result = None
      if name.startswith(DYNAMIC_METHOD_NAME) and \
          not name.endswith(ZOPE_SECURITY_SUFFIX):
952
        kw = {}
953
        if name.endswith(RELATED_DYNAMIC_METHOD_NAME):
954 955
          end_offset = RELATED_DYNAMIC_METHOD_NAME_LEN
          kw['related'] = 1
956
        else:
957 958 959 960 961 962 963
          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)
964
        setattr(self.__class__, name, method)
965 966 967 968 969 970
        # 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")
971 972
        result = getattr(self, name)
      return result
973

974 975 976 977 978 979
    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.
980 981 982 983
      'select_method_id', if provided, will be called with partial catalog
      results and returned value will be provided to the callable identified by
      'method_id' (which will no longer be invoked in the context of a given
      document returned by catalog) as first positional argument.
984 985 986 987 988 989

      '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)
990
      select_method_id = catalog_kw.pop('select_method_id', None)
991
      if min_uid:
992 993
        catalog_kw['min_uid'] = SimpleQuery(uid=min_uid,
                                            comparison_operator='>')
994 995 996 997 998 999 1000 1001
      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:
1002 1003
          next_kw = dict(activate_kw, priority=1+activate_kw.get('priority', 1))
          self.activate(activity='SQLQueue', **next_kw) \
1004
              ._searchAndActivate(method_id,method_args, method_kw,
1005
                                  activate_kw, r[-1].getUid(), **kw)
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
        portal_activities = self.getPortalObject().portal_activities
        active_portal_activities = portal_activities.activate(
          activity='SQLQueue', **activate_kw)
        if select_method_id is None:
          r = [x.getPath() for x in r]
          r.sort()
          activate = active_portal_activities.callMethodOnObjectList
          method_args = (method_id, ) + method_args
        else:
          r = getattr(portal_activities, select_method_id)(r)
          activate = getattr(active_portal_activities, method_id)
1017
        for i in xrange(0, result_count, packet_size):
1018
          activate(r[i:i+packet_size], *method_args, **method_kw)
1019 1020 1021 1022 1023 1024

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

1025 1026
    security.declareProtected(Permissions.ManagePortal, 'upgradeSchema')
    def upgradeSchema(self, sql_catalog_id=None, src__=0):
1027
      """Upgrade all catalog tables, with ALTER or CREATE queries"""
1028 1029 1030
      catalog = self.getSQLCatalog(sql_catalog_id)
      connection_id = catalog.z_create_catalog.connection_id
      src = []
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
      db = self.getPortalObject()[connection_id]()
      with db.lock():
        for clear_method in catalog.sql_clear_catalog:
          r = catalog[clear_method]._upgradeSchema(
            connection_id, create_if_not_exists=1, src__=1)
          if r:
            src.append(r)
        if not src__:
          for r in src:
            db.query(r)
1041 1042 1043
      return src


1044
InitializeClass(CatalogTool)