SQLCatalog.py 91.8 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2
##############################################################################
#
3
# Copyright (c) 2002-2009 Nexedi SARL. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17
# 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 thread import allocate_lock, get_ident
22
from OFS.Folder import Folder
23
from AccessControl import ClassSecurityInfo
24
from BTrees.OIBTree import OIBTree
25 26
from App.config import getConfiguration
from BTrees.Length import Length
27
from Shared.DC.ZRDB.TM import TM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
28

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

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

from Interface.IQueryCatalog import ISearchKeyCatalog
from Interface.Verify import verifyClass

PROFILING_ENABLED = False
if PROFILING_ENABLED:
  from tiny_profiler import profiler_decorator, profiler_report, profiler_reset
else:
  def profiler_decorator(func):
    return func
54 55 56 57 58 59 60 61 62

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

63 64 65 66
try:
  import psyco
except ImportError:
  psyco = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
67

68
try:
69 70
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache
  from Products.ERP5Type.Cache import disableReadOnlyTransactionCache, CachingMethod
71
except ImportError:
72
  LOG('SQLCatalog', WARNING, 'Count not import CachingMethod, expect slowness.')
73 74
  def doNothing(context):
    pass
75 76 77 78 79 80
  class CachingMethod:
    """
      Dummy CachingMethod class.
    """
    def __init__(self, callable, **kw):
      self.function = callable
Yoshinori Okuji's avatar
Yoshinori Okuji committed
81
    def __call__(self, *opts, **kw):
82
      return self.function(*opts, **kw)
83 84
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
85 86 87 88 89 90 91 92 93 94 95 96 97

class caching_class_method_decorator:
  def __init__(self, *args, **kw):
    self.args = args
    self.kw = kw

  def __call__(self, method):
    caching_method = CachingMethod(method, *self.args, **self.kw)
    return lambda *args, **kw: caching_method(*args, **kw)

try:
  from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
except ImportError:
98
  LOG('SQLCatalog', WARNING, 'Count not import getTransactionalVariable, expect slowness.')
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  def getTransactionalVariable(context):
    return {}

class transactional_cache_decorator:
  """
    Implements singleton-style caching.
    Wrapped method must have no parameters (besides "self").
  """
  def __init__(self, cache_id):
    self.cache_id = cache_id

  def __call__(self, method):
    def wrapper(wrapped_self):
      transactional_cache = getTransactionalVariable(None)
      try:
        return transactional_cache[self.cache_id]
      except KeyError:
        result = transactional_cache[self.cache_id] = method(wrapped_self)
        return result
    return wrapper

120 121 122 123
try:
  from ZPublisher.HTTPRequest import record
except ImportError:
  dict_type_list = (dict, )
124 125
else:
  dict_type_list = (dict, record)
126 127


128
UID_BUFFER_SIZE = 300
129 130
OBJECT_LIST_SIZE = 300
MAX_PATH_LEN = 255
131
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
132 133
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report',
                     'extra_key_list', )
134

135
valid_method_meta_type_list = ('Z SQL Method', 'LDIF Method', 'Script (Python)') # Nicer
136

137
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
138

139 140 141 142 143
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

144
def manage_addSQLCatalog(self, id, title,
145
             vocab_id='create_default_catalog_', # vocab_id is a strange name - not abbreviation
146 147 148
             REQUEST=None):
  """Add a Catalog object
  """
149 150 151
  id = str(id)
  title = str(title)
  vocab_id = str(vocab_id)
152 153 154
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

155
  c = Catalog(id, title, self)
156 157 158 159
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

160 161
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
162

Yoshinori Okuji's avatar
Yoshinori Okuji committed
163
  def __init__(self):
164
    """Initialize some variables.
165

166
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
167

168
      finished_buffer is used to hold reserved uids created by committed-transactions.
169

170
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
171
      invalid afterwards, so they may not be used by other transactions."""
172 173
    self.temporary_buffer = {}
    self.finished_buffer = []
174

175 176 177 178 179 180 181 182
  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
183

184 185 186 187 188 189 190
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
191

192 193 194 195 196 197 198 199
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
200

201 202 203 204 205 206 207 208 209 210 211
  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
212

213 214 215 216
  def pop(self):
    self._register()
    tid = get_ident()
    try:
217
      uid = self.temporary_buffer[tid].pop()
218
    except (KeyError, IndexError):
219 220
      uid = self.finished_buffer.pop()
    return uid
221

222 223 224
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
225
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
226

227 228
related_key_definition_cache = {}

229 230 231 232 233
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
              ExtensionClass.Base,
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
234 235 236 237
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
238
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
239 240 241 242 243 244 245 246

  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

247 248
  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.
249 250 251
  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).
252 253 254
  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
255

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

257
  brain defined in methods...
Jean-Paul Smets's avatar
Jean-Paul Smets committed
258 259 260 261 262 263

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
264 265 266

  __implements__ = ISearchKeyCatalog

267
  meta_type = "SQLCatalog"
268
  icon = 'misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  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'),}
298
    ) + OFS.History.Historical.manage_options
299

300
  __ac_permissions__= (
301 302 303 304 305

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

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
306 307
      'manage_catalogFilter',
      'manage_catalogAdvanced',
308 309

      'manage_catalogReindex', 'manage_catalogFoundItems',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
310 311
      'manage_catalogClear',
      'manage_main',
312 313 314 315 316 317
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
318 319
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
320
      'getFilterableMethodList',],
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
     ['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' },
346 347 348 349 350
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
351 352 353 354 355
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
356 357
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
358 359 360 361 362 363 364 365
      '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' },
366 367 368
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
369 370
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
371 372 373
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
374 375
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
376 377
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
378 379 380
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
381
    { 'id'      : 'sql_record_object_list',
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
      '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
401 402 403 404 405
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
    { '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' },
441 442 443 444 445
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    { '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' },
461 462 463 464 465
    { 'id'      : 'sql_catalog_datetime_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    { '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' },
481 482 483 484 485
    { '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' },
486 487 488 489 490 491 492 493 494
    { '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' },
495 496 497 498 499
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
500 501 502 503 504 505 506 507 508 509 510
    { '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' },
511 512 513 514 515 516 517
    { 'id': 'sql_catalog_table_vote_scripts',
      'title': 'Table vote scripts',
      'description': 'Scripts helping column mapping resolution',
      'type': 'multiple selection',
      'select_variable' : 'getPythonMethodIds',
      'mode': 'w' },

518 519
  )

520
  sql_catalog_produce_reserved = ''
521
  sql_catalog_delete_uid = ''
522 523 524 525 526 527 528 529 530 531 532
  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
533
  sql_search_security = ''
534 535 536 537 538 539
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
540
  sql_catalog_index = ''
541 542 543
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
544
  sql_catalog_datetime_search_keys = ()
545 546 547 548 549
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
550
  sql_catalog_index_on_order_keys = ()
551
  sql_catalog_related_keys = ()
552
  sql_catalog_scriptable_keys = ()
553 554
  sql_catalog_role_keys = ()
  sql_catalog_local_role_keys = ()
555
  sql_catalog_table_vote_scripts = ()
556

557 558 559 560 561 562
  # 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
563

564 565 566 567 568 569 570
  # 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
571

572 573 574 575 576 577 578 579 580 581
  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
582 583 584
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
585
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
586

587 588 589 590 591 592 593 594 595 596 597 598 599 600
  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]

601 602 603 604 605 606
  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')
607 608 609 610 611 612 613 614
    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
615
    property_list.sort(key=lambda x: x[0])
616 617 618
    for property in property_list:
      property_id = property[0]
      value       = property[1]
619
      if isinstance(value, basestring):
620
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
621
      elif isinstance(value, (tuple, list)):
622 623 624
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
625
        for item in value:
626
          if isinstance(item, basestring):
627 628 629 630
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
631
        f.write('  </property>\n')
632 633 634
    # 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'):
635 636
      filter_list = []
      for filter_id in self.filter_dict.keys():
637
        filter_definition = self.filter_dict[filter_id]
638 639
        filter_list.append((filter_id, filter_definition))
      # Sort for easy diff
640
      filter_list.sort(key=lambda x: x[0])
641 642 643 644
      for filter_item in filter_list:
        filter_id  = filter_item[0]
        filter_def = filter_item[1]
        if not filter_def['filtered']:
645 646
          # If a filter is not activated, no need to output it.
          continue
647
        if not filter_def['expression']:
648 649
          # If the expression is not specified, meaningless to specify it.
          continue
650
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
651
        # For now, portal types are not exported, because portal types are too specific to each site.
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
    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):
673
            raise CatalogError, 'unknown property id %r' % (id,)
674
          if type not in ('str', 'tuple'):
675
            raise CatalogError, 'unknown property type %r' % (type,)
676 677 678 679
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
680
                value = str(text.data)
681 682 683 684 685 686
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
687
                raise CatalogError, 'unknown item type %r' % (item_type,)
688 689
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
690
                  value.append(str(text.data))
691 692 693 694
                  break
            value = tuple(value)

          setattr(self, id, value)
695

696 697 698
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
699
          id = str(filt.getAttribute("id"))
700 701 702 703 704 705 706 707 708 709 710 711
          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
712 713 714 715
      finally:
        doc.unlink()
    finally:
      f.close()
Aurel's avatar
Aurel committed
716

717 718 719 720 721 722 723
  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__)))
724 725 726

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
727
    self.security_uid_index = None
728 729

  security.declarePrivate('getSecurityUid')
730
  def getSecurityUid(self, wrapped_object):
731 732 733 734 735 736 737
    """
      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
738
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
739 740 741 742
    # 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)
743 744
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
745 746 747
      self._clearSecurityCache()
    if self.security_uid_dict.has_key(allowed_roles_and_users):
      return (self.security_uid_dict[allowed_roles_and_users], None)
748 749 750 751 752 753 754 755
    # 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
756 757
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
758 759 760 761
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
762
          default = previous_security_uid
763 764 765 766 767 768 769 770 771 772 773
      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
774 775
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
776

777 778 779 780 781 782 783 784 785 786 787
  def getRoleAndSecurityUidList(self):
    """
      Return a list of 2-tuples, suitable for direct use in a zsqlmethod.
      Goal: make it possible to regenerate a table containing this data.
    """
    result = []
    extend = result.extend
    for role_list, security_uid in getattr(aq_base(self), 'security_uid_dict', {}).iteritems():
      extend([(role, security_uid) for role in role_list])
    return result

Jean-Paul Smets's avatar
Jean-Paul Smets committed
788 789 790 791 792 793
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
794
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
795 796
      try:
        method()
797 798
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
799
      except:
800
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
801
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
802

803
    # Reserved uids have been removed.
804
    self.clearReserved()
805

806
    # Add a dummy item so that SQLCatalog will not use existing uids again.
807
    self.insertMaxUid()
808

809
    # Remove the cache of catalog schema.
810 811
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
812

813
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
814

815 816 817 818 819 820 821 822 823 824
  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()])

825 826 827 828 829 830
  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
831 832 833 834 835
    try:
      method()
    except ConflictError:
      raise
    except:
836
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
837 838 839
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
840
    self._last_clear_reserved_time += 1
841

Jean-Paul Smets's avatar
Jean-Paul Smets committed
842 843 844 845 846 847 848 849 850
  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]
851
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871

  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

872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
  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

889
  security.declarePublic('getCatalogSearchResultKeys')
890 891 892 893
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
894

895
  def _getCatalogSchema(self, table=None):
896 897 898
    # 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.
899
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
900

901 902 903 904 905 906 907 908
    if table not in catalog_schema_dict:
      result_list = []
      try:
        method_name = self.sql_catalog_schema
        method = getattr(self, method_name)
        search_result = method(table=table)
        for c in search_result:
          result_list.append(c.Field)
909 910
      except ConflictError:
        raise
911
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
912
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
913 914 915
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
916

917
    return catalog_schema_dict[table]
918

Jean-Paul Smets's avatar
Jean-Paul Smets committed
919 920
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
921 922 923
    Calls the show column method and returns dictionnary of
    Field Ids
    """
924
    def _getColumnIds():
925 926 927 928
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
929 930
          keys[field] = None
          keys['%s.%s' % (table, field)] = None  # Is this inconsistent ?
931
      for related in self.getSQLCatalogRelatedKeyList():
932 933
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
934
        keys[related_key] = None
935 936 937
      for scriptable in self.getSQLCatalogScriptableKeyList():
        scriptable_tuple = scriptable.split('|')
        scriptable = scriptable_tuple[0].strip()
938
        keys[scriptable] = None
939 940 941
      keys = keys.keys()
      keys.sort()
      return keys
942
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_factory='erp5_content_long')()[:]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
943

944 945 946 947 948
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog.getColumnMap')
  @profiler_decorator
  @caching_class_method_decorator(id='SQLCatalog.getColumnMap', cache_factory='erp5_content_long')
  @profiler_decorator
949 950 951 952 953
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
954 955 956 957 958 959
    result = {}
    for table in self.getCatalogSearchTableIds():
      for field in self._getCatalogSchema(table=table):
        result.setdefault(field, []).append(table)
        result.setdefault('%s.%s' % (table, field), []).append(table) # Is this inconsistent ?
    return result
960

Jean-Paul Smets's avatar
Jean-Paul Smets committed
961 962 963 964 965 966 967
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
968 969 970
      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
971 972 973 974
    keys = keys.keys()
    keys.sort()
    return keys

975 976 977 978 979 980 981 982 983 984 985 986 987 988
  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
989 990 991
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
992 993 994
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
995 996
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
997 998 999
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1000
        keys.append(c[0])
1001 1002
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1003 1004
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1005 1006
    return keys

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  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
1021
  # the cataloging API
1022 1023 1024
  def produceUid(self):
    """
      Produces reserved uids in advance
1025
    """
1026 1027 1028 1029
    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.
1030 1031 1032 1033
    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:
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
      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]
1056
      uid_buffer.extend(uid_list)
1057

1058 1059 1060 1061 1062 1063
  def isIndexable(self):
    """
    This is required to check in many methods that
    the site root and zope root are indexable
    """
    zope_root = self.getZopeRoot()
1064
    site_root = self.getSiteRoot() # XXX-JPS - Why don't we use getPortalObject here ?
1065 1066 1067 1068 1069 1070

    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
1071

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
  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

1092 1093 1094
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1095 1096
      with multiple ZEO clients on a single ZEO server.

1097
      The main risk is the following:
1098

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

1101
      - one reindexing node N1 starts reindexing f
1102

1103
      - another reindexing node N2 starts reindexing e
1104

1105 1106 1107
      - 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

1108
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1109
      with the risk of graph loops
1110
    """
1111
    if not self.isIndexable():
1112 1113
      return None

1114 1115 1116 1117
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1118 1119 1120
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1121 1122 1123 1124 1125 1126
        # 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
1127 1128 1129 1130
        if self._max_uid is None:
          self._max_uid = Length()
        if uid > self._max_uid():
          self._max_uid.set(uid)
1131
        return long(uid)
1132 1133 1134 1135
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1136

1137 1138 1139
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1140
      if isinstance(urls, str):
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
        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:
1156
      if isinstance(urls, str):
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
        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`)))

1180
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1181
                          URL1=None, sql_catalog_id=None):
1182
    """ clears the whole enchilada """
1183 1184
    self.beforeCatalogClear()

1185 1186 1187
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1188
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1189
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1190 1191

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1192
    """ clears reserved uids """
1193 1194 1195
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1196
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1197
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

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

1239 1240
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1241

1242 1243 1244 1245
  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.
1246

1247 1248
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1249 1250

      disable_cache : do not use cache, so values will be computed each time,
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
                      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.
1263 1264
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
                              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?"""
1276
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1277
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1278

1279
    if idxs not in (None, []):
1280 1281
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1282

1283
    if not self.isIndexable():
1284
      return
1285

1286 1287
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
    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)

1306 1307 1308 1309 1310
    # This dict will store uids and objects which are verified below.
    # The purpose is to prevent multiple objects from having the same
    # uid inside object_list.
    assigned_uid_dict = {}

1311
    for object in object_list:
1312
      if getattr(aq_base(object), 'uid', None) is None:
1313
        try:
1314
          object.uid = self.newUid()
1315 1316
        except ConflictError:
          raise
1317
        except:
1318
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1319
      elif check_uid:
1320
        uid = object.uid
1321 1322 1323 1324 1325 1326
        if uid in assigned_uid_dict:
          object.uid = self.newUid()
          LOG('SQLCatalog', WARNING,
              'uid of %r changed from %r to %r as old one is assigned to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid, assigned_uid_dict[uid]))
          uid = object.uid

1327
        path = object.getPath()
1328
        index = path_uid_dict.get(path, None)
1329
        try:
1330
          index = long(index)
1331
        except TypeError:
1332
          index = None
1333 1334 1335
        if index is not None:
          if index < 0:
            raise CatalogError, 'A negative uid %d is used for %s. Your catalog is broken. Recreate your catalog.' % (index, path)
1336 1337
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1338
            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))
1339 1340 1341 1342 1343 1344
            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
1345
          if uid in uid_path_dict:
1346 1347 1348
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1349 1350 1351 1352 1353 1354
          #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()
1355 1356
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1357 1358 1359 1360 1361 1362 1363 1364
                # 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.
1365
                try:
1366
                  uid_buffer.remove(uid)
1367 1368
                except ValueError:
                  pass
1369 1370 1371 1372
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1373
            # can be due to path length
1374
            if len(path) > MAX_PATH_LEN:
1375 1376
              LOG('SQLCatalog', WARNING, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))

1377
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1378
            LOG('SQLCatalog', WARNING,
1379
                '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))
1380 1381 1382
            uid = object.uid

        assigned_uid_dict[uid] = object
1383

1384 1385
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1386
    econtext_cache = {}
1387
    expression_result_cache = {}
1388 1389
    argument_cache = {}

1390
    try:
1391
      if not disable_cache:
1392
        enableReadOnlyTransactionCache(self)
1393

1394
      for method_name in method_id_list:
1395
        kw = {}
1396
        if self.isMethodFiltered(method_name):
1397
          catalogged_object_list = []
1398
          filter = self.filter_dict[method_name]
1399
          type_set = frozenset(filter['type']) or None
1400 1401
          expression = filter['expression_instance']
          expression_cache_key_list = filter.get('expression_cache_key', '').split()
1402 1403 1404 1405
          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
1406
            if type_set is not None and object.getPortalType() not in type_set:
1407 1408
              continue
            elif expression is not None:
1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
              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
1436 1437 1438 1439 1440
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
1441

1442 1443
        if len(catalogged_object_list) == 0:
          continue
1444

1445 1446
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1447
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1448
          # Build the dictionnary of values
1449
          arguments = method.arguments_src.split()
1450 1451 1452
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1453 1454 1455 1456 1457 1458 1459 1460 1461
        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:
1462
              try:
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
                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
1474

1475 1476 1477
        # Alter/Create row
        try:
          #start_time = DateTime()
1478
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1479 1480 1481 1482 1483 1484 1485
          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]))
1486

1487 1488 1489
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1490
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1491 1492 1493
              error=sys.exc_info())
          raise
    finally:
1494
      if not disable_cache:
1495
        disableReadOnlyTransactionCache(self)
1496

1497 1498
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1499

1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
  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
1512 1513 1514 1515
    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
1516
      return self.uncatalogObject(path=path,uid=uid)
1517 1518 1519
    method = getattr(self, method_name)
    method(uid = uid)

1520
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
    """
    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

    """
1533
    if not self.isIndexable():
1534 1535
      return None

1536 1537
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1538 1539
    methods = self.sql_uncatalog_object
    if uid is None:
1540
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1541
    for method_name in methods:
1542 1543
      # 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
1544
      method = getattr(self, method_name)
1545
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1546

1547 1548 1549 1550
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1551 1552
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1553

1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
  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())
1565

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1566 1567 1568
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1569
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1570 1571 1572 1573 1574 1575 1576 1577

  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 """
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
    #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
1588 1589
      return None

1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
  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
1629
          uid_path_dict[uid] = search_result[0].path
1630 1631
    return uid_path_dict

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1632 1633 1634 1635 1636 1637 1638 1639 1640
  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
1641 1642 1643 1644
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1645 1646 1647 1648 1649 1650 1651 1652
      # 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
1653 1654
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1655 1656 1657
    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
1658
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
      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
1687 1688
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1689 1690 1691
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1692 1693
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1694 1695 1696 1697 1698 1699
      return None

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

1700 1701
  def getCatalogMethodIds(self,
      valid_method_meta_type_list=valid_method_meta_type_list):
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
    """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
1713 1714
            if not isinstance(id, str):
              id=id()
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
            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

1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
  def getPythonMethodIds(self):
    """
      Returns a list of all python scripts available in
      current sql catalog.
    """
    return self.getCatalogMethodIds(valid_method_meta_type_list=('Script (Python)', ))

  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog._getSQLCatalogRelatedKeyList')
  @profiler_decorator
  def _getSQLCatalogRelatedKeySet(self):
    column_map = self.getColumnMap()
    column_set = set(column_map)
    for related_key in self.sql_catalog_related_keys:
1740 1741
      split_entire_definition = related_key.split('|')
      if len(split_entire_definition) != 2:
1742
        LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (related_key, ))
1743 1744
        continue
      related_key_id = split_entire_definition[0].strip()
1745 1746
      if related_key_id in column_set:
        if related_key_id in column_map:
1747
          LOG('SQLCatalog', WARNING, 'Related key %r has the same name as an existing column on tables %r' % (related_key_id, column_map[related_key_id]))
1748
        else:
1749
          LOG('SQLCatalog', WARNING, 'Related key %r is declared more than once.' % (related_key_id, ))
1750 1751 1752
      column_set.add(related_key_id)
    return column_set

1753
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1754 1755
    """
    Return the list of related keys.
1756
    This method can be overidden in order to implement
1757 1758
    dynamic generation of some related keys.
    """
1759 1760
    if key_list is None:
      key_list = []
1761
    column_map = self._getSQLCatalogRelatedKeySet()
1762
    # Do not generate dynamic related key for acceptable_keys
1763
    dynamic_key_list = [k for k in key_list if k not in column_map]
1764
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1765 1766 1767
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1768 1769 1770
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1771 1772 1773 1774 1775
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1776

1777 1778
  def getTableIndex(self, table):
    """
1779
    Return a map between index and column for a given table
1780 1781 1782 1783 1784 1785 1786 1787
    """
    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:
1788 1789
        if table_index.has_key(line.KEY_NAME):
          table_index[line.KEY_NAME].append(line.COLUMN_NAME)
1790
        else:
1791
          table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
1792 1793
      return table_index
    return CachingMethod(_getTableIndex, id='SQLCatalog.getTableIndex', \
1794
                         cache_factory='erp5_content_long')(table=table).copy()
1795

1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
  @profiler_decorator
  def isValidColumn(self, column_id):
    """
      Tells wether given name is or not an existing column.

      Warning: This includes "virtual" columns, such as related keys.
    """
    result = column_id in self.getColumnMap()
    if not result:
      result = self.getRelatedKeyDefinition(column_id) is not None
    return result

1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
  @profiler_decorator
  def getRelatedKeyDefinition(self, key):
    """
      Returns the definition of given related key name if found, None
      otherwise.
    """
    try:
      result = related_key_definition_cache[key]
    except KeyError:
      result = None
      for entire_definition in self.getSQLCatalogRelatedKeyList([key]):
1819 1820
        split_entire_definition = entire_definition.split('|')
        if len(split_entire_definition) != 2:
1821
          LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (entire_definition, ))
1822 1823
          continue
        name, definition = [x.strip() for x in split_entire_definition]
1824 1825 1826 1827 1828 1829
        if name == key:
          result = definition
          break
      if result is not None:
        related_key_definition_cache[key] = result
    return result
1830

1831 1832 1833 1834 1835 1836
  @transactional_cache_decorator('SQLCatalog._getgetScriptableKeyDict')
  def _getgetScriptableKeyDict(self):
    result = {}
    for scriptable_key_definition in self.sql_catalog_scriptable_keys:
      split_scriptable_key_definition = scriptable_key_definition.split('|')
      if len(split_scriptable_key_definition) != 2:
1837
        LOG('SQLCatalog', WARNING, 'Malformed scriptable key definition: %r. Ignored.' % (scriptable_key_definition, ))
1838 1839 1840 1841
        continue
      key, script_id = [x.strip() for x in split_scriptable_key_definition]
      script = getattr(self, script_id, None)
      if script is None:
1842
        LOG('SQLCatalog', WARNING, 'Scriptable key %r script %r is missing.' \
1843 1844 1845 1846 1847 1848 1849 1850
            ' Skipped.' % (key, script_id))
      else:
        result[key] = script
    return result

  def getScriptableKeyScript(self, key):
    return self._getgetScriptableKeyDict().get(key)

1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
  @profiler_decorator
  def getColumnSearchKey(self, key, search_key_name=None):
    """
      Return a SearchKey instance for given key, using search_key_name
      as a SearchKey name if given, otherwise guessing from catalog
      configuration. If there is no search_key_name given and no
      SearchKey can be found, return None.

      Also return a related key definition string with following rules:
       - If returned SearchKey is a RelatedKey, value is its definition
       - Otherwise, value is None
    """
1863
    # Is key a "real" column or some related key ?
1864 1865 1866 1867 1868 1869
    related_key_definition = None
    if key in self.getColumnMap():
      search_key = self.getSearchKey(key, search_key_name)
    else:
      # Maybe a related key...
      related_key_definition = self.getRelatedKeyDefinition(key)
1870
      if related_key_definition is None:
Yusei Tahara's avatar
Yusei Tahara committed
1871 1872
        # Unknown
        search_key = None
1873 1874 1875
      else:
        # It's a related key
        search_key = self.getSearchKey(key, 'RelatedKey')
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
    return search_key, related_key_definition

  @profiler_decorator
  def getColumnDefaultSearchKey(self, key):
    """
      Return a SearchKey instance which would ultimately receive the value
      associated with given key.
    """
    search_key, related_key_definition = self.getColumnSearchKey(key)
    if search_key is None:
      result = None
    else:
      if related_key_definition is not None:
1889 1890
        search_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
1891 1892 1893 1894 1895 1896 1897 1898
    return search_key

  @profiler_decorator
  def buildSingleQuery(self, key, value, search_key_name=None, logical_operator=None, comparison_operator=None):
    """
      From key and value, determine the SearchKey to use and generate a Query
      from it.
    """
1899 1900 1901 1902 1903
    script = self.getScriptableKeyScript(key)
    if script is None:
      search_key, related_key_definition = self.getColumnSearchKey(key, search_key_name)
      if search_key is None:
        result = None
Ivan Tyagov's avatar
Ivan Tyagov committed
1904
      else:
1905
        if related_key_definition is None:
1906
          build_key = search_key
1907
        else:
1908 1909 1910
          build_key = search_key.getSearchKey(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_key_name=search_key_name)
1911 1912 1913
        result = build_key.buildQuery(value, logical_operator=logical_operator,
                                      comparison_operator=comparison_operator)
        if related_key_definition is not None:
1914 1915 1916
          result = search_key.buildQuery(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_value=result)
1917 1918
    else:
      result = script(value)
1919 1920 1921
    return result

  @profiler_decorator
1922
  def _buildQueryFromAbstractSyntaxTreeNode(self, node, search_key):
1923
    if node.isLeaf():
1924
      result = search_key.buildQuery(node.getValue(), comparison_operator=node.getComparisonOperator())
1925 1926 1927 1928 1929 1930 1931 1932 1933
    elif node.isColumn():
      result = self.buildQueryFromAbstractSyntaxTreeNode(node.getSubNode(), node.getColumnName())
    else:
      query_list = []
      value_dict = {}
      append = query_list.append
      for subnode in node.getNodeList():
        if subnode.isLeaf():
          value_dict.setdefault(subnode.getComparisonOperator(), []).append(subnode.getValue())
1934
        else:
1935
          subquery = self._buildQueryFromAbstractSyntaxTreeNode(subnode, search_key)
1936 1937
          if subquery is not None:
            append(subquery)
1938
      logical_operator = node.getLogicalOperator()
1939 1940 1941 1942
      if logical_operator == 'not':
        query_logical_operator = None
      else:
        query_logical_operator = logical_operator
1943
      for comparison_operator, value_list in value_dict.iteritems():
1944
        append(search_key.buildQuery(value_list, comparison_operator=comparison_operator, logical_operator=query_logical_operator))
1945 1946
      if logical_operator == 'not' or len(query_list) > 1:
        result = ComplexQuery(query_list, logical_operator=logical_operator)
1947 1948
      elif len(query_list) == 1:
        result = query_list[0]
1949
      else:
1950 1951 1952
        result = None
    return result

1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
  @profiler_decorator
  def buildQueryFromAbstractSyntaxTreeNode(self, node, key):
    """
      Build a query from given Abstract Syntax Tree (AST) node by recursing in
      its childs.
      This method calls itself recursively when walking the tree.

      node
        AST node being treated.
      key
        Default column (used when there is no explicit column in an AST leaf).

      Expected node API is described in Interface/IAbstractSyntaxNode.py .
    """
    search_key, related_key_definition = self.getColumnSearchKey(key)
    if search_key is None:
      # Unknown, skip loudly
1970
      LOG('SQLCatalog', WARNING, 'Unknown column %r, skipped.' % (key, ))
1971
      result = None
1972 1973 1974 1975
    else:
      if related_key_definition is None:
        build_key = search_key
      else:
1976 1977
        build_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
1978 1979
      result = self._buildQueryFromAbstractSyntaxTreeNode(node, build_key)
      if related_key_definition is not None:
1980 1981 1982
        result = search_key.buildQuery(sql_catalog=self,
          related_key_definition=related_key_definition,
          search_value=result)
1983 1984
    return result

1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
  @profiler_decorator
  def buildQuery(self, kw, ignore_empty_string=True, operator='and'):
    query_list = []
    append = query_list.append
    # unknown_column_dict: contains all (key, value) pairs which could not be
    # changed into queries. This is here for backward compatibility, because
    # scripts can invoke this method and expect extra parameters (such as
    # from_expression) to be handled. As they are normaly handled at
    # buildSQLQuery level, we must store them into final ComplexQuery, which
    # will handle them.
    unknown_column_dict = {}
    # implicit_table_list: contains all tables explicitely given as par of
    # column names with empty values. This is for backward compatibility. See
    # comment about empty values.
    implicit_table_list = []
    for key, value in kw.iteritems():
      result = None
      if isinstance(value, dict_type_list):
        # Cast dict-ish types into plain dicts.
        value = dict(value)
      if ignore_empty_string and (
          value == ''
          or (isinstance(value, (list, tuple)) and len(value) == 0)
          or (isinstance(value, dict) and (
            'query' not in value
            or value['query'] == ''
            or (isinstance(value['query'], (list, tuple))
              and len(value['query']) == 0)))):
        # We have an empty value:
        # - do not create a query from it
        # - if key has a dot, add its left part to the list of "hint" tables
        #   This is for backward compatibility, when giving a mapped column
        #   with an empty value caused a join with catalog to appear in
        #   resulting where-expression)
        if '.' in key:
          implicit_table_list.append(key)
Vincent Pelletier's avatar
Vincent Pelletier committed
2021
        LOG('SQLCatalog', WARNING, 'Discarding empty value for key %r: %r' % (key, value))
2022
      else:
2023
        script = self.getScriptableKeyScript(key)
2024 2025 2026
        if isinstance(value, _Query):
          # Query instance: use as such, ignore key.
          result = value
2027 2028
        elif script is not None:
          result = script(value)
2029 2030 2031 2032
        elif isinstance(value, basestring):
          # String: parse using key's default search key.
          search_key = self.getColumnDefaultSearchKey(key)
          if search_key is not None:
2033
            abstract_syntax_tree = search_key.parseSearchText(value, self.isValidColumn)
2034 2035 2036
            if abstract_syntax_tree is None:
              # Parsing failed, create a query from the bare string.
              result = self.buildSingleQuery(key, value)
2037
            else:
2038 2039 2040 2041 2042 2043 2044 2045
              result = self.buildQueryFromAbstractSyntaxTreeNode(abstract_syntax_tree, key)
        elif isinstance(value, dict):
          # Dictionnary: might contain the search key to use.
          search_key_name = value.get('key')
          # Backward compatibility: former "Keyword" key is now named
          # "KeywordKey".
          if search_key_name == 'Keyword':
            search_key_name = value['key'] = 'KeywordKey'
2046 2047 2048 2049
          # Backward compatibility: former "ExactMatch" is now only available
          # as "RawKey"
          elif search_key_name == 'ExactMatch':
            search_key_name = value['key'] = 'RawKey'
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
          result = self.buildSingleQuery(key, value, search_key_name)
        else:
          # Any other type, just create a query. (can be a DateTime, ...)
          result = self.buildSingleQuery(key, value)
        if result is None:
          # No query could be created, emit a log, add to unknown column dict.
          unknown_column_dict[key] = value
        else:
          append(result)
    if len(unknown_column_dict):
2060
      LOG('SQLCatalog', WARNING, 'Unknown columns %r, skipped.' % (unknown_column_dict.keys(), ))
2061
    return ComplexQuery(query_list, logical_operator=operator, unknown_column_dict=unknown_column_dict, implicit_table_list=implicit_table_list)
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081

  @profiler_decorator
  def buildOrderByList(self, sort_on=None, sort_order=None, order_by_expression=None):
    """
      Internal method. Should not be used by code outside buildSQLQuery.

      It is in a separate method because this code is here to keep backward
      compatibility with an ambiguous API, and as such is ugly. So it's better
      to conceal it to its own method.

      It does not preserve backward compatibility for:
        'sort-on' parameter
        'sort-on' property
        'sort-order' parameter
        'sort-order' property
    """
    order_by_list = []
    append = order_by_list.append
    if sort_on is not None:
      if order_by_expression is not None:
2082
        LOG('SQLCatalog', WARNING, 'order_by_expression (%r) and sort_on (%r) were given. Ignoring order_by_expression.' % (order_by_expression, sort_on))
2083 2084 2085 2086 2087
      if not isinstance(sort_on, (tuple, list)):
        sort_on = [[sort_on]]
      for item in sort_on:
        if isinstance(item, (tuple, list)):
          item = list(item)
2088
        else:
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
          item = [item]
        if sort_order is not None and len(item) == 1:
          item.append(sort_order)
        if len(item) > 1:
          if item[1] in ('descending', 'reverse', 'DESC'):
            item[1] = 'DESC'
          else:
            item[1] = 'ASC'
          if len(item) > 2:
            if item[2] == 'int':
              item[2] = 'SIGNED'
        append(item)
    elif order_by_expression is not None:
      if not isinstance(order_by_expression, basestring):
        raise TypeError, 'order_by_expression must be a basestring instance. Got %r.' % (order_by_expression, )
      order_by_list = [[x.strip()] for x in order_by_expression.split(',')]
    return order_by_list

  @profiler_decorator
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
                          ignore_empty_string=1, only_group_columns=False,
2110
                          limit=None, extra_column_list=(),
2111
                          **kw):
2112
    group_by_list = kw.pop('group_by_list', kw.pop('group_by', kw.pop('group_by_expression', ())))
2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140
    if isinstance(group_by_list, basestring):
      group_by_list = [x.strip() for x in group_by_list.split(',')]
    select_dict = kw.pop('select_dict', kw.pop('select_list', kw.pop('select_expression', None)))
    if isinstance(select_dict, basestring):
      if len(select_dict):
        real_select_dict = {}
        for column in select_dict.split(','):
          index = column.lower().find(' as ')
          if index != -1:
            real_select_dict[column[index + 4:].strip()] = column[:index].strip()
          else:
            real_select_dict[column.strip()] = None
        select_dict = real_select_dict
      else:
        select_dict = None
    elif isinstance(select_dict, (list, tuple)):
      select_dict = dict([(x, None) for x in select_dict])
    # Handle order_by_list
    order_by_list = kw.pop('order_by_list', None)
    sort_on = kw.pop('sort_on', None)
    sort_order = kw.pop('sort_order', None)
    order_by_expression = kw.pop('order_by_expression', None)
    if order_by_list is None:
      order_by_list = self.buildOrderByList(
        sort_on=sort_on,
        sort_order=sort_order,
        order_by_expression=order_by_expression
      )
2141
    else:
2142
      if sort_on is not None:
2143
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_on were given, ignoring sort_on.')
2144
      if sort_order is not None:
2145
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_order were given, ignoring sort_order.')
2146
      if order_by_expression is not None:
2147
        LOG('SQLCatalog', WARNING, 'order_by_list and order_by_expression were given, ignoring order_by_expression.')
2148 2149 2150 2151 2152
    # Handle from_expression
    from_expression = kw.pop('from_expression', None)
    # Handle where_expression
    where_expression = kw.get('where_expression', None)
    if isinstance(where_expression, basestring) and len(where_expression):
2153
      LOG('SQLCatalog', INFO, 'Giving where_expression a string value is deprecated.')
2154 2155 2156 2157 2158 2159
      # Transform given where_expression into a query, and update kw.
      kw['where_expression'] = SQLQuery(where_expression)
    # Handle select_expression_key
    # It is required to support select_expression_key parameter for backward
    # compatiblity, but I'm not sure if there can be a serious use for it in
    # new API.
2160
    order_by_override_list = kw.pop('select_expression_key', ())
2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
    query = EntireQuery(
      query=self.buildQuery(kw, ignore_empty_string=ignore_empty_string),
      order_by_list=order_by_list,
      order_by_override_list=order_by_override_list,
      group_by_list=group_by_list,
      select_dict=select_dict,
      limit=limit,
      catalog_table_name=query_table,
      extra_column_list=extra_column_list,
      from_expression=from_expression)
    result = query.asSQLExpression(self, only_group_columns).asSQLExpressionDict()
    return result
2173

2174 2175 2176
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog._getSearchKeyDict')
  @profiler_decorator
  @caching_class_method_decorator(id='SQLCatalog._getSearchKeyDict', cache_factory='erp5_content_long')
  @profiler_decorator
  def _getSearchKeyDict(self):
    result = {}
    search_key_column_dict = {
      'KeywordKey': self.sql_catalog_keyword_search_keys,
      'FullTextKey': self.sql_catalog_full_text_search_keys,
      'DateTimeKey': self.sql_catalog_datetime_search_keys,
    }
    for key, column_list in search_key_column_dict.iteritems():
      for column in column_list:
        if column in result:
2192
          LOG('SQLCatalog', WARNING, 'Ambiguous configuration: column %r is set to use %r key, but also to use %r key. Former takes precedence.' % (column, result[column], key))
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
        else:
          result[column] = key
    return result

  @profiler_decorator
  def getSearchKey(self, column, search_key=None):
    """
      Return an instance of a SearchKey class.

      column (string)
        The column for which the search key will be returned.
      search_key (string)
        If given, must be the name of a SearchKey class to be returned.
        Returned value will be an instance of that class, even if column has
        been configured to use a different one.
    """
    if search_key is None:
      search_key = self._getSearchKeyDict().get(column, 'DefaultKey')
    return getSearchKeyInstance(search_key, column)

  def getComparisonOperator(self, operator):
    """
      Return an instance of an Operator class.

      operator (string)
        String defining the expected operator class.
        See Operator module to have a list of available operators.
    """
    return getComparisonOperatorInstance(operator)

  @profiler_decorator
  def _queryResults(self, REQUEST=None, build_sql_query_method=None, **kw):
2225
    """ Returns a list of brains from a set of constraints on variables """
2226 2227 2228
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2229 2230 2231 2232 2233 2234 2235 2236 2237
    # XXX: decide if this should be made normal
    ENFORCE_SEPARATION = True
    if ENFORCE_SEPARATION:
      new_kw = {}
      # Some parameters must be propagated:
      for parameter_id in ('selection_domain', 'selection_report'):
        if parameter_id in kw:
          new_kw[parameter_id] = kw[parameter_id]
      kw = new_kw
2238 2239 2240
    kw['where_expression'] = query['where_expression']
    kw['sort_on'] = query['order_by_expression']
    kw['from_table_list'] = query['from_table_list']
2241
    kw['from_expression'] = query['from_expression']
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2242
    kw['limit_expression'] = query['limit_expression']
2243
    kw['select_expression'] = query['select_expression']
2244
    kw['group_by_expression'] = query['group_by_expression']
2245
    return kw
2246

2247 2248 2249
  def queryResults(self, sql_method, REQUEST=None, src__=0, build_sql_query_method=None, **kw):
    sql_kw = self._queryResults(REQUEST=REQUEST, build_sql_query_method=build_sql_query_method, **kw)
    return sql_method(src__=src__, **sql_kw)
Ivan Tyagov's avatar
Ivan Tyagov committed
2250
      
2251
  def searchResults(self, REQUEST=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2252
    """ Returns a list of brains from a set of constraints on variables """
2253
    method = getattr(self, self.sql_search_results)
2254
    return self.queryResults(method, REQUEST=REQUEST, extra_column_list=self.getCatalogSearchResultKeys(), **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2255 2256 2257

  __call__ = searchResults

2258
  def countResults(self, REQUEST=None, **kw):
2259
    """ Returns the number of items which satisfy the where_expression """
2260 2261
    # Get the search method
    method = getattr(self, self.sql_count_results)
2262
    return self.queryResults(method, REQUEST=REQUEST, extra_column_list=self.getCatalogSearchResultKeys(), only_group_columns=True, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2263

2264
  def recordObjectList(self, path_list, catalog=1):
2265
    """
2266
      Record the path of an object being catalogged or uncatalogged.
2267
    """
2268 2269
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2270

2271
  def deleteRecordedObjectList(self, uid_list=()):
2272 2273 2274 2275
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2276
    method(uid_list=uid_list)
2277

2278
  def readRecordedObjectList(self, catalog=1):
2279 2280 2281 2282
    """
      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)
2283
    return method(catalog=catalog)
Ivan Tyagov's avatar
Ivan Tyagov committed
2284
   
2285 2286 2287 2288 2289 2290 2291 2292
  # 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:
2293
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2294

2295 2296 2297 2298
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2299

2300
      for id in method_id_list:
2301 2302 2303
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2304 2305 2306 2307 2308
          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"

2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328
        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]
2329
          if isinstance(list_type, str):
2330 2331 2332 2333 2334
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2335 2336 2337 2338 2339 2340 2341 2342 2343
        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'] = ""

2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
    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
2354
      if getattr(aq_base(self), 'filter_dict', None) is None:
2355 2356
        self.filter_dict = PersistentMapping()
        return 0
2357
      try:
2358
        return self.filter_dict[method_name]['filtered']
2359 2360
      except KeyError:
        return 0
2361 2362 2363
    return 0

  def getExpression(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2364
    """ Get the filter expression text for this method.
2365 2366
    """
    if withCMF:
2367
      if getattr(aq_base(self), 'filter_dict', None) is None:
2368 2369
        self.filter_dict = PersistentMapping()
        return ""
2370
      try:
2371
        return self.filter_dict[method_name]['expression']
2372 2373
      except KeyError:
        return ""
2374 2375
    return ""

2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
  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 ""

2390
  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2391
    """ Get the filter expression instance for this method.
2392 2393
    """
    if withCMF:
2394
      if getattr(aq_base(self), 'filter_dict', None) is None:
2395 2396
        self.filter_dict = PersistentMapping()
        return None
2397
      try:
2398
        return self.filter_dict[method_name]['expression_instance']
2399 2400
      except KeyError:
        return None
2401 2402
    return None

Jérome Perrin's avatar
Jérome Perrin committed
2403 2404
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2405 2406
    """
    if withCMF:
2407
      if getattr(aq_base(self), 'filter_dict', None) is None:
2408 2409
        self.filter_dict = PersistentMapping()
        return 0
2410 2411 2412 2413
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2414 2415
    return 0

2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
  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 []
2429 2430 2431 2432 2433 2434 2435

  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2436 2437 2438 2439
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
      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,
2454 2455 2456 2457
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
2458 2459 2460 2461 2462 2463 2464 2465 2466
            # 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,
2467 2468 2469 2470 2471 2472
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

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

2475 2476
from Query.Query import Query as _Query
from Query.SimpleQuery import SimpleQuery
Ivan Tyagov's avatar
Ivan Tyagov committed
2477
from Query.ComplexQuery import ComplexQuery
2478 2479 2480
from Query.AutoQuery import AutoQuery as Query

def NegatedQuery(query):
2481
  return ComplexQuery(query, logical_operator='not')
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526

allow_class(SimpleQuery)
allow_class(ComplexQuery)

import SearchKey
SEARCH_KEY_INSTANCE_POOL = {}
SEARCH_KEY_CLASS_CACHE = {}

@profiler_decorator
def getSearchKeyInstance(search_key_class_name, column):
  assert isinstance(search_key_class_name, basestring)
  try:
    search_key_class = SEARCH_KEY_CLASS_CACHE[search_key_class_name]
  except KeyError:
    search_key_class = getattr(getattr(SearchKey, search_key_class_name),
                               search_key_class_name)
    SEARCH_KEY_CLASS_CACHE[search_key_class_name] = search_key_class
  try:
    instance_dict = SEARCH_KEY_INSTANCE_POOL[search_key_class]
  except KeyError:
    instance_dict = SEARCH_KEY_INSTANCE_POOL[search_key_class] = {}
  try:
    result = instance_dict[column]
  except KeyError:
    result = instance_dict[column] = search_key_class(column)
  return result

from Operator import operator_dict
def getComparisonOperatorInstance(operator):
  return operator_dict[operator]

from Query.EntireQuery import EntireQuery
from Query.SQLQuery import SQLQuery

verifyClass(ISearchKeyCatalog, Catalog)

if PROFILING_ENABLED:
  def Catalog_dumpProfilerData(self):
    return profiler_report()

  def Catalog_resetProfilerData(self):
    profiler_reset()

  Catalog.dumpProfilerData = Catalog_dumpProfilerData
  Catalog.resetProfilerData = Catalog_resetProfilerData
2527