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

from Products.CMFCore.CatalogTool import CatalogTool as CMFCoreCatalogTool
from Products.ZSQLCatalog.ZSQLCatalog import ZCatalog
31
from Products.ZSQLCatalog.SQLCatalog import Query, ComplexQuery
Jean-Paul Smets's avatar
Jean-Paul Smets committed
32 33 34
from Products.CMFCore import CMFCorePermissions
from AccessControl import ClassSecurityInfo, getSecurityManager
from Products.CMFCore.CatalogTool import IndexableObjectWrapper as CMFCoreIndexableObjectWrapper
35
from Products.CMFCore.utils import UniqueObject, _checkPermission, _getAuthenticatedUser, getToolByName
36
from Products.CMFCore.utils import _mergedLocalRoles
37
from Globals import InitializeClass, DTMLFile, package_home
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38 39
from Acquisition import aq_base, aq_inner, aq_parent
from DateTime.DateTime import DateTime
40
from Products.CMFActivity.ActiveObject import ActiveObject
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41 42 43 44 45 46

from AccessControl.PermissionRole import rolesForPermissionOn

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

49 50
from Products.ERP5Security.ERP5UserManager import SUPER_USER

51
import os, time, urllib, warnings
52
from zLOG import LOG, PROBLEM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
53

54
SECURITY_USING_NUX_USER_GROUPS, SECURITY_USING_PAS = range(2)
55
try:
56 57
  from Products.PluggableAuthService import PluggableAuthService
  PAS_meta_type = PluggableAuthService.PluggableAuthService.meta_type
58
except ImportError:
59
  PAS_meta_type = ''
60 61 62
try:
  from Products.ERP5Security import mergedLocalRoles as PAS_mergedLocalRoles
except ImportError:
63
  pass
64 65 66 67 68 69

try:
  from Products.NuxUserGroups import UserFolderWithGroups
  NUG_meta_type = UserFolderWithGroups.meta_type
except ImportError:
  NUG_meta_type = ''
70 71 72 73 74
try:
  from Products.NuxUserGroups.CatalogToolWithGroups import mergedLocalRoles
  from Products.NuxUserGroups.CatalogToolWithGroups import _getAllowedRolesAndUsers
except ImportError:
  pass
75

76 77 78 79 80 81 82 83 84
def getSecurityProduct(acl_users):
  """returns the security used by the user folder passed.
  (NuxUserGroup, ERP5Security, or None if anything else).
  """
  if acl_users.meta_type == PAS_meta_type:
    return SECURITY_USING_PAS
  elif acl_users.meta_type == NUG_meta_type:
    return SECURITY_USING_NUX_USER_GROUPS

Jean-Paul Smets's avatar
Jean-Paul Smets committed
85 86 87 88 89 90 91 92 93 94 95
class IndexableObjectWrapper(CMFCoreIndexableObjectWrapper):

    def __setattr__(self, name, value):
      # We need to update the uid during the cataloging process
      if name == 'uid':
        setattr(self.__ob, name, value)
      else:
        self.__dict__[name] = value

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

        WARNING (XXX): some user base local role association is currently
        being stored (ex. to be determined). This should be prevented or it will
        make the table explode. To analyse the symptoms, look at the
        user_and_roles table. You will find some user:foo values
        which are not necessary.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
104 105
        """
        ob = self.__ob
106 107 108 109
        security_product = getSecurityProduct(ob.acl_users)
        withnuxgroups = security_product == SECURITY_USING_NUX_USER_GROUPS
        withpas = security_product == SECURITY_USING_PAS

Jean-Paul Smets's avatar
Jean-Paul Smets committed
110
        allowed = {}
111
        for r in rolesForPermissionOn('View', ob):
112
          allowed[r] = 1
113
        if withnuxgroups:
114
          localroles = mergedLocalRoles(ob, withgroups=1)
115 116
        elif withpas:
          localroles = PAS_mergedLocalRoles(ob)
117 118 119
        else:
          # CMF
          localroles = _mergedLocalRoles(ob)
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
        # 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'
        new_dict = {}
        for key in localroles.keys():
          new_list = []
          remove_list = []
          for role in localroles[key]:
            if role.startswith('-'):
              if not role[1:] in new_list and not role[1:] in remove_list:
                remove_list.append(role[1:])
            elif not role in remove_list:
              new_list.append(role)
          if len(new_list)>0:
            new_dict[key] = new_list
        localroles = new_dict
Jean-Paul Smets's avatar
Jean-Paul Smets committed
138
        for user, roles in localroles.items():
139 140 141 142 143 144
          for role in roles:
            if allowed.has_key(role):
              if withnuxgroups:
                allowed[user] = 1
              else:
                allowed['user:' + user] = 1
145 146 147
            # Added for ERP5 project by JP Smets
            # The reason why we do not want to keep Owner is because we are
            # trying to reduce the number of security definitions
148 149 150 151 152
            # However, this is a bad idea if we start to use Owner role
            # as a kind of bamed Assignee and if we need it for worklists. Therefore
            # we may sometimes catalog the owner user ID whenever the Owner
            # has view permission (see getAllowedRolesAndUsers bellow
            # as well as getViewPermissionOwner method in Base)
153
            if role != 'Owner': 
154 155 156 157 158 159
              if withnuxgroups:
                allowed[user + ':' + role] = 1
              else:
                allowed['user:' + user + ':' + role] = 1
        if allowed.has_key('Owner'):
          del allowed['Owner']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160 161
        return list(allowed.keys())

162
class RelatedBaseCategory(Method):
163 164
    """A Dynamic Method to act as a related key.
    """
165
    def __init__(self, id,strict_membership=0):
166
      self._id = id
167
      self.strict_membership=strict_membership
168

169
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
170
      """Create the sql code for this related key."""
171 172 173 174
      base_category_uid = instance.portal_categories._getOb(self._id).getUid()
      expression_list = []
      append = expression_list.append
      append('%s.uid = %s.category_uid' % (table_1,table_0))
175 176
      if self.strict_membership:
        append('AND %s.category_strict_membership = 1' % table_0)
177 178 179 180
      append('AND %s.base_category_uid = %s' % (table_0,base_category_uid))
      append('AND %s.uid = %s.uid' % (table_0,query_table))
      return ' '.join(expression_list)

181
class CatalogTool (UniqueObject, ZCatalog, CMFCoreCatalogTool, ActiveObject):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
182 183 184 185 186 187 188
    """
    This is a ZSQLCatalog that filters catalog queries.
    It is based on ZSQLCatalog
    """
    id = 'portal_catalog'
    meta_type = 'ERP5 Catalog'
    security = ClassSecurityInfo()
189 190
    default_result_limit = 1000
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
191 192 193 194 195 196 197
    manage_options = ( { 'label' : 'Overview', 'action' : 'manage_overview' },
                     ) + ZCatalog.manage_options


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

198
    # Explicit Inheritance
Jean-Paul Smets's avatar
Jean-Paul Smets committed
199 200 201
    __url = CMFCoreCatalogTool.__url
    manage_catalogFind = CMFCoreCatalogTool.manage_catalogFind

Jean-Paul Smets's avatar
Jean-Paul Smets committed
202 203 204 205
    security.declareProtected( CMFCorePermissions.ManagePortal
                , 'manage_schema' )
    manage_schema = DTMLFile( 'dtml/manageSchema', globals() )

206
    security.declareProtected( 'Import/Export objects', 'addDefaultSQLMethods' )
207
    def addDefaultSQLMethods(self, config_id='erp5'):
208 209 210
      """
        Add default SQL methods for a given configuration.
      """
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
      # 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 = []

226 227
      # Common methods - for backward compatibility
      # SQL code distribution is supposed to be business template based nowadays
228
      if config_id.lower() == 'erp5_mysql':
229
        zsql_dirs.append(os.path.join(product_path, 'sql', 'common_mysql'))
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
        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
252
     
253
    security.declareProtected( 'Import/Export objects', 'exportSQLMethods' )
254
    def exportSQLMethods(self, sql_catalog_id=None, config_id='erp5'):
255 256 257 258 259 260 261 262
      """
        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
263

264
      catalog = self.getSQLCatalog(sql_catalog_id)
265 266 267
      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)
268 269 270 271 272
      common_sql_list = ('z0_drop_record', 'z_read_recorded_object_list', 'z_catalog_paths',
                         'z_record_catalog_object', 'z_clear_reserved', 'z_record_uncatalog_object',
                         'z_create_record', 'z_related_security', 'z_delete_recorded_object_list',
                         'z_reserve_uid', 'z_getitem_by_path', 'z_show_columns', 'z_getitem_by_path',
                         'z_show_tables', 'z_getitem_by_uid', 'z_unique_values', 'z_produce_reserved_uid_list',)
273
    
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
      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()
290
          
291 292 293 294 295 296 297 298
      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()
299
        
300
      return msg
301
        
302
    def _listAllowedRolesAndUsers(self, user):
303 304
      security_product = getSecurityProduct(self.acl_users)
      if security_product == SECURITY_USING_PAS:
305
        # We use ERP5Security PAS based authentication
306 307 308
        try:
          # check for proxy role in stack
          eo = getSecurityManager()._context.stack[-1]
309
          proxy_roles = getattr(eo, '_proxy_roles',None)
310 311 312 313 314 315 316 317
        except IndexError:
          proxy_roles = None
        if proxy_roles:
          # apply proxy roles
          user = eo.getOwner()
          result = list( proxy_roles )
        else:
          result = list( user.getRoles() )
318 319
        result.append( 'Anonymous' )
        result.append( 'user:%s' % user.getId() )
320 321 322
        # deal with groups
        getGroups = getattr(user, 'getGroups', None)
        if getGroups is not None:
323
            groups = list(user.getGroups())
324 325 326 327 328 329
            groups.append('role:Anonymous')
            if 'Authenticated' in result:
                groups.append('role:Authenticated')
            for group in groups:
                result.append('user:%s' % group)
        # end groups
330
        return result
331
      elif security_product == SECURITY_USING_NUX_USER_GROUPS:
332
        return _getAllowedRolesAndUsers(user)
333
      else:
334
        return CMFCoreCatalogTool._listAllowedRolesAndUsers(self, user)
335

Jean-Paul Smets's avatar
Jean-Paul Smets committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
    # 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


402 403 404 405
    security.declarePublic( 'getAllowedRolesAndUsers' )
    def getAllowedRolesAndUsers(self, **kw):
      """
        Return allowed roles and users.
406

407
        This is supposed to be used with Z SQL Methods to check permissions
408
        when you list up documents. It is also able to take into account
409
        a parameter named local_roles so that listed documents only include
410 411
        those documents for which the user (or the group) was
        associated one of the given local roles.
412 413 414
      
        The use of getAllowedRolesAndUsers is deprecated, you should use
        getSecurityQuery instead
415 416
      """
      user = _getAuthenticatedUser(self)
417 418
      user_is_superuser = (user == SUPER_USER)
      user_str = str(user)
419
      allowedRolesAndUsers = self._listAllowedRolesAndUsers(user)
420
      role_column_dict = {}
421
      column_map = self.getSQLCatalog().getColumnMap()
422 423 424 425

      # Patch for ERP5 by JP Smets in order
      # to implement worklists and search of local roles
      if kw.has_key('local_roles'):
426
        local_roles = kw['local_roles']
427
        # XXX user is not enough - we should also include groups of the user
428
        # Only consider local_roles if it is not empty
429
        if local_roles not in (None, '', []): # XXX: Maybe "if local_roles:" is enough.
430
          new_allowedRolesAndUsers = []
431
          # Turn it into a list if necessary according to ';' separator
432
          if isinstance(local_roles, str):
433
            local_roles = local_roles.split(';')
434
          local_roles = [x.lower() for x in local_roles]
435
          # Local roles now has precedence (since it comes from a WorkList)
436
          for user_or_group in allowedRolesAndUsers:
437
            for role in local_roles:
438
              # Performance optimisation
439
              if role in column_map:
440 441 442
                # If a given role exists as a column in the catalog,
                # then it is considered as single valued and indexed
                # through the catalog.
443 444 445
                if not user_is_superuser:
                  role_column_dict[role] = user_str  # XXX This should be a list
                                                     # which also includes all user groups
446
              else:
447
                # Else, we use the standard approach
448
                new_allowedRolesAndUsers.append('%s:%s' % (user_or_group, role))
449
          allowedRolesAndUsers = new_allowedRolesAndUsers
450 451 452 453
      else:
        # We only consider here the Owner role (since it was not indexed)
        # since some objects may only be visible by their owner
        # which was not indexed
454 455 456
        if 'owner' in column_map:
          if not user_is_superuser:
            role_column_dict['owner'] = user_str
457 458 459
            # XXX this is inconsistent withe "check for proxy role in stack"
            # in _listAllowedRolesAndUsers. We should use the proxy user
            # to be consistent
460

461
      return allowedRolesAndUsers, role_column_dict
462

463
    def getSecurityUidListAndRoleColumnDict(self, **kw):
464
      """
465 466 467
        Return a list of security Uids and a dictionnary containing available
        role columns.
        
468 469 470 471
        TODO: Add a cache.
      """
      allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
      catalog = self.getSQLCatalog()
472 473 474 475 476
      method = getattr(catalog, catalog.sql_search_security, None)
      if method is None:
        raise DeprecationWarning, "The usage of allowedRolesAndUsers is "\
                                  "deprecated. Please update your catalog "\
                                  "business template."
477 478
      allowedRolesAndUsers = ["'%s'" % (role, ) for role in allowedRolesAndUsers]
      security_uid_list = [x.uid for x in method(security_roles_list = allowedRolesAndUsers)]
479
      return security_uid_list, role_column_dict
480

481
    security.declarePublic( 'getSecurityQuery' )
482
    def getSecurityQuery(self, query=None, **kw):
483
      """
484 485 486
        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.
487
      """
488
      original_query = query
489 490 491 492 493
      try:
        security_uid_list, role_column_dict = self.getSecurityUidListAndRoleColumnDict(**kw)
      except DeprecationWarning, message:
        warnings.warn(message, DeprecationWarning)
        allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
494 495 496
        if role_column_dict:
          query_list = []
          for key, value in role_column_dict.items():
497
            new_query = Query(**{key : value})
498 499 500 501 502 503 504 505
            query_list.append(new_query)
          operator_kw = {'operator': 'AND'} 
          query = ComplexQuery(*query_list, **operator_kw)
          if allowedRolesAndUsers:
            query = ComplexQuery(Query(allowedRolesAndUsers=allowedRolesAndUsers),
                                 query, operator='OR')
        else:
          query = Query(allowedRolesAndUsers=allowedRolesAndUsers)
506
      else:
507 508 509
        if role_column_dict:
          query_list = []
          for key, value in role_column_dict.items():
510
            new_query = Query(**{key : value})
511 512 513
            query_list.append(new_query)
          operator_kw = {'operator': 'AND'}
          query = ComplexQuery(*query_list, **operator_kw)
514 515 516 517 518 519
          # 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')
520
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
521
          query = Query(security_uid=security_uid_list, operator='IN')
522 523 524
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
525

Jean-Paul Smets's avatar
Jean-Paul Smets committed
526
    # searchResults has inherited security assertions.
527
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
528
        """
529 530
        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
531
        """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
532 533 534 535 536
        if not _checkPermission(
            CMFCorePermissions.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
537

538
        query = self.getSecurityQuery(query=query, **kw)
539
        kw.setdefault('limit', self.default_result_limit)
540
        return ZCatalog.searchResults(self, query=query, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
541 542 543

    __call__ = searchResults

544 545 546 547
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
548
        kw.setdefault('limit', self.default_result_limit)
549 550
        return ZCatalog.searchResults(self, REQUEST, **kw)

551 552
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
553 554
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
555 556 557 558 559 560 561 562 563
        """
        A method to factor common code used to search a single
        object in the database.
        """
        result = self.searchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None
564 565 566 567 568 569 570 571 572 573 574 575 576 577

    security.declarePrivate('unrestrictedGetResultValue')
    def unrestrictedGetResultValue(self, query=None, **kw):
        """
        A method to factor common code used to search a single
        object in the database. Same as getResultValue but without
        taking into account security.
        """
        result = self.unrestrictedSearchResults(query=query, **kw)
        try:
          return result[0].getObject()
        except IndexError:
          return None

578
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
579 580 581 582
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
583
        # XXX This needs to be set again
584 585 586 587 588 589
        #if not _checkPermission(
        #    CMFCorePermissions.AccessInactivePortalContent, self ):
        #    base = aq_base( self )
        #    now = DateTime()
        #    #kw[ 'effective' ] = { 'query' : now, 'range' : 'max' }
        #    #kw[ 'expires'   ] = { 'query' : now, 'range' : 'min' }
Jean-Paul Smets's avatar
Jean-Paul Smets committed
590

591
        query = self.getSecurityQuery(query=query, **kw)
592
        kw.setdefault('limit', self.default_result_limit)
593 594
        return ZCatalog.countResults(self, query=query, **kw)
    
595 596 597 598 599
    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
600

601 602 603 604 605 606 607 608 609 610
    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)

611
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
612
        if wf is not None:
613
          vars = wf.getCatalogVariablesFor(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
614
        else:
615 616
          vars = {}
        #LOG('catalog_object vars', 0, str(vars))
617

Jean-Paul Smets's avatar
Jean-Paul Smets committed
618
        w = IndexableObjectWrapper(vars, object)
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

        object_path = object.getPhysicalPath()
        portal_path = object.portal_url.getPortalObject().getPhysicalPath()
        if len(object_path) > len(portal_path) + 2 and getattr(object, 'isRADContent', 0):
          # This only applied to ERP5 Contents (not CPS)
          # We are now in the case of a subobject of a root document
          # We want to return single security information
          document_object = aq_inner(object)
          for i in range(0, len(object_path) - len(portal_path) - 2):
            document_object = document_object.aq_parent
          document_w = IndexableObjectWrapper({}, document_object)
        else:
          document_w = w

        (security_uid, optimised_roles_and_users) = catalog.getSecurityUid(document_w)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
634
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
635
        # XXX we should build vars begore building the wrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
636 637
        if optimised_roles_and_users is not None:
          vars['optimised_roles_and_users'] = optimised_roles_and_users
638
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
639
          vars['optimised_roles_and_users'] = None
640 641 642
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
          vars['predicate_property_dict'] = predicate_property_dict
643
        vars['security_uid'] = security_uid
644 645

        return w
Jean-Paul Smets's avatar
Jean-Paul Smets committed
646 647

    security.declarePrivate('reindexObject')
648
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
649 650 651 652
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
653
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
654
        url = self.__url(object)
655
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
656

657

Jean-Paul Smets's avatar
Jean-Paul Smets committed
658
    security.declarePrivate('unindexObject')
659
    def unindexObject(self, object, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
660 661 662
        """
          Remove from catalog.
        """
663 664 665 666
        if path is None and uid is None:
          path = self.__url(object)
        self.uncatalog_object(path=path,uid=uid, sql_catalog_id=sql_catalog_id)

Sebastien Robin's avatar
Sebastien Robin committed
667 668 669 670 671 672 673 674 675
    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)

676 677 678
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
679

Jean-Paul Smets's avatar
Jean-Paul Smets committed
680
    security.declarePrivate('moveObject')
681
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
682 683 684 685 686 687
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
688
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
689 690
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
691

692 693 694 695 696 697
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
698 699 700 701
      if not getattr(object,'isPredicate',None):
        return None
      object = object.asPredicate()
      if object is None:
702 703 704 705 706 707 708 709 710 711 712
        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:
713
            property_dict['%s_range_min' % property] = min
714
          if max is not None:
715
            property_dict['%s_range_max' % property] = max
716
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
717 718
      return property_dict

719
    security.declarePrivate('getDynamicRelatedKeyList')
720
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
721
      """
722
      Return the list of dynamic related keys.
723 724
      This method will try to automatically generate new related key
      by looking at the category tree.
725 726 727 728

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
729 730 731 732
      strict_destination_title | category,catalog/title/z_related_strict_destination

      strict_ related keys only returns documents which are strictly member of
      the category.
733 734
      """
      related_key_list = []
735
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
736
      default_string = 'default_'
737
      strict_string = 'strict_'
738
      for key in key_list:
739
        prefix = ''
740
        strict = 0
741 742 743
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
744 745 746 747
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
748
        splitted_key = key.split('_')
749 750
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
751 752
        for i in range(1,len(splitted_key))[::-1]:
          expected_base_cat_id = '_'.join(splitted_key[0:i])
753
          if expected_base_cat_id != 'parent' and \
754 755 756
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
757
            # accept only some catalog columns
758 759
            if end_key in ('title', 'uid', 'description',
                           'relative_url', 'id', 'portal_type'):
760 761 762 763 764 765
              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(
766 767
                      '%s%s | category,catalog/%s/z_related_%s' %
                      (prefix, key, end_key, expected_base_cat_id))
768 769 770 771 772 773

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
774
      Will generate z_related_[base_category_id] if possible
775 776 777 778
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
        DYNAMIC_METHOD_NAME = 'z_related_'
779
        STRICT_DYNAMIC_METHOD_NAME = 'z_related_strict_'
780 781 782 783
        method_name_length = len(DYNAMIC_METHOD_NAME)
        zope_security = '__roles__'
        if (name.startswith(DYNAMIC_METHOD_NAME) and \
          (not name.endswith(zope_security))):
784 785
          if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
            base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):]
786
            method = RelatedBaseCategory(base_category_id, strict_membership=1)
787 788 789
          else:
            base_category_id = name[len(DYNAMIC_METHOD_NAME):]
            method = RelatedBaseCategory(base_category_id)
790
          setattr(self.__class__, name, method)
791 792 793 794 795
          klass = aq_base(self).__class__
          if hasattr(klass, 'security'):
            from Products.ERP5Type import Permissions as ERP5Permissions
            klass.security.declareProtected(ERP5Permissions.View, name)
          else:
796 797
            LOG('ERP5Catalog', PROBLEM,
                'Security not defined on %s' % klass.__name__)
798 799 800 801
          return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
802 803 804



805
InitializeClass(CatalogTool)