SQLCatalog.py 88.3 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL. All Rights Reserved.
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
#
##############################################################################

from Persistence import Persistent
import Acquisition
import ExtensionClass
18
import Globals
19
import OFS.History
20
from Globals import DTMLFile, PersistentMapping
21
from string import split, join
22
from thread import allocate_lock, get_ident
23
from OFS.Folder import Folder
24
from AccessControl import ClassSecurityInfo
25
from BTrees.OIBTree import OIBTree
26 27
from App.config import getConfiguration
from BTrees.Length import Length
28
from Shared.DC.ZRDB.TM import TM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
29

30
from DateTime import DateTime
31 32
from Acquisition import aq_parent, aq_inner, aq_base
from zLOG import LOG, WARNING, INFO, TRACE
33
from ZODB.POSException import ConflictError
34
from DocumentTemplate.DT_Var import sql_quote
35
from Products.PythonScripts.Utility import allow_class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
36 37

import time
Jean-Paul Smets's avatar
Jean-Paul Smets committed
38
import sys
39 40
import urllib
import string
41
import pprint
42
from cStringIO import StringIO
43
from xml.dom.minidom import parse
44
from xml.sax.saxutils import escape, quoteattr
45 46
import os
import md5
47
from sets import ImmutableSet
48 49 50 51 52 53 54 55 56

try:
  from Products.CMFCore.Expression import Expression
  from Products.PageTemplates.Expressions import getEngine
  from Products.CMFCore.utils import getToolByName
  withCMF = 1
except ImportError:
  withCMF = 0

57 58 59 60
try:
  import psyco
except ImportError:
  psyco = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
61

62
try:
63 64
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache
  from Products.ERP5Type.Cache import disableReadOnlyTransactionCache, CachingMethod
65 66 67
except ImportError:
  def doNothing(context):
    pass
68 69 70 71 72 73
  class CachingMethod:
    """
      Dummy CachingMethod class.
    """
    def __init__(self, callable, **kw):
      self.function = callable
Yoshinori Okuji's avatar
Yoshinori Okuji committed
74
    def __call__(self, *opts, **kw):
75
      return self.function(*opts, **kw)
76 77
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
Ivan Tyagov's avatar
Ivan Tyagov committed
78
 
79
UID_BUFFER_SIZE = 300
80 81
OBJECT_LIST_SIZE = 300
MAX_PATH_LEN = 255
82
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
83 84
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report',
                     'extra_key_list', )
85

86
valid_method_meta_type_list = ('Z SQL Method', 'LDIF Method', 'Script (Python)') # Nicer
87

88 89 90 91 92
full_text_search_modes = { 'natural': '',                                   # XXX-JPS probably not right place
                           'in_boolean_mode': 'IN BOOLEAN MODE',            # full_text_search_modes wrong naming
                           'with_query_expansion': 'WITH QUERY EXPANSION' } # according to ERP5 conventions
                                                                            # we really need a good grammar
                                                                            # and some cleanup
93

94
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
95

96 97 98 99 100
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

101
def manage_addSQLCatalog(self, id, title,
102
             vocab_id='create_default_catalog_', # vocab_id is a strange name - not abbreviation
103 104 105
             REQUEST=None):
  """Add a Catalog object
  """
106 107 108
  id = str(id)
  title = str(title)
  vocab_id = str(vocab_id)
109 110 111
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

112
  c = Catalog(id, title, self)
113 114 115 116
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

117 118
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
119

Yoshinori Okuji's avatar
Yoshinori Okuji committed
120
  def __init__(self):
121
    """Initialize some variables.
122

123
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
124

125
      finished_buffer is used to hold reserved uids created by committed-transactions.
126

127
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
128
      invalid afterwards, so they may not be used by other transactions."""
129 130
    self.temporary_buffer = {}
    self.finished_buffer = []
131

132 133 134 135 136 137 138 139
  def _finish(self):
    """Move the uids in the temporary buffer to the finished buffer."""
    tid = get_ident()
    try:
      self.finished_buffer.extend(self.temporary_buffer[tid])
      del self.temporary_buffer[tid]
    except KeyError:
      pass
140

141 142 143 144 145 146 147
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
148

149 150 151 152 153 154 155 156
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
157

158 159 160 161 162 163 164 165 166 167 168
  def remove(self, value):
    self._register()
    for uid_list in self.temporary_buffer.values():
      try:
        uid_list.remove(value)
      except ValueError:
        pass
    try:
      self.finished_buffer.remove(value)
    except ValueError:
      pass
169

170 171 172 173
  def pop(self):
    self._register()
    tid = get_ident()
    try:
174
      uid = self.temporary_buffer[tid].pop()
175
    except (KeyError, IndexError):
176 177
      uid = self.finished_buffer.pop()
    return uid
178

179 180 181
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
182
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
183

184 185 186 187 188
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
              ExtensionClass.Base,
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
189 190 191 192
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
193
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
194 195 196 197 198 199 200 201

  This class is not Zope specific, and can be used in any python
  program to build catalogs of objects.  Note that it does require
  the objects to be Persistent, and thus must be used with ZODB3.

  uid -> the (local) universal ID of objects
  path -> the (local) path of objects

202 203
  If you pass it a keyword argument which is present in sql_catalog_full_text_search_keys
  (in catalog properties), it does a MySQL full-text search.
204 205 206
  Additionally you can pass it a search_mode argument ('natural', 'in_boolean_mode'
  or 'with_query_expansion') to use an advanced search mode ('natural'
  is the default).
207 208 209
  search_mode arg can be given for all full_text keys, or for a specific key by naming
  the argument search_mode_KeyName, or even more specifically, search_mode_Table.Key
  or search_mode_Table_Key
210

Jean-Paul Smets's avatar
Jean-Paul Smets committed
211

212
  brain defined in methods...
Jean-Paul Smets's avatar
Jean-Paul Smets committed
213 214 215 216 217 218

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
219
  meta_type = "SQLCatalog"
220
  icon = 'misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
  security = ClassSecurityInfo()

  manage_options = (
    {'label': 'Contents',       # TAB: Contents
     'action': 'manage_main',
     'help': ('OFSP','ObjectManager_Contents.stx')},
    {'label': 'Catalog',      # TAB: Catalogged Objects
     'action': 'manage_catalogView',
     'help':('ZCatalog','ZCatalog_Cataloged-Objects.stx')},
    {'label': 'Properties',     # TAB: Properties
     'action': 'manage_propertiesForm',
     'help': ('OFSP','Properties.stx')},
    {'label': 'Filter',     # TAB: Filter
     'action': 'manage_catalogFilter',},
    {'label': 'Find Objects',     # TAB: Find Objects
     'action': 'manage_catalogFind',
     'help':('ZCatalog','ZCatalog_Find-Items-to-ZCatalog.stx')},
    {'label': 'Advanced',       # TAB: Advanced
     'action': 'manage_catalogAdvanced',
     'help':('ZCatalog','ZCatalog_Advanced.stx')},
    {'label': 'Undo',         # TAB: Undo
     'action': 'manage_UndoForm',
     'help': ('OFSP','Undo.stx')},
    {'label': 'Security',       # TAB: Security
     'action': 'manage_access',
     'help': ('OFSP','Security.stx')},
    {'label': 'Ownership',      # TAB: Ownership
     'action': 'manage_owner',
     'help': ('OFSP','Ownership.stx'),}
250
    ) + OFS.History.Historical.manage_options
251

252
  __ac_permissions__= (
253 254 255 256 257

    ('Manage ZCatalog Entries',
     ['manage_catalogObject', 'manage_uncatalogObject',

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
258 259
      'manage_catalogFilter',
      'manage_catalogAdvanced',
260 261

      'manage_catalogReindex', 'manage_catalogFoundItems',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
262 263
      'manage_catalogClear',
      'manage_main',
264 265 266 267 268 269
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
270 271
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
272
      'getFilterableMethodList',],
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
     ['Anonymous', 'Manager']),

    ('Import/Export objects',
     ['manage_exportProperties', 'manage_importProperties', ],
     ['Manager']),

    )

  _properties = (
    { 'id'      : 'title',
      'description' : 'The title of this catalog',
      'type'    : 'string',
      'mode'    : 'w' },

    # Z SQL Methods
    { 'id'      : 'sql_catalog_produce_reserved',
      'description' : 'A method to produce new uid values in advance',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_clear_reserved',
      'description' : 'A method to clear reserved uid values',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
298 299 300 301 302
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
303 304 305 306 307
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
308 309
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
310 311 312 313 314 315 316 317
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_uncatalog_object',
      'description' : 'Methods to be called to uncatalog an object',
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
318 319 320
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
321 322
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
323 324 325
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
326 327
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
328 329
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
330 331 332
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
333
    { 'id'      : 'sql_record_object_list',
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
      'description' : 'Method to record catalog information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_read_recorded_object_list',
      'description' : 'Method to get recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_delete_recorded_object_list',
      'description' : 'Method to delete recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
Aurel's avatar
Aurel committed
353 354 355 356 357
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
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
    { 'id'      : 'sql_search_tables',
      'description' : 'Tables to join in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getTableIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_result_keys',
      'description' : 'Keys to display in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getResultColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_count_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_path',
      'description' : 'Get a catalog brain by path',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_uid',
      'description' : 'Get a catalog brain by uid',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_tables',
      'description' : 'Method to get the main catalog tables',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_schema',
      'description' : 'Method to get the main catalog schema',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
393 394 395 396 397
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
    { 'id'      : 'sql_unique_values',
      'description' : 'Find unique disctinct values in a column',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_paths',
      'description' : 'List all object paths in catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_keyword_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
413 414 415 416 417
    { 'id'      : 'sql_catalog_datetime_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    { 'id'      : 'sql_catalog_full_text_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_request_keys',
      'description' : 'Columns which should be ignore in the REQUEST in order to accelerate caching',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_multivalue_keys',
      'description' : 'Keys which hold multiple values',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
433 434 435 436 437
    { 'id'      : 'sql_catalog_index_on_order_keys',
      'description' : 'Columns which should be used by specifying an index when sorting on them',
      'type'    : 'multiple selection',
      'select_variable' : 'getSortColumnIds',
      'mode'    : 'w' },
438 439 440 441 442 443 444 445 446
    { 'id'      : 'sql_catalog_topic_search_keys',
      'description' : 'Columns which should be considered as topic index',
      'type'    : 'lines',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_related_keys',
      'title'   : 'Related keys',
      'description' : 'Additional columns obtained through joins',
      'type'    : 'lines',
      'mode'    : 'w' },
447 448 449 450 451
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
452 453 454 455 456 457 458 459 460 461 462
    { 'id': 'sql_catalog_role_keys',
      'title': 'Role keys',
      'description': 'Columns which should be used to map a monovalued role',
      'type': 'lines',
      'mode': 'w' },
    { 'id': 'sql_catalog_local_role_keys',
      'title': 'Local Role keys',
      'description': 'Columns which should be used to map' \
                      'a monovalued local role',
      'type': 'lines',
      'mode': 'w' },
463 464
  )

465
  sql_catalog_produce_reserved = ''
466
  sql_catalog_delete_uid = ''
467 468 469 470 471 472 473 474 475 476 477
  sql_catalog_clear_reserved = ''
  sql_catalog_reserve_uid = ''
  sql_catalog_object_list = ()
  sql_uncatalog_object = ()
  sql_clear_catalog = ()
  sql_catalog_translation_list = ''
  sql_delete_translation_list = ''
  sql_record_object_list = ''
  sql_read_recorded_object_list = ''
  sql_delete_recorded_object_list = ''
  sql_search_results = ''
Aurel's avatar
Aurel committed
478
  sql_search_security = ''
479 480 481 482 483 484
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
485
  sql_catalog_index = ''
486 487 488
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
489
  sql_catalog_datetime_search_keys = ()
490 491 492 493 494
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
495
  sql_catalog_index_on_order_keys = ()
496
  sql_catalog_related_keys = ()
497
  sql_catalog_scriptable_keys = ()
498 499
  sql_catalog_role_keys = ()
  sql_catalog_local_role_keys = ()
500

501 502 503 504 505 506
  # These are ZODB variables, so shared by multiple Zope instances.
  # This is set to the last logical time when clearReserved is called.
  _last_clear_reserved_time = 0
  # This is to record the maximum value of uids. Because this uses the class Length
  # in BTrees.Length, this does not generate conflict errors.
  _max_uid = None
507

508 509 510 511 512 513 514
  # These are class variable on memory, so shared only by threads in the same Zope instance.
  # This is set to the time when reserved uids are cleared in this Zope instance.
  _local_clear_reserved_time = None
  # This is used for exclusive access to the list of reserved uids.
  _reserved_uid_lock = allocate_lock()
  # This is an instance id which specifies who owns which reserved uids.
  _instance_id = getattr(getConfiguration(), 'instance_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
515

516 517 518 519 520 521 522 523 524 525
  manage_catalogView = DTMLFile('dtml/catalogView',globals())
  manage_catalogFilter = DTMLFile('dtml/catalogFilter',globals())
  manage_catalogFind = DTMLFile('dtml/catalogFind',globals())
  manage_catalogAdvanced = DTMLFile('dtml/catalogAdvanced', globals())

  def __init__(self, id, title='', container=None):
    if container is not None:
      self=self.__of__(container)
    self.id=id
    self.title=title
Jean-Paul Smets's avatar
Jean-Paul Smets committed
526 527 528
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
529
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
530

531 532 533 534 535 536 537 538 539 540 541 542 543 544
  def getSQLCatalogRoleKeysList(self):
    """
    Return the list of role keys.
    """
    return [tuple([y.strip() for y in x.split('|')]) \
              for x in self.sql_catalog_role_keys]

  def getSQLCatalogLocalRoleKeysList(self):
    """
    Return the list of local role keys.
    """
    return [tuple([y.strip() for y in x.split('|')]) \
              for x in self.sql_catalog_local_role_keys]

545 546 547 548 549 550
  def manage_exportProperties(self, REQUEST=None, RESPONSE=None):
    """
      Export properties to an XML file.
    """
    f = StringIO()
    f.write('<?xml version="1.0"?>\n<SQLCatalogData>\n')
551 552 553 554 555 556 557 558 559 560 561 562
    property_id_list = self.propertyIds()
    # Get properties and values
    property_list = []
    for property_id in property_id_list:
      value = self.getProperty(property_id)
      if value is not None:
        property_list.append((property_id, value))
    # Sort for easy diff
    property_list.sort(lambda x, y: cmp(x[0], y[0]))
    for property in property_list:
      property_id = property[0]
      value       = property[1]
563
      if isinstance(value, basestring):
564
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
565
      elif isinstance(value, (tuple, list)):
566 567 568
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
569
        for item in value:
570
          if isinstance(item, basestring):
571 572 573 574
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
575
        f.write('  </property>\n')
576 577 578
    # XXX Although filters are not properties, output filters here.
    # XXX Ideally, filters should be properties in Z SQL Methods, shouldn't they?
    if hasattr(self, 'filter_dict'):
579 580
      filter_list = []
      for filter_id in self.filter_dict.keys():
581
        filter_definition = self.filter_dict[filter_id]
582 583 584 585 586 587 588
        filter_list.append((filter_id, filter_definition))
      # Sort for easy diff
      filter_list.sort(lambda x, y: cmp(x[0], y[0]))
      for filter_item in filter_list:
        filter_id  = filter_item[0]
        filter_def = filter_item[1]
        if not filter_def['filtered']:
589 590
          # If a filter is not activated, no need to output it.
          continue
591
        if not filter_def['expression']:
592 593
          # If the expression is not specified, meaningless to specify it.
          continue
594
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
595
        # For now, portal types are not exported, because portal types are too specific to each site.
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
    f.write('</SQLCatalogData>\n')

    if RESPONSE is not None:
      RESPONSE.setHeader('Content-type','application/data')
      RESPONSE.setHeader('Content-Disposition',
                          'inline;filename=properties.xml')
    return f.getvalue()

  def manage_importProperties(self, file):
    """
      Import properties from an XML file.
    """
    f = open(file)
    try:
      doc = parse(f)
      root = doc.documentElement
      try:
        for prop in root.getElementsByTagName("property"):
          id = prop.getAttribute("id")
          type = prop.getAttribute("type")
          if not id or not hasattr(self, id):
617
            raise CatalogError, 'unknown property id %r' % (id,)
618
          if type not in ('str', 'tuple'):
619
            raise CatalogError, 'unknown property type %r' % (type,)
620 621 622 623
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
624
                value = str(text.data)
625 626 627 628 629 630
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
631
                raise CatalogError, 'unknown item type %r' % (item_type,)
632 633
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
634
                  value.append(str(text.data))
635 636 637 638
                  break
            value = tuple(value)

          setattr(self, id, value)
639

640 641 642
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
643
          id = str(filt.getAttribute("id"))
644 645 646 647 648 649 650 651 652 653 654 655
          expression = filt.getAttribute("expression")
          if not self.filter_dict.has_key(id):
            self.filter_dict[id] = PersistentMapping()
          self.filter_dict[id]['filtered'] = 1
          self.filter_dict[id]['type'] = []
          if expression:
            expr_instance = Expression(expression)
            self.filter_dict[id]['expression'] = expression
            self.filter_dict[id]['expression_instance'] = expr_instance
          else:
            self.filter_dict[id]['expression'] = ""
            self.filter_dict[id]['expression_instance'] = None
656 657 658 659
      finally:
        doc.unlink()
    finally:
      f.close()
Aurel's avatar
Aurel committed
660

661 662 663 664 665 666 667
  def manage_historyCompare(self, rev1, rev2, REQUEST,
                            historyComparisonResults=''):
    return Catalog.inheritedAttribute('manage_historyCompare')(
          self, rev1, rev2, REQUEST,
          historyComparisonResults=OFS.History.html_diff(
              pprint.pformat(rev1.__dict__),
              pprint.pformat(rev2.__dict__)))
668 669 670

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
671
    self.security_uid_index = None
672 673

  security.declarePrivate('getSecurityUid')
674
  def getSecurityUid(self, wrapped_object):
675 676 677 678 679 680 681
    """
      Cache a uid for each security permission

      We try to create a unique security (to reduce number of lines)
      and to assign security only to root document
    """
    # Get security information
682
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
683 684 685 686
    # Sort it
    allowed_roles_and_users = list(allowed_roles_and_users)
    allowed_roles_and_users.sort()
    allowed_roles_and_users = tuple(allowed_roles_and_users)
687 688
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
689 690 691
      self._clearSecurityCache()
    if self.security_uid_dict.has_key(allowed_roles_and_users):
      return (self.security_uid_dict[allowed_roles_and_users], None)
692 693 694 695 696 697 698 699
    # If the id_tool is there, it is better to use it, it allows
    # to create many new security uids by the same time
    # because with this tool we are sure that we will have 2 different
    # uids if two instances are doing this code in the same time
    id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
    if id_tool is not None:
      default = 1
      # We must keep compatibility with existing sites
700 701
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
702 703 704 705
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
706
          default = previous_security_uid
707 708 709 710 711 712 713 714 715 716 717
      security_uid = id_tool.generateNewLengthId(id_group='security_uid_index',
                                        default=default)
    else:
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is None:
        previous_security_uid = 0
      # At some point, it was a Length
      if isinstance(previous_security_uid, Length):
        previous_security_uid = previous_security_uid()
      security_uid = previous_security_uid + 1
      self.security_uid_index = security_uid
718 719
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
720

Jean-Paul Smets's avatar
Jean-Paul Smets committed
721 722 723 724 725 726
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
727
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
728 729
      try:
        method()
730 731
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
732
      except:
733
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
734
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
735

736
    # Reserved uids have been removed.
737
    self.clearReserved()
738

739
    # Add a dummy item so that SQLCatalog will not use existing uids again.
740
    self.insertMaxUid()
741

742
    # Remove the cache of catalog schema.
743 744
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
745

746
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
747

748 749 750 751 752 753 754 755 756 757
  def insertMaxUid(self):
    """
      Add a dummy item so that SQLCatalog will not use existing uids again.
    """
    if self._max_uid is not None and self._max_uid() != 0:
      method_id = self.sql_catalog_reserve_uid
      method = getattr(self, method_id)
      self._max_uid.change(1)
      method(uid = [self._max_uid()])

758 759 760 761 762 763
  def clearReserved(self):
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
Romain Courteaud's avatar
Romain Courteaud committed
764 765 766 767 768
    try:
      method()
    except ConflictError:
      raise
    except:
769
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
770 771 772
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
773
    self._last_clear_reserved_time += 1
774

Jean-Paul Smets's avatar
Jean-Paul Smets committed
775 776 777 778 779 780 781 782 783
  def __getitem__(self, uid):
    """
    Get an object by UID
    Note: brain is defined in Z SQL Method object
    """
    method = getattr(self,  self.sql_getitem_by_uid)
    search_result = method(uid = uid)
    if len(search_result) > 0:
      return search_result[0]
784
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

  def editSchema(self, names_list):
    """
    Builds a schema from a list of strings
    Splits each string to build a list of attribute names
    Columns on the database should not change during this operations
    """
    i = 0
    schema = {}
    names = {}
    for cid in self.getColumnIds():
      name_list = []
      for name in names_list[i].split():
        schema[name] = cid
        name_list += [name,]
      names[cid] = tuple(name_list)
      i += 1
    self.schema = schema
    self.names = names

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
  def getCatalogSearchTableIds(self):
    """Return selected tables of catalog which are used in JOIN.
       catalaog is always first
    """
    search_tables = self.sql_search_tables
    if len(search_tables) > 0:
      if search_tables[0] != 'catalog':
        result = ['catalog']
        for t in search_tables:
          if t != 'catalog':
            result.append(t)
        self.sql_search_tables = result
    else:
      self.sql_search_tables = ['catalog']

    return self.sql_search_tables

822
  security.declarePublic('getCatalogSearchResultKeys')
823 824 825 826
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
827

828
  def _getCatalogSchema(self, table=None):
829 830 831
    # XXX: Using a volatile as a cache makes it impossible to flush
    # consistently on all connections containing the volatile. Another
    # caching scheme must be used here.
832
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
833

834 835 836 837 838 839 840 841 842
    if table not in catalog_schema_dict:
      result_list = []
      try:
        method_name = self.sql_catalog_schema
        method = getattr(self, method_name)
        #LOG('_getCatalogSchema', 0, 'method_name = %r, method = %r, table = %r' % (method_name, method, table))
        search_result = method(table=table)
        for c in search_result:
          result_list.append(c.Field)
843 844
      except ConflictError:
        raise
845
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
846
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
847 848 849
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
850

851
    return catalog_schema_dict[table]
852

Jean-Paul Smets's avatar
Jean-Paul Smets committed
853 854
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
855 856 857
    Calls the show column method and returns dictionnary of
    Field Ids
    """
858
    def _getColumnIds():
859 860 861 862
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
863 864
          keys[field] = None
          keys['%s.%s' % (table, field)] = None  # Is this inconsistent ?
865
      for related in self.getSQLCatalogRelatedKeyList():
866 867
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
868
        keys[related_key] = None
869 870 871
      for scriptable in self.getSQLCatalogScriptableKeyList():
        scriptable_tuple = scriptable.split('|')
        scriptable = scriptable_tuple[0].strip()
872
        keys[scriptable] = None
873 874 875
      keys = keys.keys()
      keys.sort()
      return keys
Aurel's avatar
Aurel committed
876
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_factory='erp5_content_long')()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
877

878 879 880 881 882
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
883
    def _getColumnMap():
884 885 886 887 888 889 890 891 892 893 894
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
          key = field
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table)
          key = '%s.%s' % (table, key)
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table) # Is this inconsistent ?
      return keys
Aurel's avatar
Aurel committed
895
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_factory='erp5_content_long')()
896

Jean-Paul Smets's avatar
Jean-Paul Smets committed
897 898 899 900 901 902 903
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
904 905 906
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys['%s.%s' % (table, field)] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
907 908 909 910
    keys = keys.keys()
    keys.sort()
    return keys

911 912 913 914 915 916 917 918 919 920 921 922 923 924
  def getSortColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids that can be used for a sort
    """
    keys = {}
    for table in self.getTableIds():
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys['%s.%s' % (table, field)] = 1
    keys = keys.keys()
    keys.sort()
    return keys

Jean-Paul Smets's avatar
Jean-Paul Smets committed
925 926 927
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
928 929 930
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
931 932
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
933 934 935
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
936
        keys.append(c[0])
937 938
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
939 940
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
941 942
    return keys

943 944 945 946 947 948 949 950 951 952 953 954 955 956
  def getUIDBuffer(self, force_new_buffer=False):
    global global_uid_buffer_dict
    klass = self.__class__
    assert klass._reserved_uid_lock.locked()
    assert getattr(self, 'aq_base', None) is not None
    instance_key = self.getPhysicalPath()
    if instance_key not in global_uid_buffer_dict:
      global_uid_buffer_dict[instance_key] = {}
    uid_buffer_dict = global_uid_buffer_dict[instance_key]
    thread_key = get_ident()
    if force_new_buffer or thread_key not in uid_buffer_dict:
      uid_buffer_dict[thread_key] = UidBuffer()
    return uid_buffer_dict[thread_key]
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
957
  # the cataloging API
958 959 960
  def produceUid(self):
    """
      Produces reserved uids in advance
961
    """
962 963 964 965
    klass = self.__class__
    assert klass._reserved_uid_lock.locked()
    # This checks if the list of local reserved uids was cleared after clearReserved
    # had been called.
966 967 968 969
    force_new_buffer = (klass._local_clear_reserved_time != self._last_clear_reserved_time)
    uid_buffer = self.getUIDBuffer(force_new_buffer=force_new_buffer)
    klass._local_clear_reserved_time = self._last_clear_reserved_time
    if len(uid_buffer) == 0:
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
      id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
      if id_tool is not None:
        if self._max_uid is None:
          self._max_uid = Length()
        uid_list = id_tool.generateNewLengthIdList(id_group='catalog_uid',
                     id_count=UID_BUFFER_SIZE, default=self._max_uid())
        # TODO: if this method is kept and former uid allocation code is
        # discarded, self._max_uid duplicates work done by portal_ids: it
        # already keeps track of the highest allocated number for all id
        # generator groups.
      else:
        method_id = self.sql_catalog_produce_reserved
        method = getattr(self, method_id)
        # Generate an instance id randomly. Note that there is a small possibility that this
        # would conflict with others.
        random_factor_list = [time.time(), os.getpid(), os.times()]
        try:
          random_factor_list.append(os.getloadavg())
        except (OSError, AttributeError): # AttributeError is required under cygwin
          pass
        instance_id = md5.new(str(random_factor_list)).hexdigest()
        uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
992
      uid_buffer.extend(uid_list)
993

994 995 996 997 998 999
  def isIndexable(self):
    """
    This is required to check in many methods that
    the site root and zope root are indexable
    """
    zope_root = self.getZopeRoot()
1000
    site_root = self.getSiteRoot() # XXX-JPS - Why don't we use getPortalObject here ?
1001 1002 1003 1004 1005 1006

    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
    site_indexable = int(getattr(site_root, 'isIndexable', 1))
    if not (root_indexable and site_indexable):
      return False
    return True
Aurel's avatar
Aurel committed
1007

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
  def getSiteRoot(self):
    """
    Returns the root of the site
    """
    if withCMF:
      site_root = getToolByName(self, 'portal_url').getPortalObject()
    else:
      site_root = self.aq_parent
    return site_root

  def getZopeRoot(self):
    """
    Returns the root of the zope
    """
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
    else:
      zope_root = self.getPhysicalRoot()
    return zope_root

1028 1029 1030
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1031 1032
      with multiple ZEO clients on a single ZEO server.

1033
      The main risk is the following:
1034

1035
      - objects a/b/c/d/e/f are created (a is parent of b which is parent of ... of f)
1036

1037
      - one reindexing node N1 starts reindexing f
1038

1039
      - another reindexing node N2 starts reindexing e
1040

1041 1042 1043
      - there is a strong risk that N1 and N2 start reindexing at the same time
        and provide different uid values for a/b/c/d/e

1044
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1045
      with the risk of graph loops
1046
    """
1047
    if not self.isIndexable():
1048 1049
      return None

1050 1051 1052 1053
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1054 1055 1056
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1057 1058 1059 1060 1061 1062
        # Vincent added this 2006/01/25
        #if uid > 4294967296: # 2**32
        #if uid > 10000000: # arbitrary level : below it's normal, above it's suspicious
        #   LOG('SQLCatalog', WARNING, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,))
        #   raise RuntimeError, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,)
        # end
1063 1064 1065 1066
        if self._max_uid is None:
          self._max_uid = Length()
        if uid > self._max_uid():
          self._max_uid.set(uid)
1067
        return long(uid)
1068 1069 1070 1071
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1072

1073 1074 1075
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1076
      if isinstance(urls, str):
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
        urls=(urls,)

      for url in urls:
        obj = self.resolve_path(url)
        if not obj:
          obj = self.resolve_url(url, REQUEST)
        if obj is not None:
          self.aq_parent.catalog_object(obj, url, sql_catalog_id=self.id)

    RESPONSE.redirect(URL1 + '/manage_catalogView?manage_tabs_message=Object%20Cataloged')

  def manage_uncatalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ removes Zope object(s) 'urls' from catalog """

    if urls:
1092
      if isinstance(urls, str):
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
        urls=(urls,)

      for url in urls:
        self.aq_parent.uncatalog_object(url, sql_catalog_id=self.id)

    RESPONSE.redirect(URL1 + '/manage_catalogView?manage_tabs_message=Object%20Uncataloged')

  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1):
    """ clear the catalog, then re-index everything """
    elapse = time.time()
    c_elapse = time.clock()

    self.aq_parent.refreshCatalog(clear=1, sql_catalog_id=self.id)

    elapse = time.time() - elapse
    c_elapse = time.clock() - c_elapse

    RESPONSE.redirect(URL1 +
              '/manage_catalogAdvanced?manage_tabs_message=' +
              urllib.quote('Catalog Updated<br>'
                     'Total time: %s<br>'
                     'Total CPU time: %s' % (`elapse`, `c_elapse`)))

1116
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1117
                          URL1=None, sql_catalog_id=None):
1118
    """ clears the whole enchilada """
1119 1120
    self.beforeCatalogClear()

1121 1122 1123
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1124
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1125
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1126 1127

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1128
    """ clears reserved uids """
1129 1130 1131
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1132
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1133
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

  def manage_catalogFoundItems(self, REQUEST, RESPONSE, URL2, URL1,
                 obj_metatypes=None,
                 obj_ids=None, obj_searchterm=None,
                 obj_expr=None, obj_mtime=None,
                 obj_mspec=None, obj_roles=None,
                 obj_permission=None):
    """ Find object according to search criteria and Catalog them
    """
    elapse = time.time()
    c_elapse = time.clock()

    words = 0
    obj = REQUEST.PARENTS[1]
    path = string.join(obj.getPhysicalPath(), '/')

    results = self.aq_parent.ZopeFindAndApply(obj,
                    obj_metatypes=obj_metatypes,
                    obj_ids=obj_ids,
                    obj_searchterm=obj_searchterm,
                    obj_expr=obj_expr,
                    obj_mtime=obj_mtime,
                    obj_mspec=obj_mspec,
                    obj_permission=obj_permission,
                    obj_roles=obj_roles,
                    search_sub=1,
                    REQUEST=REQUEST,
                    apply_func=self.aq_parent.catalog_object,
                    apply_path=path,
                    sql_catalog_id=self.id)

    elapse = time.time() - elapse
    c_elapse = time.clock() - c_elapse

    RESPONSE.redirect(URL1 + '/manage_catalogView?manage_tabs_message=' +
              urllib.quote('Catalog Updated<br>Total time: %s<br>Total CPU time: %s' % (`elapse`, `c_elapse`)))

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1171
  def catalogObject(self, object, path, is_object_moved=0):
1172 1173
    """Add an object to the Catalog by calling all SQL methods and
    providing needed arguments.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1174

1175 1176
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1177

1178 1179 1180 1181
  def catalogObjectList(self, object_list, method_id_list=None, 
                        disable_cache=0, check_uid=1, idxs=None):
    """Add objects to the Catalog by calling all SQL methods and
    providing needed arguments.
1182

1183 1184
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1185 1186

      disable_cache : do not use cache, so values will be computed each time,
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
                      only useful in some particular cases, most of the time
                      you don't need to use it.

    Each element of 'object_list' is an object to be catalogged.

    'uid' is the unique Catalog identifier for this object.
    
    Note that this method calls _catalogObjectList with fragments of
    the object list, because calling _catalogObjectList with too many
    objects at a time bloats the process's memory consumption, due to
    caching."""
    # XXX 300 is arbitrary.
1199 1200
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
                              method_id_list=method_id_list,
                              disable_cache=disable_cache,
                              check_uid=check_uid,
                              idxs=idxs)
    
  def _catalogObjectList(self, object_list, method_id_list=None, 
                         disable_cache=0, check_uid=1, idxs=None):
    """This is the real method to catalog objects.

    XXX: For now newUid is used to allocated UIDs. Is this good?
    Is it better to INSERT then SELECT?"""
1212
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1213
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1214

1215
    if idxs not in (None, []):
1216 1217
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1218

1219
    if not self.isIndexable():
1220
      return
1221

1222 1223 1224
    portal_catalog = self.getSiteRoot().portal_catalog # XXX-JPS - This is a hardcoded name. Weird
                                                       # Isn't self == self.getSiteRoot().portal_catalog
                                                       # in this case ?
1225

1226 1227
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
    path_uid_dict = {}
    uid_path_dict = {}

    if check_uid:
      path_list = []
      path_list_append = path_list.append
      uid_list = []
      uid_list_append = uid_list.append
      for object in object_list:
        path = object.getPath()
        if path is not None:
          path_list_append(path)
        uid = object.uid
        if uid is not None:
          uid_list_append(uid)
      path_uid_dict = self.getUidDictForPathList(path_list=path_list)
      uid_path_dict = self.getPathDictForUidList(uid_list=uid_list)

1246
    for object in object_list:
1247
      if not getattr(aq_base(object), 'uid', None):
1248
        try:
1249
          object.uid = self.newUid()
1250 1251
        except ConflictError:
          raise
1252
        except:
1253
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1254
      elif check_uid:
1255 1256
        uid = object.uid
        path = object.getPath()
1257
        index = path_uid_dict.get(path, None)
1258
        try:
1259
          index = long(index)
1260
        except TypeError:
1261
          index = None
1262 1263 1264
        if index is not None and index < 0:
          raise CatalogError, 'A negative uid %d is used for %s. Your catalog is broken. Recreate your catalog.' % (index, path)
        if index:
1265 1266
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1267
            LOG('SQLCatalog', WARNING, 'uid of %r changed from %r (property) to %r (catalog, by path) !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, index))
1268 1269 1270 1271 1272 1273
            uid = index
            object.uid = uid
        else:
          # Make sure no duplicates - ie. if an object with different path has same uid, we need a new uid
          # This can be very dangerous with relations stored in a category table (CMFCategory)
          # This is why we recommend completely reindexing subobjects after any change of id
1274
          if uid in uid_path_dict:
1275 1276 1277
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1278 1279 1280 1281 1282 1283
          #LOG('catalogObject', 0, 'uid = %r, catalog_path = %r' % (uid, catalog_path))
          if catalog_path == "reserved":
            # Reserved line in catalog table
            klass = self.__class__
            try:
              klass._reserved_uid_lock.acquire()
1284 1285
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1286 1287 1288 1289 1290 1291 1292 1293
                # This is the case where:
                #   1. The object got an uid.
                #   2. The catalog was cleared.
                #   3. The catalog produced the same reserved uid.
                #   4. The object was reindexed.
                # In this case, the uid is not reserved any longer, but
                # SQLCatalog believes that it is still reserved. So it is
                # necessary to remove the uid from the list explicitly.
1294
                try:
1295
                  uid_buffer.remove(uid)
1296 1297
                except ValueError:
                  pass
1298 1299 1300 1301
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1302
            # can be due to path length
1303
            if len(path) > MAX_PATH_LEN:
1304 1305
              LOG('SQLCatalog', WARNING, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))

1306
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1307
            LOG('SQLCatalog', WARNING,
1308
                'uid of %r changed from %r to %r as old one is assigned to %s in catalog !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid, catalog_path))
1309

1310 1311
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1312
    econtext_cache = {}
1313
    expression_result_cache = {}
1314 1315
    argument_cache = {}

1316
    try:
1317
      if not disable_cache:
1318
        enableReadOnlyTransactionCache(self)
1319

1320
      for method_name in method_id_list:
1321
        kw = {}
1322
        if self.isMethodFiltered(method_name):
1323
          catalogged_object_list = []
1324 1325 1326 1327
          filter = self.filter_dict[method_name]
          type_set = ImmutableSet(filter['type']) or None
          expression = filter['expression_instance']
          expression_cache_key_list = filter.get('expression_cache_key', '').split()
1328 1329 1330 1331
          for object in object_list:
            # We will check if there is an filter on this
            # method, if so we may not call this zsqlMethod
            # for this object
1332
            if type_set is not None and object.getPortalType() not in type_set:
1333 1334
              continue
            elif expression is not None:
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
              if expression_cache_key_list:
                # We try to save results of expressions by portal_type
                # or by anyother key which can prevent us from evaluating
                # expressions. This cache is built each time we reindex
                # objects but we could also use over multiple transactions
                # if this can improve performance significantly
                try:
                  cache_key = map(lambda key: object.getProperty(key, None), expression_cache_key_list)
                    # ZZZ - we could find a way to compute this once only
                  cache_key = (method_name, tuple(cache_key))
                  result = expression_result_cache[cache_key]
                  compute_result = 0
                except KeyError:
                  cache_result = 1
                  compute_result = 1
              else:
                cache_result = 0
                compute_result = 1
              if compute_result:
                try:
                  econtext = econtext_cache[object.uid]
                except KeyError:
                  econtext = self.getExpressionContext(object)
                  econtext_cache[object.uid] = econtext
                result = expression(econtext)
              if cache_result:
                expression_result_cache[cache_key] = result
1362 1363 1364 1365 1366
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
1367

1368 1369
        if len(catalogged_object_list) == 0:
          continue
1370

1371 1372
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1373
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1374
          # Build the dictionnary of values
1375
          arguments = split(method.arguments_src)
1376 1377 1378
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1379 1380 1381 1382 1383 1384 1385 1386 1387
        else:
          arguments = []
        for arg in arguments:
          value_list = []
          append = value_list.append
          for object in catalogged_object_list:
            try:
              value = argument_cache[(object.uid, arg)]
            except KeyError:
1388
              try:
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
                value = getattr(object, arg, None)
                if callable(value):
                  value = value()
              except ConflictError:
                raise
              except:
                value = None
              if not disable_cache:
                argument_cache[(object.uid, arg)] = value
            append(value)
          kw[arg] = value_list
1400

Jérome Perrin's avatar
Jérome Perrin committed
1401
        method = aq_base(method).__of__(portal_catalog) # Use method in
1402 1403 1404 1405
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1406
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1407 1408 1409 1410 1411 1412 1413
          method(**kw)
          #end_time = DateTime()
          #if method_name not in profile_dict:
          #  profile_dict[method_name] = end_time.timeTime() - start_time.timeTime()
          #else:
          #  profile_dict[method_name] += end_time.timeTime() - start_time.timeTime()
          #LOG('catalogObjectList', 0, '%s: %f seconds' % (method_name, profile_dict[method_name]))
1414

1415 1416 1417
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1418
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1419 1420 1421
              error=sys.exc_info())
          raise
    finally:
1422
      if not disable_cache:
1423
        disableReadOnlyTransactionCache(self)
1424

1425 1426
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1427

1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
  def beforeUncatalogObject(self, path=None,uid=None):
    """
    Set the path as deleted
    """
    if not self.isIndexable():
      return None

    if uid is None and path is not None:
      uid = self.getUidForPath(path)
    method_name = self.sql_catalog_delete_uid
    if uid is None:
      return None
1440 1441 1442 1443
    if method_name in (None,''):
      # This should exist only if the site is not up to date.
      LOG('ZSQLCatalog.beforeUncatalogObject',0,'The sql_catalog_delete_uid'\
                                                + ' method is not defined')
Sebastien Robin's avatar
Sebastien Robin committed
1444
      return self.uncatalogObject(path=path,uid=uid)
1445 1446 1447
    method = getattr(self, method_name)
    method(uid = uid)

1448
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
    """
    Uncatalog and object from the Catalog.

    Note, the uid must be the same as when the object was
    catalogued, otherwise it will not get removed from the catalog

    This method should not raise an exception if the uid cannot
    be found in the catalog.

    XXX Add filter of methods

    """
1461
    if not self.isIndexable():
1462 1463
      return None

1464 1465
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1466 1467
    methods = self.sql_uncatalog_object
    if uid is None:
1468
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1469
    for method_name in methods:
1470 1471
      # Do not put try/except here, it is required to raise error
      # if uncatalog does not work.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1472
      method = getattr(self, method_name)
1473
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1474

1475 1476 1477 1478
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1479 1480
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1481

1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
  def deleteTranslationList(self):
    """Delete translations.
    """
    method_name = self.sql_delete_translation_list
    method = getattr(self, method_name)
    try:
      method()
    except ConflictError:
      raise
    except:
      LOG('SQLCatalog', WARNING, 'could not delete translations', error=sys.exc_info())
1493

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1494 1495 1496
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1497
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1498 1499 1500 1501 1502 1503 1504 1505

  def getPaths(self):
    """ Returns all object paths stored inside catalog """
    method = getattr(self, self.sql_catalog_paths)
    return method()

  def getUidForPath(self, path):
    """ Looks up into catalog table to convert path into uid """
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
    #try:
    if path is None:
      return None
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    search_result = method(path = path, uid_only=1)
    # If not empty, return first record
    if len(search_result) > 0:
      return long(search_result[0].uid)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1516 1517
      return None

1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
  def getUidDictForPathList(self, path_list):
    """ Looks up into catalog table to convert path into uid """
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    path_uid_dict = {}
    try:
      search_result = method(path_list = path_list)
      # If not empty, return first record
      for result in search_result:
        path_uid_dict[result.path] = result.uid
    except ValueError, message:
      # This code is only there for backward compatibility
      # XXX this must be removed one day
      # This means we have the previous zsql method
      # and we must call the method for every path
      for path in path_list:
        search_result = method(path = path)
        if len(search_result) > 0:
          path_uid_dict[path] = search_result[0].uid
    return path_uid_dict

  def getPathDictForUidList(self, uid_list):
    """ Looks up into catalog table to convert uid into path """
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_uid)
    uid_path_dict = {}
    try:
      search_result = method(uid_list = uid_list)
      # If not empty, return first record
      for result in search_result:
        uid_path_dict[result.uid] = result.path
    except ValueError, message:
      # This code is only there for backward compatibility
      # XXX this must be removed one day
      # This means we have the previous zsql method
      # and we must call the method for every path
      for uid in uid_list:
        search_result = method(uid = uid)
        if len(search_result) > 0:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1557
          uid_path_dict[uid] = search_result[0].path
1558 1559
    return uid_path_dict

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1560 1561 1562 1563 1564 1565 1566 1567 1568
  def hasPath(self, path):
    """ Checks if path is catalogued """
    return self.getUidForPath(path) is not None

  def getPathForUid(self, uid):
    """ Looks up into catalog table to convert uid into path """
    try:
      if uid is None:
        return None
1569 1570 1571 1572
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1573 1574 1575 1576 1577 1578 1579 1580
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_uid)
      search_result = method(uid = uid)
      # If not empty return first record
      if len(search_result) > 0:
        return search_result[0].path
      else:
        return None
1581 1582
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1583 1584 1585
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1586
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
      return None

  def getMetadataForUid(self, uid):
    """ Accesses a single record for a given uid """
    if uid is None:
      return None
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_uid)
    brain = method(uid = uid)[0]
    result = {}
    for k in brain.__record_schema__.keys():
      result[k] = getattr(brain,k)
    return result

  def getIndexDataForUid(self, uid):
    """ Accesses a single record for a given uid """
    return self.getMetadataForUid(uid)

  def getMetadataForPath(self, path):
    """ Accesses a single record for a given path """
    try:
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_path)
      brain = method(path = path)[0]
      result = {}
      for k in brain.__record_schema__.keys():
        result[k] = getattr(brain,k)
      return result
1615 1616
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1617 1618 1619
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1620 1621
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1622 1623 1624 1625 1626 1627
      return None

  def getIndexDataForPath(self, path):
    """ Accesses a single record for a given path """
    return self.getMetadataForPath(path)

1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
  def getCatalogMethodIds(self):
    """Find Z SQL methods in the current folder and above
    This function return a list of ids.
    """
    ids={}
    have_id=ids.has_key

    while self is not None:
      if hasattr(self, 'objectValues'):
        for o in self.objectValues(valid_method_meta_type_list):
          if hasattr(o,'id'):
            id=o.id
1640 1641
            if not isinstance(id, str):
              id=id()
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
            if not have_id(id):
              if hasattr(o,'title_and_id'): o=o.title_and_id()
              else: o=id
              ids[id]=id
      if hasattr(self, 'aq_parent'): self=self.aq_parent
      else: self=None

    ids=map(lambda item: (item[1], item[0]), ids.items())
    ids.sort()
    return ids

1653
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1654 1655
    """
    Return the list of related keys.
1656
    This method can be overidden in order to implement
1657 1658
    dynamic generation of some related keys.
    """
1659 1660
    if key_list is None:
      key_list = []
1661
    # Do not generate dynamic related key for acceptable_keys
1662
    dynamic_key_list = [k for k in key_list \
1663 1664
        if k not in self.getColumnMap().keys()]

1665
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1666 1667 1668
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1669 1670 1671
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1672 1673 1674 1675 1676
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1677

1678 1679
  def getTableIndex(self, table):
    """
1680
    Return a map between index and column for a given table
1681 1682 1683 1684 1685 1686 1687 1688
    """
    def _getTableIndex(table):
      table_index = {}
      method = getattr(self, self.sql_catalog_index, '')
      if method in ('', None):
        return {}
      index = list(method(table=table))
      for line in index:
1689 1690
        if table_index.has_key(line.KEY_NAME):
          table_index[line.KEY_NAME].append(line.COLUMN_NAME)
1691
        else:
1692 1693
          table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
      LOG("SQLCatalog.getTableIndex", INFO, "index = %s for table = %s" \
1694 1695 1696
          %(table_index, table))
      return table_index
    return CachingMethod(_getTableIndex, id='SQLCatalog.getTableIndex', \
Aurel's avatar
Aurel committed
1697
                         cache_factory='erp5_content_long')(table=table)
1698 1699


1700
  def getIndex(self, table, column_list, all_column_list):
1701 1702 1703
    """
    Return possible index for a column list in a given table
    """
1704
    def _getIndex(table, column_list, all_column_list):
1705 1706 1707
      index_dict = self.getTableIndex(table)
      if isinstance(column_list, str):
        column_list = [column_list,]
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
      # Get possible that can be used
      possible_index = []
      for index in index_dict.keys():
        index_columns = index_dict[index]
        for column in index_columns:
          if column in column_list:
            if index not in possible_index:
              possible_index.append(index)
      if len(possible_index) == 0:
        return []
      # Get the most suitable index
      for index in possible_index:
        # Make sure all column in index are used by the query
        index_column = index_dict[index]
        for column in index_column:
          if column in column_list or column in all_column_list:
            continue
          else:
            possible_index.remove(index)
      LOG("SQLCatalog.getIndex", INFO, "index = %s for table %s and columns %s" \
          %(possible_index, table, column_list))
      return possible_index
Aurel's avatar
Aurel committed
1730
    return CachingMethod(_getIndex, id='SQLCatalog.getIndex', cache_factory='erp5_content_long')\
1731 1732
          (table=table, column_list=column_list, all_column_list=all_column_list)

1733

1734
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
1735
                          ignore_empty_string=1, query=None, stat__=0, **kw):
1736
    """ Builds a complex SQL query to simulate ZCatalog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1737 1738 1739 1740 1741 1742 1743
    # Get search arguments:
    if REQUEST is None and (kw is None or kw == {}):
      # We try to get the REQUEST parameter
      # since we have nothing handy
      try: REQUEST=self.REQUEST
      except AttributeError: pass

1744
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
1745 1746
    # If kw and query are not set, then use REQUEST instead
    if query is None and (kw is None or kw == {}):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1747 1748
      kw = REQUEST

1749
    acceptable_key_map = self.getColumnMap()
1750 1751
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1752
    datetime_search_keys = list(self.sql_catalog_datetime_search_keys)
1753
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1754
    multivalue_keys = self.sql_catalog_multivalue_keys
Aurel's avatar
Aurel committed
1755 1756


1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
    # Compute "sort_index", which is a sort index, or none:
    if kw.has_key('sort-on'):
      sort_index=kw['sort-on']
    elif hasattr(self, 'sort-on'):
      sort_index=getattr(self, 'sort-on')
    elif kw.has_key('sort_on'):
      sort_index=kw['sort_on']
    else: sort_index=None

    # Compute the sort order
    if kw.has_key('sort-order'):
      so=kw['sort-order']
    elif hasattr(self, 'sort-order'):
      so=getattr(self, 'sort-order')
    elif kw.has_key('sort_order'):
      so=kw['sort_order']
    else: so=None

    # We must now turn sort_index into
    # a dict with keys as sort keys and values as sort order
    if isinstance(sort_index, basestring):
      sort_index = [(sort_index, so)]
    elif not isinstance(sort_index, (list, tuple)):
      sort_index = None
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800

    # Rebuild keywords to behave as new style query (_usage='toto:titi' becomes {'toto':'titi'})
    new_kw = {}
    usage_len = len('_usage')
    for k, v in kw.items():
      if k.endswith('_usage'):
        new_k = k[0:-usage_len]
        if not new_kw.has_key(new_k):
          new_kw[new_k] = {}
        if not isinstance(new_kw[new_k], dict):
          new_kw[new_k] = {'query': new_kw[new_k]}
        split_v = v.split(':')
        new_kw[new_k] = {split_v[0]: split_v[1]}
      else:
        if not new_kw.has_key(k):
          new_kw[k] = v
        else:
          new_kw[k]['query'] = v
    kw = new_kw

1801 1802 1803 1804 1805
    # Initialise Scriptable Dict
    scriptable_key_dict = {}
    for t in self.sql_catalog_scriptable_keys:
      t = t.split('|')
      key = t[0].strip()
Ivan Tyagov's avatar
Ivan Tyagov committed
1806 1807 1808 1809 1810 1811
      if len(t)>1:
        # method defined that will generate a ComplexQuery
        method_id = t[1].strip()
      else:
        # no method define, let ScriptableKey generate a ComplexQuery
        method_id = None
1812 1813
      scriptable_key_dict[key] = method_id

1814 1815 1816 1817
    # Build the list of Queries and ComplexQueries
    query_dict = {}
    key_list = [] # the list of column keys
    key_alias_dict = {}
1818
    query_group_by_list = None # Useful to keep a default group_by passed by scriptable keys
1819 1820 1821
    query_related_table_map_dict = {}
    if query is not None:
      kw ['query'] = query
1822
    for key in kw.keys():
1823
      if key not in RESERVED_KEY_LIST:
1824 1825 1826
        value = kw[key]
        current_query = None
        new_query_dict = {}
1827 1828 1829
        if isinstance(value, (Query, ComplexQuery)):
          current_query = value
        elif scriptable_key_dict.has_key(key):
Ivan Tyagov's avatar
Ivan Tyagov committed
1830 1831 1832 1833 1834 1835 1836 1837
          if scriptable_key_dict[key] is not None:
            # Turn this key into a query by invoking a script          
            method = getattr(self, scriptable_key_dict[key])
            current_query = method(value) # May return None            
          else:
            # let default implementation of ScriptableKey generate ComplexQuery
            search_key_instance = getSearchKeyInstance(ScriptableKey)
            current_query = search_key_instance.buildQuery('', value)
1838
          if hasattr(current_query, 'order_by'): query_group_by_list = current_query.order_by
1839
        else:
1840
          if isinstance(value, dict):
1841
            for value_key in value.keys():
1842 1843
              if value_key == 'query':
                new_query_dict[key] = value['query']
1844
              else:
1845
                new_query_dict[value_key] = value[value_key]
1846
          else:
1847
            new_query_dict[key] = value
1848
          current_query = Query(**new_query_dict)
1849 1850 1851
        if current_query is not None:
          query_dict[key] = current_query
          key_list.extend(current_query.getSQLKeyList())
1852
          query_related_table_map_dict.update(current_query.getRelatedTableMapDict())
1853

1854 1855
    # if we have a sort index, we must take it into account to get related
    # keys.
1856
    sort_key_dict = dict()
1857 1858
    if sort_index:
      for sort_info in sort_index:
1859 1860 1861
        sort_key = sort_info[0]
        if sort_key not in key_list:
          key_list.append(sort_key)
1862
        sort_key_dict[sort_key] = 1
1863

1864
    related_tuples = self.getSQLCatalogRelatedKeyList(key_list=key_list)
Ivan Tyagov's avatar
Ivan Tyagov committed
1865
    
1866
    # Define related maps
1867 1868
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
1869
    related_keys = {}
1870 1871 1872
    related_method = {}
    related_table_map = {}
    related_column = {}
1873
    related_table_list = {}
1874
    table_rename_index = 0
1875
    related_methods = {} # related methods which need to be used
1876 1877 1878
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
1879
      if key in key_list:
1880
        if ignore_empty_string \
1881 1882 1883 1884
            and kw.get(key, None) in ('', [], ())\
            and key not in sort_key_dict:
              # We don't ignore 0 and None, but if the key is used for sorting,
              # we should not discard this key
1885
          continue
1886
        join_tuple = t_tuple[1].strip().split('/')
1887
        related_keys[key] = None
1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
        method_id = join_tuple[2]
        table_list = tuple(join_tuple[0].split(','))
        related_method[key] = method_id
        related_table_list[key] = table_list
        related_column[key] = join_tuple[1]
        # Check if some aliases where specified in queries
        map_list = query_related_table_map_dict.get(key,None)
        # Rename tables to prevent conflicts
        if not related_table_map.has_key((table_list,method_id)):
          if map_list is None:
            map_list = []
            for table_id in table_list:
              map_list.append((table_id,
                 "related_%s_%s" % (table_id, table_rename_index))) # We add an index in order to alias tables in the join
              table_rename_index += 1 # and prevent name conflicts
          related_table_map[(table_list,method_id)] = map_list
1904

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1905 1906
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1907
    if REQUEST is not None:
1908
      for key in acceptable_key_map.iterkeys():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1909 1910
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1911
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1912
            kw[key] = REQUEST[key]
1913 1914

    def getNewKeyAndUpdateVariables(key):
1915
      key_is_acceptable = key in acceptable_key_map # Only calculate once
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
      key_is_related = key in related_keys
      new_key = None
      if key_is_acceptable or key_is_related:
        if key_is_related: # relation system has priority (ex. security_uid)
          # We must rename the key
          method_id = related_method[key]
          table_list = related_table_list[key]
          if not related_methods.has_key((table_list,method_id)):
            related_methods[(table_list,method_id)] = 1
          # Prepend renamed table name
Aurel's avatar
Aurel committed
1926
          new_key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1],
1927 1928 1929 1930 1931 1932 1933 1934
                               related_column[key])
        elif key_is_acceptable:
          if key.find('.') < 0:
            # if the key is only used by one table, just append its name
            if len(acceptable_key_map[key]) == 1 :
              new_key = '%s.%s' % (acceptable_key_map[key][0], key)
            # query_table specifies what table name should be used by default
            elif query_table and \
1935
                '%s.%s' % (query_table, key) in acceptable_key_map:
1936 1937 1938
              new_key = '%s.%s' % (query_table, key)
            elif key == 'uid':
              # uid is always ambiguous so we can only change it here
1939
              new_key = 'catalog.uid'
1940 1941 1942 1943
          else:
            new_key = key
          if new_key is not None:
            # Add table to table dict, we use catalog by default
Aurel's avatar
Aurel committed
1944
            from_table_dict[acceptable_key_map[new_key][0]] = acceptable_key_map[new_key][0]
1945 1946 1947 1948 1949 1950 1951 1952 1953
      key_alias_dict[key] = new_key
      return new_key

    where_expression_list = []
    select_expression_list = []
    group_by_expression_list = []
    where_expression = ''
    select_expression = ''
    group_by_expression = ''
Aurel's avatar
Aurel committed
1954 1955
    select_expression_key = ''
    
1956
    from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1957
    if len(kw):
1958 1959 1960 1961
      if kw.has_key('select_expression_key'):
        select_expression_key = kw['select_expression_key']
        if type(select_expression_key) is type('a'):
          select_expression_key = [select_expression_key]
1962
      if kw.has_key('select_expression'):
Jérome Perrin's avatar
Jérome Perrin committed
1963
        select_expression_list.append(kw['select_expression'])
1964
      if kw.has_key('group_by_expression'):
1965
        group_by_expression_list.append(kw['group_by_expression'])
1966
      # Grouping
1967
      group_by_list = kw.get('group_by', query_group_by_list)
1968 1969 1970 1971
      if type(group_by_list) is type('a'): group_by_list = [group_by_list]
      if group_by_list is not None:
        try:
          for key in group_by_list:
1972 1973
            new_key = getNewKeyAndUpdateVariables(key)
            group_by_expression_list.append(new_key)
1974 1975 1976 1977
        except ConflictError:
          raise
        except:
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new group by expression', error=sys.exc_info())
1978 1979 1980 1981
          group_by_expression = ''
      if len(group_by_expression_list)>0:
        group_by_expression = ','.join(group_by_expression_list)
        group_by_expression = str(group_by_expression)
1982

1983
    sort_on = None
1984
    sort_key_list = []
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
    if sort_index is not None:
      new_sort_index = []
      for sort in sort_index:
        if len(sort) == 2:
          # Try to analyse expressions of the form "title AS unsigned"
          sort_key_list = sort[0].split()
          if len(sort_key_list) == 3:
            sort_key = sort_key_list[0]
            sort_type = sort_key_list[2]
          elif len(sort_key_list):
            sort_key = sort_key_list[0]
            sort_type = None
1997
          else:
1998 1999 2000 2001 2002 2003 2004 2005
            sort_key = sort[0]
            sort_type = None
          new_sort_index.append((sort_key, sort[1], sort_type))
        elif len(sort) == 3:
          new_sort_index.append(sort)
      sort_index = new_sort_index
      try:
        new_sort_index = []
Jérome Perrin's avatar
Jérome Perrin committed
2006
        for (original_key, so, as_type) in sort_index:
2007
          key = getNewKeyAndUpdateVariables(original_key)
2008 2009 2010
          if key is None:
            if original_key in select_expression_key:
              key = original_key
2011
          if key is not None:
2012
            sort_key_list.append(key)
2013 2014 2015 2016 2017 2018
            if as_type == 'int':
              key = 'CAST(%s AS SIGNED)' % key
            elif as_type:
              key = 'CAST(%s AS %s)' % (key, as_type) # Different casts are possible
            if so in ('descending', 'reverse', 'DESC'):
              new_sort_index.append('%s DESC' % key)
2019
            else:
2020 2021
              new_sort_index.append('%s' % key)
          else:
2022 2023
            LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build sort '
                'index (%s -> %s)' % (original_key, key))
2024 2025 2026 2027 2028 2029 2030
        sort_index = join(new_sort_index,',')
        sort_on = str(sort_index)
      except ConflictError:
        raise
      except:
        LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new sort index', error=sys.exc_info())
        sort_on = ''
2031
        sort_key_list = []
2032 2033 2034 2035 2036

    for key in key_list:
      if not key_alias_dict.has_key(key):
        getNewKeyAndUpdateVariables(key)
    if len(query_dict):
2037
      for key, query in query_dict.items():
2038 2039 2040
        query_result = query.asSQLExpression(key_alias_dict=key_alias_dict,
                                    full_text_search_keys=full_text_search_keys,
                                    keyword_search_keys=keyword_search_keys,
2041
                                    datetime_search_keys=datetime_search_keys,
2042 2043 2044 2045 2046
                                    ignore_empty_string=ignore_empty_string,
                                    stat__=stat__)
        if query_result['where_expression'] not in ('',None):
          where_expression_list.append(query_result['where_expression'])
        select_expression_list.extend(query_result['select_expression_list'])
Aurel's avatar
Aurel committed
2047

2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
    # Calculate extra where_expression based on required joins
    for k, tid in from_table_dict.items():
      if k != query_table:
        where_expression_list.append('%s.uid = %s.uid' % (query_table, tid))
    # Calculate extra where_expressions based on related definition
    for (table_list, method_id) in related_methods.keys():
      related_method = getattr(self, method_id, None)
      if related_method is not None:
        table_id = {'src__' : 1} # Return query source, do not evaluate
        table_id['query_table'] = query_table
        table_index = 0
        for t_tuple in related_table_map[(table_list,method_id)]:
          table_id['table_%s' % table_index] = t_tuple[1] # table_X is set to mapped id
          from_table_dict[t_tuple[1]] = t_tuple[0]
          table_index += 1
        where_expression_list.append(related_method(**table_id))
    # Concatenate expressions
2065 2066
    if kw.get('where_expression',None) not in (None,''):
      where_expression_list.append(kw['where_expression'])
2067 2068
    if len(where_expression_list)>1:
      where_expression_list = ['(%s)' % x for x in where_expression_list]
2069 2070 2071 2072 2073 2074 2075 2076
    where_expression = join(where_expression_list, ' AND ')
    select_expression= join(select_expression_list,',')

    limit_expression = kw.get('limit', None)
    if isinstance(limit_expression, (list, tuple)):
      limit_expression = '%s,%s' % (limit_expression[0], limit_expression[1])
    elif limit_expression is not None:
      limit_expression = str(limit_expression)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2077

2078
    # force index if exists when doing sort as mysql doesn't manage them efficiently
2079
    if len(sort_key_list) > 0:
2080 2081
      index_from_table = {}
      # first group columns from a same table
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
      for key in sort_key_list:
        try:
          related_table, column = key.split('.')
        except ValueError:
          # key is not of the form table.column
          # so get table from dict
          if len(from_table_dict) != 1:
            continue
          column = key
          related_table = from_table_dict.keys()[0]

2093
        table = from_table_dict[related_table]
2094 2095 2096 2097 2098 2099
        # Check if it's a column for which we want to specify index
        index_columns = getattr(self, 'sql_catalog_index_on_order_keys', [])
        sort_column = '%s.%s' %(table, column)
        if not sort_column in index_columns:
          continue
        # Group columns
2100 2101 2102 2103 2104 2105
        if not index_from_table.has_key(table):
          index_from_table[table] = [column,]
        else:
          index_from_table[table].append(column)
      # second ask index
      for table in index_from_table.keys():
2106
        available_index_list = self.getIndex(table, index_from_table[table], key_list)
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118
        if len(available_index_list) > 0:
          # tell mysql to use these index
          table = from_table_dict.pop(related_table)
          index_list_string = ""
          for index in available_index_list:
            if len(index_list_string) == 0:
              index_list_string += "%s" %index
            else:
              index_list_string += ", %s" %index
          table_with_index =  "%s use index(%s)"  %(related_table, index_list_string)
          from_table_dict[table_with_index] = table

2119
    # Use a dictionary at the moment.
2120
    return { 'from_table_list' : from_table_dict.items(),
2121
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2122
             'where_expression' : where_expression,
2123
             'limit_expression' : limit_expression,
2124 2125
             'select_expression': select_expression,
             'group_by_expression' : group_by_expression}
2126

2127 2128 2129
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2130
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, build_sql_query_method=None, **kw):
2131
    """ Returns a list of brains from a set of constraints on variables """
2132 2133 2134
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2135 2136 2137
    kw['where_expression'] = query['where_expression']
    kw['sort_on'] = query['order_by_expression']
    kw['from_table_list'] = query['from_table_list']
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2138
    kw['limit_expression'] = query['limit_expression']
2139
    kw['select_expression'] = query['select_expression']
2140
    kw['group_by_expression'] = query['group_by_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2141
    # Return the result
2142

2143 2144 2145
    #LOG('acceptable_keys',0,'acceptable_keys: %s' % str(acceptable_keys))
    #LOG('acceptable_key_map',0,'acceptable_key_map: %s' % str(acceptable_key_map))
    #LOG('queryResults',0,'kw: %s' % str(kw))
2146
    #LOG('queryResults',0,'from_table_list: %s' % str(query['from_table_list']))
2147
    return sql_method(src__=src__, **kw)
Ivan Tyagov's avatar
Ivan Tyagov committed
2148
      
2149
  def searchResults(self, REQUEST=None, used=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2150
    """ Returns a list of brains from a set of constraints on variables """
2151
    # The used argument is deprecated and is ignored
2152
    method = getattr(self, self.sql_search_results)
2153
    return self.queryResults(method, REQUEST=REQUEST, used=used, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2154 2155 2156

  __call__ = searchResults

2157
  def countResults(self, REQUEST=None, used=None, stat__=1, **kw):
2158
    """ Returns the number of items which satisfy the where_expression """
2159 2160
    # Get the search method
    method = getattr(self, self.sql_count_results)
2161
    return self.queryResults(method, REQUEST=REQUEST, used=used, stat__=stat__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2162

2163
  def recordObjectList(self, path_list, catalog=1):
2164
    """
2165
      Record the path of an object being catalogged or uncatalogged.
2166
    """
2167 2168
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2169

2170
  def deleteRecordedObjectList(self, uid_list=()):
2171 2172 2173 2174
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2175
    method(uid_list=uid_list)
2176

2177
  def readRecordedObjectList(self, catalog=1):
2178 2179 2180 2181
    """
      Read objects. Note that this might not return all objects since ZMySQLDA limits the max rows.
    """
    method = getattr(self, self.sql_read_recorded_object_list)
2182
    return method(catalog=catalog)
Ivan Tyagov's avatar
Ivan Tyagov committed
2183
   
2184 2185 2186 2187 2188 2189 2190 2191
  # Filtering
  def manage_editFilter(self, REQUEST=None, RESPONSE=None, URL1=None):
    """
    This methods allows to set a filter on each zsql method called,
    so we can test if we should or not call a zsql method, so we can
    increase a lot the speed.
    """
    if withCMF:
2192
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2193

2194 2195 2196 2197
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2198

2199
      for id in method_id_list:
2200 2201 2202
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2203 2204 2205 2206 2207
          self.filter_dict[id]['filtered'] = 0
          self.filter_dict[id]['type'] = []
          self.filter_dict[id]['expression'] = ""
          self.filter_dict[id]['expression_cache_key'] = "portal_type"

2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227
        if REQUEST.has_key('%s_box' % id):
          self.filter_dict[id]['filtered'] = 1
        else:
          self.filter_dict[id]['filtered'] = 0

        if REQUEST.has_key('%s_expression' % id):
          expression = REQUEST['%s_expression' % id]
          if expression == "":
            self.filter_dict[id]['expression'] = ""
            self.filter_dict[id]['expression_instance'] = None
          else:
            expr_instance = Expression(expression)
            self.filter_dict[id]['expression'] = expression
            self.filter_dict[id]['expression_instance'] = expr_instance
        else:
          self.filter_dict[id]['expression'] = ""
          self.filter_dict[id]['expression_instance'] = None

        if REQUEST.has_key('%s_type' % id):
          list_type = REQUEST['%s_type' % id]
2228
          if isinstance(list_type, str):
2229 2230 2231 2232 2233
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2234 2235 2236 2237 2238 2239 2240 2241 2242
        if REQUEST.has_key('%s_expression_cache_key' % id):
          expression_cache_key = REQUEST['%s_expression_cache_key' % id]
          if expression_cache_key == "":
            self.filter_dict[id]['expression_cache_key'] = expression_cache_key
          else:
            self.filter_dict[id]['expression_cache_key'] = ""
        else:
          self.filter_dict[id]['expression_cache_key'] = ""

2243 2244 2245 2246 2247 2248 2249 2250 2251 2252
    if RESPONSE and URL1:
      RESPONSE.redirect(URL1 + '/manage_catalogFilter?manage_tabs_message=Filter%20Changed')

  def isMethodFiltered(self, method_name):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      # Reset Filtet dict
2253
      if getattr(aq_base(self), 'filter_dict', None) is None:
2254 2255
        self.filter_dict = PersistentMapping()
        return 0
2256
      try:
2257
        return self.filter_dict[method_name]['filtered']
2258 2259
      except KeyError:
        return 0
2260 2261 2262
    return 0

  def getExpression(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2263
    """ Get the filter expression text for this method.
2264 2265
    """
    if withCMF:
2266
      if getattr(aq_base(self), 'filter_dict', None) is None:
2267 2268
        self.filter_dict = PersistentMapping()
        return ""
2269
      try:
2270
        return self.filter_dict[method_name]['expression']
2271 2272
      except KeyError:
        return ""
2273 2274
    return ""

2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
  def getExpressionCacheKey(self, method_name):
    """ Get the key string which is used to cache results
        for the given expression.
    """
    if withCMF:
      if getattr(aq_base(self), 'filter_dict', None) is None:
        self.filter_dict = PersistentMapping()
        return ""
      try:
        return self.filter_dict[method_name]['expression_cache_key']
      except KeyError:
        return ""
    return ""

2289
  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2290
    """ Get the filter expression instance for this method.
2291 2292
    """
    if withCMF:
2293
      if getattr(aq_base(self), 'filter_dict', None) is None:
2294 2295
        self.filter_dict = PersistentMapping()
        return None
2296
      try:
2297
        return self.filter_dict[method_name]['expression_instance']
2298 2299
      except KeyError:
        return None
2300 2301
    return None

Jérome Perrin's avatar
Jérome Perrin committed
2302 2303
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2304 2305
    """
    if withCMF:
2306
      if getattr(aq_base(self), 'filter_dict', None) is None:
2307 2308
        self.filter_dict = PersistentMapping()
        return 0
2309 2310 2311 2312
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2313 2314
    return 0

2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
  def getFilteredPortalTypeList(self, method_name):
    """ Returns the list of portal types which define
        the filter.
    """
    if withCMF:
      if getattr(aq_base(self), 'filter_dict', None) is None:
        self.filter_dict = PersistentMapping()
        return []
      try:
        return self.filter_dict[method_name]['type']
      except KeyError:
        return []
    return []
2328 2329 2330 2331 2332 2333 2334

  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2335 2336 2337 2338
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
      for method_id in methods:
        method_dict[method_id] = 1
    method_list = map(lambda method_id: getattr(self, method_id, None), method_dict.keys())
    return filter(lambda method: method is not None, method_list)

  def getExpressionContext(self, ob):
      '''
      An expression context provides names for TALES expressions.
      '''
      if withCMF:
        data = {
            'here':         ob,
            'container':    aq_parent(aq_inner(ob)),
            'nothing':      None,
2353 2354 2355 2356 2357 2358 2359
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
            'isDelivery':   ob.isDelivery, # XXX
            'isMovement':   ob.isMovement, # XXX
            'isPredicate':  ob.isPredicate, # XXX
2360
            'isDocument':   ob.isDocument, # XXX
2361
            'isInventory':  ob.isInventory, # XXX
2362
            'portal_type':  ob.portal_type, # XXX
2363
            'isInventoryMovement': ob.isInventoryMovement, # XXX
2364 2365 2366 2367 2368 2369
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2370
class CatalogError(Exception): pass
Ivan Tyagov's avatar
Ivan Tyagov committed
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404

# hook search keys and Query implementation 
def getSearchKeyInstance(search_key_class):
  """ Return instance of respective search_key class.
      We should have them initialized only once."""
  global SEARCH_KEY_INSTANCE_POOL
  lexer = SEARCH_KEY_INSTANCE_POOL[search_key_class]
  return lexer 
  
from Query.Query import QueryMixin
from Query.SimpleQuery import NegatedQuery, SimpleQuery
from Query.ComplexQuery import ComplexQuery

# for of backwards compatability  
QueryMixin = QueryMixin
Query = SimpleQuery
NegatedQuery = NegatedQuery 
ComplexQuery = ComplexQuery
 
from Products.ZSQLCatalog.SearchKey.DefaultKey import DefaultKey
from Products.ZSQLCatalog.SearchKey.RawKey import RawKey
from Products.ZSQLCatalog.SearchKey.KeyWordKey import KeyWordKey
from Products.ZSQLCatalog.SearchKey.DateTimeKey import DateTimeKey
from Products.ZSQLCatalog.SearchKey.FullTextKey import FullTextKey
from Products.ZSQLCatalog.SearchKey.FloatKey import FloatKey
from Products.ZSQLCatalog.SearchKey.ScriptableKey import ScriptableKey, KeyMappingKey

# pool of global preinitialized search keys instances
SEARCH_KEY_INSTANCE_POOL = {}
for search_key_class in (DefaultKey, RawKey, KeyWordKey, DateTimeKey, 
                         FullTextKey, FloatKey, ScriptableKey, KeyMappingKey):
  search_key_instance = search_key_class()
  search_key_instance.build()
  SEARCH_KEY_INSTANCE_POOL[search_key_class] = search_key_instance