SQLCatalog.py 88.4 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
import threading
43
from cStringIO import StringIO
44
from xml.dom.minidom import parse
45
from xml.sax.saxutils import escape, quoteattr
46 47
import os
import md5
48
from sets import ImmutableSet
49 50 51 52 53 54 55 56 57

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

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

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

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

89
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
90

91 92 93 94 95
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

96
def manage_addSQLCatalog(self, id, title,
97
             vocab_id='create_default_catalog_', # vocab_id is a strange name - not abbreviation
98 99 100
             REQUEST=None):
  """Add a Catalog object
  """
101 102 103
  id = str(id)
  title = str(title)
  vocab_id = str(vocab_id)
104 105 106
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

107
  c = Catalog(id, title, self)
108 109 110 111
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

112 113
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
114

Yoshinori Okuji's avatar
Yoshinori Okuji committed
115
  def __init__(self):
116
    """Initialize some variables.
117

118
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
119

120
      finished_buffer is used to hold reserved uids created by committed-transactions.
121

122
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
123
      invalid afterwards, so they may not be used by other transactions."""
124 125
    self.temporary_buffer = {}
    self.finished_buffer = []
126

127 128 129 130 131 132 133 134
  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
135

136 137 138 139 140 141 142
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
143

144 145 146 147 148 149 150 151
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
152

153 154 155 156 157 158 159 160 161 162 163
  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
164

165 166 167 168
  def pop(self):
    self._register()
    tid = get_ident()
    try:
169
      uid = self.temporary_buffer[tid].pop()
170
    except (KeyError, IndexError):
171 172
      uid = self.finished_buffer.pop()
    return uid
173

174 175 176
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
177
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
178

179 180 181 182 183
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
              ExtensionClass.Base,
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184 185 186 187
  """ An Object Catalog

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

  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

197 198
  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.
199 200 201
  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).
202 203 204
  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
205

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

207
  brain defined in methods...
Jean-Paul Smets's avatar
Jean-Paul Smets committed
208 209 210 211 212 213

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
214
  meta_type = "SQLCatalog"
215
  icon = 'misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  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'),}
245
    ) + OFS.History.Historical.manage_options
246

247
  __ac_permissions__= (
248 249 250 251 252

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

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
253 254
      'manage_catalogFilter',
      'manage_catalogAdvanced',
255 256

      'manage_catalogReindex', 'manage_catalogFoundItems',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
257 258
      'manage_catalogClear',
      'manage_main',
259 260 261 262 263 264
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
265 266
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
267
      'getFilterableMethodList',],
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
     ['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' },
293 294 295 296 297
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
298 299 300 301 302
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
303 304
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
305 306 307 308 309 310 311 312
      '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' },
313 314 315
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
316 317
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
318 319 320
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
321 322
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
323 324
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
325 326 327
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
328
    { 'id'      : 'sql_record_object_list',
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
      '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
348 349 350 351 352
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
    { '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' },
388 389 390 391 392
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
    { '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' },
408 409 410 411 412
    { 'id'      : 'sql_catalog_datetime_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 418 419 420 421 422 423 424 425 426 427
    { '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' },
428 429 430 431 432
    { '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' },
433 434 435 436 437 438 439 440 441
    { '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' },
442 443 444 445 446
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
447 448 449 450 451 452 453 454 455 456 457
    { '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' },
458 459
  )

460
  sql_catalog_produce_reserved = ''
461
  sql_catalog_delete_uid = ''
462 463 464 465 466 467 468 469 470 471 472
  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
473
  sql_search_security = ''
474 475 476 477 478 479
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
480
  sql_catalog_index = ''
481 482 483
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
484
  sql_catalog_datetime_search_keys = ()
485 486 487 488 489
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
490
  sql_catalog_index_on_order_keys = ()
491
  sql_catalog_related_keys = ()
492
  sql_catalog_scriptable_keys = ()
493 494
  sql_catalog_role_keys = ()
  sql_catalog_local_role_keys = ()
495

496 497 498 499 500 501
  # 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
502

503 504 505 506 507 508 509
  # 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
510

511 512 513 514 515 516 517 518 519 520
  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
521 522 523
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
524
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
525

526 527 528 529 530 531 532 533 534 535 536 537 538 539
  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]

540 541 542 543 544 545
  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')
546 547 548 549 550 551 552 553 554 555 556 557
    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]
558
      if isinstance(value, basestring):
559
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
560
      elif isinstance(value, (tuple, list)):
561 562 563
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
564
        for item in value:
565
          if isinstance(item, basestring):
566 567 568 569
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
570
        f.write('  </property>\n')
571 572 573
    # 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'):
574 575
      filter_list = []
      for filter_id in self.filter_dict.keys():
576
        filter_definition = self.filter_dict[filter_id]
577 578 579 580 581 582 583
        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']:
584 585
          # If a filter is not activated, no need to output it.
          continue
586
        if not filter_def['expression']:
587 588
          # If the expression is not specified, meaningless to specify it.
          continue
589
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
590
        # For now, portal types are not exported, because portal types are too specific to each site.
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
    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):
612
            raise CatalogError, 'unknown property id %r' % (id,)
613
          if type not in ('str', 'tuple'):
614
            raise CatalogError, 'unknown property type %r' % (type,)
615 616 617 618
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
619
                value = str(text.data)
620 621 622 623 624 625
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
626
                raise CatalogError, 'unknown item type %r' % (item_type,)
627 628
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
629
                  value.append(str(text.data))
630 631 632 633
                  break
            value = tuple(value)

          setattr(self, id, value)
634

635 636 637
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
638
          id = str(filt.getAttribute("id"))
639 640 641 642 643 644 645 646 647 648 649 650
          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
651 652 653 654
      finally:
        doc.unlink()
    finally:
      f.close()
Aurel's avatar
Aurel committed
655

656 657 658 659 660 661 662
  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__)))
663 664 665

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
666
    self.security_uid_index = None
667 668

  security.declarePrivate('getSecurityUid')
669
  def getSecurityUid(self, wrapped_object):
670 671 672 673 674 675 676
    """
      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
677
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
678 679 680 681
    # 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)
682 683
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
684 685 686
      self._clearSecurityCache()
    if self.security_uid_dict.has_key(allowed_roles_and_users):
      return (self.security_uid_dict[allowed_roles_and_users], None)
687 688 689 690 691 692 693 694
    # 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
695 696
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
697 698 699 700
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
701
          default = previous_security_uid
702 703 704 705 706 707 708 709 710 711 712
      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
713 714
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
715

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

731
    # Reserved uids have been removed.
732
    self.clearReserved()
733

734
    # Add a dummy item so that SQLCatalog will not use existing uids again.
735
    self.insertMaxUid()
736

737
    # Remove the cache of catalog schema.
738 739
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
740

741
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
742

743 744 745 746 747 748 749 750 751 752
  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()])

753 754 755 756 757 758
  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
759 760 761 762 763
    try:
      method()
    except ConflictError:
      raise
    except:
764
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
765 766 767
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
768
    self._last_clear_reserved_time += 1
769

Jean-Paul Smets's avatar
Jean-Paul Smets committed
770 771 772 773 774 775 776 777 778
  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]
779
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799

  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

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
  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

817
  security.declarePublic('getCatalogSearchResultKeys')
818 819 820 821
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
822

823
  def _getCatalogSchema(self, table=None):
824 825 826
    # 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.
827
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
828

829 830 831 832 833 834 835 836 837
    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)
838 839
      except ConflictError:
        raise
840
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
841
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
842 843 844
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
845

846
    return catalog_schema_dict[table]
847

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

873 874 875 876 877
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
878
    def _getColumnMap():
879 880 881 882 883 884 885 886 887 888 889
      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
890
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_factory='erp5_content_long')()
891

Jean-Paul Smets's avatar
Jean-Paul Smets committed
892 893 894 895 896 897 898
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
899 900 901
      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
902 903 904 905
    keys = keys.keys()
    keys.sort()
    return keys

906 907 908 909 910 911 912 913 914 915 916 917 918 919
  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
920 921 922
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
923 924 925
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
926 927
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
928 929 930
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
931
        keys.append(c[0])
932 933
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
934 935
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
936 937
    return keys

938 939 940 941 942 943 944 945 946 947 948 949 950 951
  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
952
  # the cataloging API
953 954 955
  def produceUid(self):
    """
      Produces reserved uids in advance
956
    """
957 958 959 960
    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.
961 962 963 964
    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:
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
      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]
987
      uid_buffer.extend(uid_list)
988

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

    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
1002

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
  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

1023 1024 1025
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1026 1027
      with multiple ZEO clients on a single ZEO server.

1028
      The main risk is the following:
1029

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

1032
      - one reindexing node N1 starts reindexing f
1033

1034
      - another reindexing node N2 starts reindexing e
1035

1036 1037 1038
      - 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

1039
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1040
      with the risk of graph loops
1041
    """
1042
    if not self.isIndexable():
1043 1044
      return None

1045 1046 1047 1048
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1049 1050 1051
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1052 1053 1054 1055 1056 1057
        # 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
1058 1059 1060 1061
        if self._max_uid is None:
          self._max_uid = Length()
        if uid > self._max_uid():
          self._max_uid.set(uid)
1062
        return long(uid)
1063 1064 1065 1066
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1067

1068 1069 1070
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1071
      if isinstance(urls, str):
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
        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:
1087
      if isinstance(urls, str):
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
        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`)))

1111
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1112
                          URL1=None, sql_catalog_id=None):
1113
    """ clears the whole enchilada """
1114 1115
    self.beforeCatalogClear()

1116 1117 1118
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1119
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1120
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1121 1122

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1123
    """ clears reserved uids """
1124 1125 1126
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1127
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1128
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1129 1130 1131 1132 1133 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

  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
1166
  def catalogObject(self, object, path, is_object_moved=0):
1167 1168
    """Add an object to the Catalog by calling all SQL methods and
    providing needed arguments.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1169

1170 1171
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1172

1173 1174 1175 1176
  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.
1177

1178 1179
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1180 1181

      disable_cache : do not use cache, so values will be computed each time,
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
                      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.
1194 1195
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
                              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?"""
1207
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1208
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1209

1210
    if idxs not in (None, []):
1211 1212
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1213

1214
    if not self.isIndexable():
1215
      return
1216

1217 1218 1219
    portal_catalog = self.getSiteRoot().portal_catalog # XXX-JPS - This is a hardcoded name. Weird
                                                       # Isn't self == self.getSiteRoot().portal_catalog
                                                       # in this case ?
1220

1221 1222
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
    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)

1241
    for object in object_list:
1242
      if not getattr(aq_base(object), 'uid', None):
1243
        try:
1244
          object.uid = self.newUid()
1245 1246
        except ConflictError:
          raise
1247
        except:
1248
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1249
      elif check_uid:
1250 1251
        uid = object.uid
        path = object.getPath()
1252
        index = path_uid_dict.get(path, None)
1253
        try:
1254
          index = long(index)
1255
        except TypeError:
1256
          index = None
1257 1258 1259
        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:
1260 1261
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1262
            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))
1263 1264 1265 1266 1267 1268
            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
1269
          if uid in uid_path_dict:
1270 1271 1272
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1273 1274 1275 1276 1277 1278
          #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()
1279 1280
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1281 1282 1283 1284 1285 1286 1287 1288
                # 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.
1289
                try:
1290
                  uid_buffer.remove(uid)
1291 1292
                except ValueError:
                  pass
1293 1294 1295 1296
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1297
            # can be due to path length
1298
            if len(path) > MAX_PATH_LEN:
1299 1300
              LOG('SQLCatalog', WARNING, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))

1301
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1302
            LOG('SQLCatalog', WARNING,
1303
                '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))
1304

1305 1306
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1307
    econtext_cache = {}
1308
    expression_result_cache = {}
1309 1310
    argument_cache = {}

1311
    try:
1312
      if not disable_cache:
1313
        enableReadOnlyTransactionCache(self)
1314

1315
      for method_name in method_id_list:
1316
        kw = {}
1317
        if self.isMethodFiltered(method_name):
1318
          catalogged_object_list = []
1319 1320 1321 1322
          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()
1323 1324 1325 1326
          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
1327
            if type_set is not None and object.getPortalType() not in type_set:
1328 1329
              continue
            elif expression is not None:
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
              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
1357 1358 1359 1360 1361
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
1362

1363 1364
        if len(catalogged_object_list) == 0:
          continue
1365

1366 1367
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1368
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1369
          # Build the dictionnary of values
1370
          arguments = split(method.arguments_src)
1371 1372 1373
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1374 1375 1376 1377 1378 1379 1380 1381 1382
        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:
1383
              try:
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
                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
1395

Jérome Perrin's avatar
Jérome Perrin committed
1396
        method = aq_base(method).__of__(portal_catalog) # Use method in
1397 1398 1399 1400
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1401
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1402 1403 1404 1405 1406 1407 1408
          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]))
1409

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

1420 1421
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1422

1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
  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
1435 1436 1437 1438
    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
1439
      return self.uncatalogObject(path=path,uid=uid)
1440 1441 1442
    method = getattr(self, method_name)
    method(uid = uid)

1443
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
    """
    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

    """
1456
    if not self.isIndexable():
1457 1458
      return None

1459 1460
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1461 1462
    methods = self.sql_uncatalog_object
    if uid is None:
1463
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1464
    for method_name in methods:
1465 1466
      # 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
1467
      method = getattr(self, method_name)
1468
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1469

1470 1471 1472 1473
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1474 1475
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1476

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
  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())
1488

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1489 1490 1491
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1492
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1493 1494 1495 1496 1497 1498 1499 1500

  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 """
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
    #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
1511 1512
      return None

1513 1514 1515 1516 1517 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
  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
1552
          uid_path_dict[uid] = search_result[0].path
1553 1554
    return uid_path_dict

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1555 1556 1557 1558 1559 1560 1561 1562 1563
  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
1564 1565 1566 1567
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1568 1569 1570 1571 1572 1573 1574 1575
      # 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
1576 1577
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1578 1579 1580
    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
1581
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
      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
1610 1611
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1612 1613 1614
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1615 1616
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1617 1618 1619 1620 1621 1622
      return None

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

1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
  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
1635 1636
            if not isinstance(id, str):
              id=id()
1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
            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

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

1660
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1661 1662 1663
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1664 1665 1666
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1667 1668 1669 1670 1671
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1672

1673 1674
  def getTableIndex(self, table):
    """
1675
    Return a map between index and column for a given table
1676 1677 1678 1679 1680 1681 1682 1683
    """
    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:
1684 1685
        if table_index.has_key(line.KEY_NAME):
          table_index[line.KEY_NAME].append(line.COLUMN_NAME)
1686
        else:
1687 1688
          table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
      LOG("SQLCatalog.getTableIndex", INFO, "index = %s for table = %s" \
1689 1690 1691
          %(table_index, table))
      return table_index
    return CachingMethod(_getTableIndex, id='SQLCatalog.getTableIndex', \
Aurel's avatar
Aurel committed
1692
                         cache_factory='erp5_content_long')(table=table)
1693 1694


1695
  def getIndex(self, table, column_list, all_column_list):
1696 1697 1698
    """
    Return possible index for a column list in a given table
    """
1699
    def _getIndex(table, column_list, all_column_list):
1700 1701 1702
      index_dict = self.getTableIndex(table)
      if isinstance(column_list, str):
        column_list = [column_list,]
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724
      # 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
1725
    return CachingMethod(_getIndex, id='SQLCatalog.getIndex', cache_factory='erp5_content_long')\
1726 1727
          (table=table, column_list=column_list, all_column_list=all_column_list)

1728

1729
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
1730
                          ignore_empty_string=1, query=None, stat__=0, **kw):
1731
    """ Builds a complex SQL query to simulate ZCatalog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1732 1733 1734 1735 1736 1737 1738
    # 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

1739
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
1740 1741
    # 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
1742 1743
      kw = REQUEST

1744
    acceptable_key_map = self.getColumnMap()
1745 1746
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1747
    datetime_search_keys = list(self.sql_catalog_datetime_search_keys)
1748
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1749
    multivalue_keys = self.sql_catalog_multivalue_keys
Aurel's avatar
Aurel committed
1750 1751


1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
    # 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
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795

    # 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

1796 1797 1798 1799 1800
    # 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
1801 1802 1803 1804 1805 1806
      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
1807 1808
      scriptable_key_dict[key] = method_id

1809 1810 1811 1812
    # Build the list of Queries and ComplexQueries
    query_dict = {}
    key_list = [] # the list of column keys
    key_alias_dict = {}
1813
    query_group_by_list = None # Useful to keep a default group_by passed by scriptable keys
1814 1815 1816
    query_related_table_map_dict = {}
    if query is not None:
      kw ['query'] = query
1817
    for key in kw.keys():
1818
      if key not in RESERVED_KEY_LIST:
1819 1820 1821
        value = kw[key]
        current_query = None
        new_query_dict = {}
1822 1823 1824
        if isinstance(value, (Query, ComplexQuery)):
          current_query = value
        elif scriptable_key_dict.has_key(key):
Ivan Tyagov's avatar
Ivan Tyagov committed
1825 1826 1827 1828 1829 1830 1831 1832
          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)
1833
          if hasattr(current_query, 'order_by'): query_group_by_list = current_query.order_by
1834
        else:
1835
          if isinstance(value, dict):
1836
            for value_key in value.keys():
1837 1838
              if value_key == 'query':
                new_query_dict[key] = value['query']
1839
              else:
1840
                new_query_dict[value_key] = value[value_key]
1841
          else:
1842
            new_query_dict[key] = value
1843
          current_query = Query(**new_query_dict)
1844 1845 1846
        if current_query is not None:
          query_dict[key] = current_query
          key_list.extend(current_query.getSQLKeyList())
1847
          query_related_table_map_dict.update(current_query.getRelatedTableMapDict())
1848

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

1859
    related_tuples = self.getSQLCatalogRelatedKeyList(key_list=key_list)
Ivan Tyagov's avatar
Ivan Tyagov committed
1860
    
1861
    # Define related maps
1862 1863
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
1864
    related_keys = {}
1865 1866 1867
    related_method = {}
    related_table_map = {}
    related_column = {}
1868
    related_table_list = {}
1869
    table_rename_index = 0
1870
    related_methods = {} # related methods which need to be used
1871 1872 1873
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
1874
      if key in key_list:
1875
        if ignore_empty_string \
1876 1877 1878 1879
            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
1880
          continue
1881
        join_tuple = t_tuple[1].strip().split('/')
1882
        related_keys[key] = None
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
        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
1899

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

    def getNewKeyAndUpdateVariables(key):
1910
      key_is_acceptable = key in acceptable_key_map # Only calculate once
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
      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
1921
          new_key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1],
1922 1923 1924 1925 1926 1927 1928 1929
                               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 \
1930
                '%s.%s' % (query_table, key) in acceptable_key_map:
1931 1932 1933
              new_key = '%s.%s' % (query_table, key)
            elif key == 'uid':
              # uid is always ambiguous so we can only change it here
1934
              new_key = 'catalog.uid'
1935 1936
            else:
              LOG('SQLCatalog', WARNING, 'buildSQLQuery this key is too ambiguous : %s' % key)
1937 1938 1939 1940
          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
1941
            from_table_dict[acceptable_key_map[new_key][0]] = acceptable_key_map[new_key][0]
1942 1943 1944 1945 1946 1947 1948 1949 1950
      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
1951 1952
    select_expression_key = ''
    
1953
    from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1954
    if len(kw):
1955 1956 1957 1958
      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]
1959
      if kw.has_key('select_expression'):
Jérome Perrin's avatar
Jérome Perrin committed
1960
        select_expression_list.append(kw['select_expression'])
1961
      if kw.has_key('group_by_expression'):
1962
        group_by_expression_list.append(kw['group_by_expression'])
1963
      # Grouping
1964
      group_by_list = kw.get('group_by', query_group_by_list)
1965 1966 1967 1968
      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:
1969 1970
            new_key = getNewKeyAndUpdateVariables(key)
            group_by_expression_list.append(new_key)
1971 1972 1973 1974
        except ConflictError:
          raise
        except:
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new group by expression', error=sys.exc_info())
1975 1976 1977 1978
          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)
1979

1980
    sort_on = None
1981
    sort_key_list = []
1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
    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
1994
          else:
1995 1996 1997 1998 1999 2000 2001 2002
            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
2003
        for (original_key, so, as_type) in sort_index:
2004
          key = getNewKeyAndUpdateVariables(original_key)
2005 2006 2007
          if key is None:
            if original_key in select_expression_key:
              key = original_key
2008
          if key is not None:
2009
            sort_key_list.append(key)
2010 2011 2012 2013 2014 2015
            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)
2016
            else:
2017 2018
              new_sort_index.append('%s' % key)
          else:
2019 2020
            LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build sort '
                'index (%s -> %s)' % (original_key, key))
2021 2022 2023 2024 2025 2026 2027
        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 = ''
2028
        sort_key_list = []
2029 2030 2031 2032 2033

    for key in key_list:
      if not key_alias_dict.has_key(key):
        getNewKeyAndUpdateVariables(key)
    if len(query_dict):
2034
      for key, query in query_dict.items():
2035 2036 2037
        query_result = query.asSQLExpression(key_alias_dict=key_alias_dict,
                                    full_text_search_keys=full_text_search_keys,
                                    keyword_search_keys=keyword_search_keys,
2038
                                    datetime_search_keys=datetime_search_keys,
2039 2040 2041 2042 2043
                                    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
2044

2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
    # 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
2062 2063
    if kw.get('where_expression',None) not in (None,''):
      where_expression_list.append(kw['where_expression'])
2064 2065
    if len(where_expression_list)>1:
      where_expression_list = ['(%s)' % x for x in where_expression_list]
2066 2067 2068 2069 2070 2071 2072 2073
    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
2074

2075
    # force index if exists when doing sort as mysql doesn't manage them efficiently
2076
    if len(sort_key_list) > 0:
2077 2078
      index_from_table = {}
      # first group columns from a same table
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
      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]

2090
        table = from_table_dict[related_table]
2091 2092 2093 2094 2095 2096
        # 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
2097 2098 2099 2100 2101 2102
        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():
2103
        available_index_list = self.getIndex(table, index_from_table[table], key_list)
2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
        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

2116
    # Use a dictionary at the moment.
2117 2118 2119 2120
    from_expression = kw.get('from_expression', {})
    final_from_expression = ', '.join(
      [from_expression.get(table, '`%s` AS `%s`' % (table, alias))
       for table, alias in from_table_dict.iteritems()])
2121
    return { 'from_table_list' : from_table_dict.items(),
2122
             'from_expression' : final_from_expression,
2123
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2124
             'where_expression' : where_expression,
2125
             'limit_expression' : limit_expression,
2126 2127
             'select_expression': select_expression,
             'group_by_expression' : group_by_expression}
2128

2129 2130 2131
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

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

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

  __call__ = searchResults

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

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

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

2180
  def readRecordedObjectList(self, catalog=1):
2181 2182 2183 2184
    """
      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)
2185
    return method(catalog=catalog)
Ivan Tyagov's avatar
Ivan Tyagov committed
2186
   
2187 2188 2189 2190 2191 2192 2193 2194
  # 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:
2195
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2196

2197 2198 2199 2200
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2201

2202
      for id in method_id_list:
2203 2204 2205
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2206 2207 2208 2209 2210
          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"

2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
        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]
2231
          if isinstance(list_type, str):
2232 2233 2234 2235 2236
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2237 2238 2239 2240 2241 2242 2243 2244 2245
        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'] = ""

2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
    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
2256
      if getattr(aq_base(self), 'filter_dict', None) is None:
2257 2258
        self.filter_dict = PersistentMapping()
        return 0
2259
      try:
2260
        return self.filter_dict[method_name]['filtered']
2261 2262
      except KeyError:
        return 0
2263 2264 2265
    return 0

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

2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
  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 ""

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

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

2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
  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 []
2331 2332 2333 2334 2335 2336 2337

  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2338 2339 2340 2341
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355
      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,
2356 2357 2358 2359
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
2360 2361 2362 2363 2364 2365 2366 2367 2368
            # XXX these below are defined, because there is no
            # accessor for some attributes, and restricted environment
            # may not access them directly.
            'isDelivery':   ob.isDelivery,
            'isMovement':   ob.isMovement,
            'isPredicate':  ob.isPredicate,
            'isDocument':   ob.isDocument,
            'isInventory':  ob.isInventory,
            'isInventoryMovement': ob.isInventoryMovement,
2369 2370 2371 2372 2373 2374
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2375
class CatalogError(Exception): pass
Ivan Tyagov's avatar
Ivan Tyagov committed
2376

2377 2378
# pool of global preinitialized search keys instances
SEARCH_KEY_INSTANCE_POOL = threading.local()
Ivan Tyagov's avatar
Ivan Tyagov committed
2379 2380 2381 2382 2383
# 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
2384 2385 2386 2387 2388 2389 2390 2391 2392 2393
  if not hasattr(SEARCH_KEY_INSTANCE_POOL, 'pool'):
    pool = dict()
    for klass in (DefaultKey, RawKey, KeyWordKey, DateTimeKey,
                             FullTextKey, FloatKey, ScriptableKey, KeyMappingKey):
      search_key_instance = klass()
      search_key_instance.build()
      pool[klass] = search_key_instance
    SEARCH_KEY_INSTANCE_POOL.pool = pool

  return SEARCH_KEY_INSTANCE_POOL.pool[search_key_class]
Ivan Tyagov's avatar
Ivan Tyagov committed
2394 2395 2396 2397 2398 2399 2400 2401
  
from Query.Query import QueryMixin
from Query.SimpleQuery import NegatedQuery, SimpleQuery
from Query.ComplexQuery import ComplexQuery

# for of backwards compatability  
QueryMixin = QueryMixin
Query = SimpleQuery
2402
NegatedQuery = NegatedQuery
Ivan Tyagov's avatar
Ivan Tyagov committed
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
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

2413