CatalogTool.py 40.6 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

29
from ZODB.POSException import ConflictError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from Products.CMFCore.CatalogTool import CatalogTool as CMFCoreCatalogTool
from Products.ZSQLCatalog.ZSQLCatalog import ZCatalog
32
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
33
from Products.ERP5Type import Permissions
34
from Products.ERP5Type.Cache import CachingMethod
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35
from AccessControl import ClassSecurityInfo, getSecurityManager
36
from Products.CMFCore.utils import UniqueObject, _checkPermission, _getAuthenticatedUser, getToolByName
37
from Products.ERP5Type.Globals import InitializeClass, DTMLFile, package_home
38
from Acquisition import aq_base, aq_inner, aq_parent, ImplicitAcquisitionWrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39
from DateTime.DateTime import DateTime
40
from Products.CMFActivity.ActiveObject import ActiveObject
41
from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
Jean-Paul Smets's avatar
Jean-Paul Smets committed
42 43 44 45 46 47

from AccessControl.PermissionRole import rolesForPermissionOn

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

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

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

58 59
ACQUIRE_PERMISSION_VALUE = []

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

63 64 65 66
DYNAMIC_METHOD_NAME = 'z_related_'
STRICT_DYNAMIC_METHOD_NAME = DYNAMIC_METHOD_NAME + 'strict_'
RELATED_DYNAMIC_METHOD_NAME = '_related'
ZOPE_SECURITY_SUFFIX = '__roles__'
Aurel's avatar
Aurel committed
67

68
class IndexableObjectWrapper(object):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
69

70
    def __init__(self, ob):
71 72
        self.__ob = ob

73 74 75 76
    def __getattr__(self, name):
        return getattr(self.__ob, name)

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

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

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

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

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

    def allowedRolesAndUsers(self):
      """
      Return a list of roles and users with View permission.
      Used by Portal Catalog to filter out items you're not allowed to see.

      WARNING (XXX): some user base local role association is currently
      being stored (ex. to be determined). This should be prevented or it will
      make the table explode. To analyse the symptoms, look at the
      user_and_roles table. You will find some user:foo values
      which are not necessary.
      """
      return self._getSecurityParameterList()[0]

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

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

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

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

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

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

183 184 185 186
    def __repr__(self):
      return '<Products.ERP5Catalog.CatalogTool.IndexableObjectWrapper'\
          ' for %s>' % ('/'.join(self.__ob.getPhysicalPath()), )

187

188
class RelatedBaseCategory(Method):
189 190
    """A Dynamic Method to act as a related key.
    """
191
    def __init__(self, id, strict_membership=0, related=0):
192
      self._id = id
193
      self.strict_membership=strict_membership
194
      self.related = related
195

196
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
197
      """Create the sql code for this related key."""
198 199 200
      base_category_uid = instance.portal_categories._getOb(self._id).getUid()
      expression_list = []
      append = expression_list.append
201 202 203 204 205 206 207 208 209 210 211 212
      if self.related:
        append('%s.uid = %s.uid' % (table_1,table_0))
        if self.strict_membership:
          append('AND %s.category_strict_membership = 1' % table_0)
        append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
        append('AND %s.category_uid = %s.uid' % (table_0,query_table))
      else:
        append('%s.uid = %s.category_uid' % (table_1,table_0))
        if self.strict_membership:
          append('AND %s.category_strict_membership = 1' % table_0)
        append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
        append('AND %s.uid = %s.uid' % (table_0,query_table))
213 214
      return ' '.join(expression_list)

215
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
216 217 218 219 220 221 222
    """
    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
223

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

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

233
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
234 235 236
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Vincent Pelletier's avatar
Vincent Pelletier committed
237 238 239
    security.declareProtected(Permissions.ManagePortal
                , 'manage_schema')
    manage_schema = DTMLFile('dtml/manageSchema', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
240

Aurel's avatar
Aurel committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    def getPreferredSQLCatalogId(self, id=None):
      """
      Get the SQL Catalog from preference.
      """
      if id is None:
        # Check if we want to use an archive
        #if getattr(aq_base(self.portal_preferences), 'uid', None) is not None:
        archive_path = self.portal_preferences.getPreferredArchive(sql_catalog_id=self.default_sql_catalog_id)
        if archive_path not in ('', None):
          try:
            archive = self.restrictedTraverse(archive_path)
          except KeyError:
            # Do not fail if archive object has been removed,
            # but preference is not up to date
            return None
          if archive is not None:
            catalog_id = archive.getCatalogId()
            if catalog_id not in ('', None):
              return catalog_id
        return None
      else:
        return id
      
Vincent Pelletier's avatar
Vincent Pelletier committed
264
    security.declareProtected('Import/Export objects', 'addDefaultSQLMethods')
265
    def addDefaultSQLMethods(self, config_id='erp5'):
266 267 268
      """
        Add default SQL methods for a given configuration.
      """
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
      # For compatibility.
      if config_id.lower() == 'erp5':
        config_id = 'erp5_mysql'
      elif config_id.lower() == 'cps3':
        config_id = 'cps3_mysql'

      addSQLCatalog = self.manage_addProduct['ZSQLCatalog'].manage_addSQLCatalog
      if config_id not in self.objectIds():
        addSQLCatalog(config_id, '')

      catalog = self.getSQLCatalog(config_id)
      addSQLMethod = catalog.manage_addProduct['ZSQLMethods'].manage_addZSQLMethod
      product_path = package_home(globals())
      zsql_dirs = []

284 285
      # Common methods - for backward compatibility
      # SQL code distribution is supposed to be business template based nowadays
286
      if config_id.lower() == 'erp5_mysql':
287
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
        zsql_dirs.append(os.path.join(product_path, 'sql', 'erp5_mysql'))
      elif config_id.lower() == 'cps3_mysql':
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
        zsql_dirs.append(os.path.join(product_path, 'sql', 'cps3_mysql'))

      # Iterate over the sql directory. Add all sql methods in that directory.
      for directory in zsql_dirs:
        for entry in os.listdir(directory):
          if entry.endswith('.zsql'):
            id = entry[:-5]
            # Create an empty SQL method first.
            addSQLMethod(id = id, title = '', connection_id = '', arguments = '', template = '')
            #LOG('addDefaultSQLMethods', 0, 'catalog = %r' % (catalog.objectIds(),))
            sql_method = getattr(catalog, id)
            # Set parameters of the SQL method from the contents of a .zsql file.
            sql_method.fromFile(os.path.join(directory, entry))
          elif entry == 'properties.xml':
            # This sets up the attributes. The file should be generated by manage_exportProperties.
            catalog.manage_importProperties(os.path.join(directory, entry))

      # Make this the default.
      self.default_sql_catalog_id = config_id
310
     
Vincent Pelletier's avatar
Vincent Pelletier committed
311
    security.declareProtected('Import/Export objects', 'exportSQLMethods')
312
    def exportSQLMethods(self, sql_catalog_id=None, config_id='erp5'):
313 314 315 316 317 318 319 320
      """
        Export SQL methods for a given configuration.
      """
      # For compatibility.
      if config_id.lower() == 'erp5':
        config_id = 'erp5_mysql'
      elif config_id.lower() == 'cps3':
        config_id = 'cps3_mysql'
Jean-Paul Smets's avatar
Jean-Paul Smets committed
321

322
      catalog = self.getSQLCatalog(sql_catalog_id)
323 324 325
      product_path = package_home(globals())
      common_sql_dir = os.path.join(product_path, 'sql', 'common_mysql')
      config_sql_dir = os.path.join(product_path, 'sql', config_id)
326 327
      common_sql_list = ('z0_drop_record', 'z_read_recorded_object_list', 'z_catalog_paths',
                         'z_record_catalog_object', 'z_clear_reserved', 'z_record_uncatalog_object',
328
                         'z_create_record', 'z_delete_recorded_object_list',
329 330
                         'z_reserve_uid', 'z_getitem_by_path', 'z_show_columns', 'z_getitem_by_path',
                         'z_show_tables', 'z_getitem_by_uid', 'z_unique_values', 'z_produce_reserved_uid_list',)
331
    
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
      msg = ''
      for id in catalog.objectIds(spec=('Z SQL Method',)):
        if id in common_sql_list:
          d = common_sql_dir
        else:
          d = config_sql_dir
        sql = catalog._getOb(id)
        # First convert the skin to text
        text = sql.manage_FTPget()
        name = os.path.join(d, '%s.zsql' % (id,))
        msg += 'Writing %s\n' % (name,)
        f = open(name, 'w')
        try:
          f.write(text)
        finally:
          f.close()
348
          
349 350 351 352 353 354 355 356
      properties = self.manage_catalogExportProperties(sql_catalog_id=sql_catalog_id)
      name = os.path.join(config_sql_dir, 'properties.xml')
      msg += 'Writing %s\n' % (name,)
      f = open(name, 'w')
      try:
        f.write(properties)
      finally:
        f.close()
357
        
358
      return msg
359
        
360
    def _listAllowedRolesAndUsers(self, user):
361
        # We use ERP5Security PAS based authentication
362 363 364
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
365
          proxy_roles = getattr(eo, '_proxy_roles',None)
366 367 368 369 370
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
Vincent Pelletier's avatar
Vincent Pelletier committed
371
          result = list(proxy_roles)
372
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
373 374 375
          result = list(user.getRoles())
        result.append('Anonymous')
        result.append('user:%s' % user.getId())
376 377 378
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
379
            groups = list(user.getGroups())
380 381 382 383 384 385
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
386
        return result
387

Jean-Paul Smets's avatar
Jean-Paul Smets committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
    # 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
454
    security.declarePublic('getAllowedRolesAndUsers')
Aurel's avatar
Aurel committed
455
    def getAllowedRolesAndUsers(self, sql_catalog_id=None, **kw):
456 457
      """
        Return allowed roles and users.
458

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

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
      # 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

493 494
      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
495 496
      local_roles = kw.get('local_roles', None)
      if local_roles:
497 498
        local_role_dict = dict(catalog.getSQLCatalogLocalRoleKeysList())
        role_dict = dict(catalog.getSQLCatalogRoleKeysList())
499
        # XXX user is not enough - we should also include groups of the user
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
        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:
515
                # XXX This should be a list
516 517 518 519 520 521 522 523 524
                # 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:
525
                # XXX This should be a list
526 527 528 529 530 531 532
                # 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
533

534

535
      return allowedRolesAndUsers, role_column_dict, local_role_column_dict
536

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

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
545
      """
546 547
      allowedRolesAndUsers, role_column_dict, local_role_column_dict = \
          self.getAllowedRolesAndUsers(**kw)
Aurel's avatar
Aurel committed
548
      catalog = self.getSQLCatalog(sql_catalog_id)
549
      method = getattr(catalog, catalog.sql_search_security, None)
550
      if allowedRolesAndUsers:
551
        allowedRolesAndUsers.sort()
552
        cache_key = tuple(allowedRolesAndUsers)
553
        tv = getTransactionalVariable()
554 555 556 557 558 559 560
        try:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict']
        except KeyError:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict'] = {}
        try:
          security_uid_list = security_uid_cache[cache_key]
        except KeyError:
561 562 563 564 565 566 567 568 569 570 571 572
          if method is None:
            warnings.warn("The usage of allowedRolesAndUsers is "\
                          "deprecated. Please update your catalog "\
                          "business template.", DeprecationWarning)
            security_uid_list = [x.security_uid for x in \
              self.unrestrictedSearchResults(
                allowedRolesAndUsers=allowedRolesAndUsers,
                select_expression="security_uid",
                group_by_expression="security_uid")]
          else:
            # XXX: What with this string transformation ?! Souldn't it be done in
            # dtml instead ?
573
            allowedRolesAndUsers = [sqlquote(role) for role in allowedRolesAndUsers]
574
            security_uid_list = [x.uid for x in method(security_roles_list = allowedRolesAndUsers)]
575
          security_uid_cache[cache_key] = security_uid_list
576 577
      else:
        security_uid_list = []
578
      return security_uid_list, role_column_dict, local_role_column_dict
579

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

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

624 625 626
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
627

Jean-Paul Smets's avatar
Jean-Paul Smets committed
628
    # searchResults has inherited security assertions.
629
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
630
        """
631 632
        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
633
        """
634 635 636 637 638
        #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
639

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

    __call__ = searchResults

650 651 652 653
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
654
        kw.setdefault('limit', self.default_result_limit)
655 656
        return ZCatalog.searchResults(self, REQUEST, **kw)

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

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

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

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

720 721 722
        document_object = aq_inner(object)
        w = IndexableObjectWrapper(document_object)

723
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
724
        if wf is not None:
725
          w.__dict__.update(wf.getCatalogVariablesFor(object))
726

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

        (security_uid, optimised_roles_and_users) = catalog.getSecurityUid(document_w)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
745
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
746
        # XXX we should build vars begore building the wrapper
747
        w.optimised_roles_and_users = optimised_roles_and_users
748 749
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
750 751
          w.predicate_property_dict = predicate_property_dict
        w.security_uid = security_uid
752 753 754
        (subject_set_uid, optimised_subject_list) = catalog.getSubjectSetUid(document_w)
        w.optimised_subject_list = optimised_subject_list
        w.subject_set_uid = subject_set_uid
755 756

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

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

768

769 770 771 772 773 774 775 776 777 778
    def catalogObjectList(self, object_list, *args, **kw):
        """Catalog a list of objects"""
        if type(object_list[0]) is tuple:
          tmp_object_list = [x[0] for x in object_list]
          super(CatalogTool, self).catalogObjectList(tmp_object_list, **x[2])
          # keep failed objects in 'object_list'
          object_list[:] = [x for x in object_list if x[0] in tmp_object_list]
        else:
          super(CatalogTool, self).catalogObjectList(object_list, *args, **kw)

779 780 781 782 783 784 785
    security.declarePrivate('uncatalogObjectList')
    def uncatalogObjectList(self, message_list):
      """Uncatalog a list of objects"""
      for obj, args, kw in message_list:
        self.unindexObject(*args, **kw)
      del message_list[:]

Jean-Paul Smets's avatar
Jean-Paul Smets committed
786
    security.declarePrivate('unindexObject')
787
    def unindexObject(self, object=None, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
788 789 790
        """
          Remove from catalog.
        """
791
        if path is None and uid is None:
792 793
          if object is None:
            raise TypeError, 'One of uid, path and object parameters must not be None'
794
          path = self.__url(object)
795 796
        if uid is None:
          raise TypeError, "unindexObject supports only uid now"
797
        self.uncatalog_object(path=path, uid=uid, sql_catalog_id=sql_catalog_id)
798

Sebastien Robin's avatar
Sebastien Robin committed
799 800 801 802 803 804 805 806 807
    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)

808 809 810
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
811

Jean-Paul Smets's avatar
Jean-Paul Smets committed
812
    security.declarePrivate('moveObject')
813
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
814 815 816 817 818 819
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
820
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
821 822
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
823

824 825 826 827 828 829
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
830
      if not object.providesIPredicate():
831 832 833
        return None
      object = object.asPredicate()
      if object is None:
834 835 836 837 838 839 840 841 842 843 844
        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:
845
            property_dict['%s_range_min' % property] = min
846
          if max is not None:
847
            property_dict['%s_range_max' % property] = max
848
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
849 850
      return property_dict

851
    security.declarePrivate('getDynamicRelatedKeyList')
852
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
853
      """
854
      Return the list of dynamic related keys.
855 856
      This method will try to automatically generate new related key
      by looking at the category tree.
857 858 859 860

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
861 862 863 864
      strict_destination_title | category,catalog/title/z_related_strict_destination

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

            if end_key.startswith('related_'):
              end_key = end_key[len('related_'):]
              # accept only some catalog columns
              if end_key in ('title', 'uid', 'description', 'reference',
                             'relative_url', 'id', 'portal_type',
                             'simulation_state'):
                if strict:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_strict_%s_related' %
                        (prefix, key, end_key, expected_base_cat_id))
                else:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_%s_related' %
                        (prefix, key, end_key, expected_base_cat_id))
            else:
              # accept only some catalog columns
              if end_key in ('title', 'uid', 'description', 'reference',
                             'relative_url', 'id', 'portal_type',
                             'simulation_state'):
                if strict:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_strict_%s' %
                        (prefix, key, end_key, expected_base_cat_id))
                else:
                  related_key_list.append(
                        '%s%s | category,catalog/%s/z_related_%s' %
                        (prefix, key, end_key, expected_base_cat_id))
917 918 919 920 921 922

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
923
      Will generate z_related_[base_category_id] if possible
924
      """
Vincent Pelletier's avatar
Vincent Pelletier committed
925 926 927 928 929 930 931 932 933
      result = None
      if name.startswith(DYNAMIC_METHOD_NAME) and \
          not name.endswith(ZOPE_SECURITY_SUFFIX):

        if name.endswith(RELATED_DYNAMIC_METHOD_NAME):
          if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
            base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):-len('_related')]
            method = RelatedBaseCategory(base_category_id,
                                         strict_membership=1, related=1)
934
          else:
Vincent Pelletier's avatar
Vincent Pelletier committed
935 936
            base_category_id = name[len(DYNAMIC_METHOD_NAME):-len('_related')]
            method = RelatedBaseCategory(base_category_id, related=1)
937
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
938 939 940 941 942 943 944 945 946 947
          if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
            base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):]
            method = RelatedBaseCategory(base_category_id, strict_membership=1)
          else:
            base_category_id = name[len(DYNAMIC_METHOD_NAME):]
            method = RelatedBaseCategory(base_category_id)

        setattr(self.__class__, name, method)
        result = getattr(self, name)
      return result
948

949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
    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.
      Note however, we don't use Base_makeActiveResult so you're likely to get
      ConflictError at the beginning. You could avoid this by making sure
      'result_list' is already initialized on the active process.
      """
      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:
          tag = activate_kw.get('tag')
          if not tag:
            activate_kw['tag'] = tag = 'searchAndActivate_%r' % time.time()
          _tag = '%s_%s' % (tag, min_uid)
          self.activate(tag=tag, after_tag=_tag, activity='SQLQueue') \
              ._searchAndActivate(method_id,method_args, method_kw,
                                  dict(activate_kw), r[-1].getUid(), **kw)
          activate_kw['tag'] = _tag
        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)

994
InitializeClass(CatalogTool)