CatalogTool.py 33.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
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 51
from Products.ERP5Security.ERP5UserManager import SUPER_USER

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

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

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

77 78 79 80 81 82 83 84 85
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
86 87 88 89 90 91 92 93 94 95 96
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):
        """
97 98 99 100 101 102 103 104
        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
105 106
        """
        ob = self.__ob
107 108 109 110
        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
111
        allowed = {}
112
        for r in rolesForPermissionOn('View', ob):
113
          allowed[r] = 1
114
        if withnuxgroups:
115
          localroles = mergedLocalRoles(ob, withgroups=1)
116 117
        elif withpas:
          localroles = PAS_mergedLocalRoles(ob)
118 119 120
        else:
          # CMF
          localroles = _mergedLocalRoles(ob)
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
        # 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
139
        for user, roles in localroles.items():
140 141 142 143 144 145
          for role in roles:
            if allowed.has_key(role):
              if withnuxgroups:
                allowed[user] = 1
              else:
                allowed['user:' + user] = 1
146 147 148
            # 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
149 150 151 152 153
            # 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)
154
            if role != 'Owner': 
155 156 157 158 159 160
              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
161 162
        return list(allowed.keys())

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

170
    def __call__(self, instance, table_0, table_1, query_table='catalog', **kw):
171
      """Create the sql code for this related key."""
172 173 174 175
      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))
176 177
      if self.strict_membership:
        append('AND %s.category_strict_membership = 1' % table_0)
178 179 180 181
      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)

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


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

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

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

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

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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 402
    # 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


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

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

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

465
      return allowedRolesAndUsers, role_column_dict
466

467
    def getSecurityUidListAndRoleColumnDict(self, **kw):
468
      """
469 470
        Return a list of security Uids and a dictionnary containing available
        role columns.
471 472 473 474

        XXX: This method always uses default catalog. This should not break a
        site as long as security uids are considered consistent among all
        catalogs.
475 476 477
      """
      allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
      catalog = self.getSQLCatalog()
478 479 480 481 482
      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."
483
      if allowedRolesAndUsers:
484
        allowedRolesAndUsers.sort()
485 486 487 488 489 490 491 492 493
        cache_key = tuple(allowedRolesAndUsers)
        tv = getTransactionalVariable(self)
        try:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict']
        except KeyError:
          security_uid_cache = tv['getSecurityUidListAndRoleColumnDict'] = {}
        try:
          security_uid_list = security_uid_cache[cache_key]
        except KeyError:
494 495 496 497
          # XXX: What with this string transformation ?! Souldn't it be done in
          # dtml instead ?
          allowedRolesAndUsers = ["'%s'" % (role, ) for role in allowedRolesAndUsers]
          security_uid_list = [x.uid for x in method(security_roles_list = allowedRolesAndUsers)]
498
          security_uid_cache[cache_key] = security_uid_list
499 500
      else:
        security_uid_list = []
501
      return security_uid_list, role_column_dict
502

503
    security.declarePublic( 'getSecurityQuery' )
504
    def getSecurityQuery(self, query=None, **kw):
505
      """
506 507 508
        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.
509
      """
510
      original_query = query
511 512 513 514 515
      try:
        security_uid_list, role_column_dict = self.getSecurityUidListAndRoleColumnDict(**kw)
      except DeprecationWarning, message:
        warnings.warn(message, DeprecationWarning)
        allowedRolesAndUsers, role_column_dict = self.getAllowedRolesAndUsers(**kw)
516 517 518
        if role_column_dict:
          query_list = []
          for key, value in role_column_dict.items():
519
            new_query = Query(**{key : value})
520 521 522 523 524 525 526 527
            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)
528
      else:
529 530 531
        if role_column_dict:
          query_list = []
          for key, value in role_column_dict.items():
532
            new_query = Query(**{key : value})
533 534 535
            query_list.append(new_query)
          operator_kw = {'operator': 'AND'}
          query = ComplexQuery(*query_list, **operator_kw)
536 537 538 539 540 541
          # 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')
542
        else:
Vincent Pelletier's avatar
Vincent Pelletier committed
543
          query = Query(security_uid=security_uid_list, operator='IN')
544 545 546
      if original_query is not None:
        query = ComplexQuery(query, original_query, operator='AND')
      return query
547

Jean-Paul Smets's avatar
Jean-Paul Smets committed
548
    # searchResults has inherited security assertions.
549
    def searchResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
550
        """
551 552
        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
553
        """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
554 555 556 557 558
        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
559

560
        query = self.getSecurityQuery(query=query, **kw)
561
        kw.setdefault('limit', self.default_result_limit)
562
        return ZCatalog.searchResults(self, query=query, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
563 564 565

    __call__ = searchResults

566 567 568 569
    security.declarePrivate('unrestrictedSearchResults')
    def unrestrictedSearchResults(self, REQUEST=None, **kw):
        """Calls ZSQLCatalog.searchResults directly without restrictions.
        """
570
        kw.setdefault('limit', self.default_result_limit)
571 572
        return ZCatalog.searchResults(self, REQUEST, **kw)

573 574
    # We use a string for permissions here due to circular reference in import
    # from ERP5Type.Permissions
575 576
    security.declareProtected('Search ZCatalog', 'getResultValue')
    def getResultValue(self, query=None, **kw):
577 578 579 580 581 582 583 584 585
        """
        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
586 587 588 589 590 591 592 593 594 595 596 597 598 599

    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

600
    def countResults(self, query=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
601 602 603 604
        """
            Calls ZCatalog.countResults with extra arguments that
            limit the results to what the user is allowed to see.
        """
605
        # XXX This needs to be set again
606 607 608 609 610 611
        #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
612

613
        query = self.getSecurityQuery(query=query, **kw)
614
        kw.setdefault('limit', self.default_result_limit)
615 616
        return ZCatalog.countResults(self, query=query, **kw)
    
617 618 619 620 621
    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
622

623 624 625 626 627 628 629 630 631 632
    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)

633
        wf = getToolByName(self, 'portal_workflow')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
634
        if wf is not None:
635
          vars = wf.getCatalogVariablesFor(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
636
        else:
637 638
          vars = {}
        #LOG('catalog_object vars', 0, str(vars))
639

Jean-Paul Smets's avatar
Jean-Paul Smets committed
640
        w = IndexableObjectWrapper(vars, object)
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655

        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
656
        #LOG('catalog_object optimised_roles_and_users', 0, str(optimised_roles_and_users))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
657
        # XXX we should build vars begore building the wrapper
Jean-Paul Smets's avatar
Jean-Paul Smets committed
658 659
        if optimised_roles_and_users is not None:
          vars['optimised_roles_and_users'] = optimised_roles_and_users
660
        else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
661
          vars['optimised_roles_and_users'] = None
662 663 664
        predicate_property_dict = catalog.getPredicatePropertyDict(object)
        if predicate_property_dict is not None:
          vars['predicate_property_dict'] = predicate_property_dict
665
        vars['security_uid'] = security_uid
666 667

        return w
Jean-Paul Smets's avatar
Jean-Paul Smets committed
668 669

    security.declarePrivate('reindexObject')
670
    def reindexObject(self, object, idxs=None, sql_catalog_id=None,**kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
671 672 673 674
        '''Update catalog after object data has changed.
        The optional idxs argument is a list of specific indexes
        to update (all of them by default).
        '''
675
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
676
        url = self.__url(object)
677
        self.catalog_object(object, url, idxs=idxs, sql_catalog_id=sql_catalog_id,**kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
678

679

Jean-Paul Smets's avatar
Jean-Paul Smets committed
680
    security.declarePrivate('unindexObject')
681
    def unindexObject(self, object, path=None, uid=None,sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
682 683 684
        """
          Remove from catalog.
        """
685 686 687 688
        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
689 690 691 692 693 694 695 696 697
    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)

698 699 700
    security.declarePrivate('getUrl')
    def getUrl(self, object):
      return self.__url(object)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
701

Jean-Paul Smets's avatar
Jean-Paul Smets committed
702
    security.declarePrivate('moveObject')
703
    def moveObject(self, object, idxs=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
704 705 706 707 708 709
        """
          Reindex in catalog, taking into account
          peculiarities of ERP5Catalog / ZSQLCatalog

          Useless ??? XXX
        """
710
        if idxs is None: idxs = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
711 712
        url = self.__url(object)
        self.catalog_object(object, url, idxs=idxs, is_object_moved=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
713

714 715 716 717 718 719
    security.declarePublic('getPredicatePropertyDict')
    def getPredicatePropertyDict(self, object):
      """
      Construct a dictionnary with a list of properties
      to catalog into the table predicate
      """
720 721 722 723
      if not getattr(object,'isPredicate',None):
        return None
      object = object.asPredicate()
      if object is None:
724 725 726 727 728 729 730 731 732 733 734
        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:
735
            property_dict['%s_range_min' % property] = min
736
          if max is not None:
737
            property_dict['%s_range_max' % property] = max
738
      property_dict['membership_criterion_category_list'] = object.getMembershipCriterionCategoryList()
739 740
      return property_dict

741
    security.declarePrivate('getDynamicRelatedKeyList')
742
    def getDynamicRelatedKeyList(self, key_list, sql_catalog_id=None):
743
      """
744
      Return the list of dynamic related keys.
745 746
      This method will try to automatically generate new related key
      by looking at the category tree.
747 748 749 750

      For exemple it will generate:
      destination_title | category,catalog/title/z_related_destination
      default_destination_title | category,catalog/title/z_related_destination
751 752 753 754
      strict_destination_title | category,catalog/title/z_related_strict_destination

      strict_ related keys only returns documents which are strictly member of
      the category.
755 756
      """
      related_key_list = []
757
      base_cat_id_list = self.portal_categories.getBaseCategoryDict()
758
      default_string = 'default_'
759
      strict_string = 'strict_'
760
      for key in key_list:
761
        prefix = ''
762
        strict = 0
763 764 765
        if key.startswith(default_string):
          key = key[len(default_string):]
          prefix = default_string
766 767 768 769
        if key.startswith(strict_string):
          strict = 1
          key = key[len(strict_string):]
          prefix = prefix + strict_string
770
        splitted_key = key.split('_')
771 772
        # look from the end of the key from the beginning if we
        # can find 'title', or 'portal_type'...
773 774
        for i in range(1,len(splitted_key))[::-1]:
          expected_base_cat_id = '_'.join(splitted_key[0:i])
775
          if expected_base_cat_id != 'parent' and \
776 777 778
             expected_base_cat_id in base_cat_id_list:
            # We have found a base_category
            end_key = '_'.join(splitted_key[i:])
779
            # accept only some catalog columns
780 781
            if end_key in ('title', 'uid', 'description',
                           'relative_url', 'id', 'portal_type'):
782 783 784 785 786 787
              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(
788 789
                      '%s%s | category,catalog/%s/z_related_%s' %
                      (prefix, key, end_key, expected_base_cat_id))
790 791 792 793 794 795

      return related_key_list

    def _aq_dynamic(self, name):
      """
      Automatic related key generation.
796
      Will generate z_related_[base_category_id] if possible
797 798 799 800
      """
      aq_base_name = getattr(aq_base(self), name, None)
      if aq_base_name == None:
        DYNAMIC_METHOD_NAME = 'z_related_'
801
        STRICT_DYNAMIC_METHOD_NAME = 'z_related_strict_'
802 803 804 805
        method_name_length = len(DYNAMIC_METHOD_NAME)
        zope_security = '__roles__'
        if (name.startswith(DYNAMIC_METHOD_NAME) and \
          (not name.endswith(zope_security))):
806 807
          if name.startswith(STRICT_DYNAMIC_METHOD_NAME):
            base_category_id = name[len(STRICT_DYNAMIC_METHOD_NAME):]
808
            method = RelatedBaseCategory(base_category_id, strict_membership=1)
809 810 811
          else:
            base_category_id = name[len(DYNAMIC_METHOD_NAME):]
            method = RelatedBaseCategory(base_category_id)
812
          setattr(self.__class__, name, method)
813 814 815 816 817
          klass = aq_base(self).__class__
          if hasattr(klass, 'security'):
            from Products.ERP5Type import Permissions as ERP5Permissions
            klass.security.declareProtected(ERP5Permissions.View, name)
          else:
818 819
            LOG('ERP5Catalog', PROBLEM,
                'Security not defined on %s' % klass.__name__)
820 821 822 823
          return getattr(self, name)
        else:
          return aq_base_name
      return aq_base_name
824 825 826



827
InitializeClass(CatalogTool)