SQLCatalog.py 109 KB
Newer Older
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3
##############################################################################
#
4
# Copyright (c) 2002-2009 Nexedi SARL. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15
# 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
#
##############################################################################

16
from Persistence import Persistent, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
17 18
import Acquisition
import ExtensionClass
19
import OFS.History
20 21
from App.class_init import default__class_init__ as InitializeClass
from App.special_dtml import DTMLFile
22
from thread import allocate_lock, get_ident
23
from OFS.Folder import Folder
24
from AccessControl import ClassSecurityInfo
25
from AccessControl.Permissions import access_contents_information, \
26
    import_export_objects, manage_zcatalog_entries
27
from AccessControl.SimpleObjectPolicies import ContainerAssertions
28
from BTrees.OIBTree import OIBTree
29 30
from App.config import getConfiguration
from BTrees.Length import Length
31
from Shared.DC.ZRDB.DA import DatabaseError
32
from Shared.DC.ZRDB.TM import TM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
33

34
from Acquisition import aq_parent, aq_inner, aq_base
35
from zLOG import LOG, WARNING, INFO, TRACE, ERROR
36
from ZODB.POSException import ConflictError
37
from Products.CMFCore import permissions
38
from Products.PythonScripts.Utility import allow_class
Jean-Paul Smets's avatar
Jean-Paul Smets committed
39 40

import time
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41
import sys
42 43
import urllib
import string
44
import pprint
45 46
import re
import warnings
47
from contextlib import contextmanager
48
from cStringIO import StringIO
49
from xml.dom.minidom import parse
50
from xml.sax.saxutils import escape, quoteattr
51
import os
52
from hashlib import md5
53

54
from interfaces.query_catalog import ISearchKeyCatalog
55 56
from zope.interface.verify import verifyClass
from zope.interface import implements
57

58
from SearchText import isAdvancedSearchText, dequote
59

60 61 62 63
# Try to import ActiveObject in order to make SQLCatalog active
try:
  from Products.CMFActivity.ActiveObject import ActiveObject
except ImportError:
64
  ActiveObject = ExtensionClass.Base
65

66 67 68 69
try:
  from Products.CMFCore.Expression import Expression
  from Products.PageTemplates.Expressions import getEngine
  from Products.CMFCore.utils import getToolByName
70
  new_context_search = re.compile(r'\bcontext\b').search
71 72 73 74
  withCMF = 1
except ImportError:
  withCMF = 0

75 76 77 78
try:
  import psyco
except ImportError:
  psyco = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
79

80 81 82
@contextmanager
def noReadOnlyTransactionCache():
  yield
83
try:
84
  from Products.ERP5Type.Cache import \
85
    readOnlyTransactionCache
86
except ImportError:
Arnaud Fontaine's avatar
Arnaud Fontaine committed
87
  LOG('SQLCatalog', WARNING, 'Count not import readOnlyTransactionCache, expect slowness.')
88
  readOnlyTransactionCache = noReadOnlyTransactionCache
89 90 91 92

try:
  from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
except ImportError:
93
  LOG('SQLCatalog', WARNING, 'Count not import getTransactionalVariable, expect slowness.')
94
  def getTransactionalVariable():
95 96
    return {}

97 98
def getInstanceID(instance):
  # XXX: getPhysicalPath is overkill for a unique cache identifier.
99 100 101
  # What I would like to use instead of it is:
  #   (self._p_jar.db().database_name, self._p_oid)
  # but database_name is not unique in at least ZODB 3.4 (Zope 2.8.8).
102 103 104 105 106
  try:
    instance_id = instance._v_physical_path
  except AttributeError:
    instance._v_physical_path = instance_id = instance.getPhysicalPath()
  return instance_id
107 108 109

def generateCatalogCacheId(method_id, self, *args, **kwd):
  return str((method_id, self.getCacheSequenceNumber(), getInstanceID(self),
Julien Muchembled's avatar
Julien Muchembled committed
110
    args, kwd))
111

112 113 114 115 116 117 118 119 120 121
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):
122
      transactional_cache = getTransactionalVariable()
123
      cache_id = str((self.cache_id,
124
        wrapped_self.getCacheSequenceNumber(),
125 126
        getInstanceID(wrapped_self),
      ))
127
      try:
128
        result = transactional_cache[cache_id]
129
      except KeyError:
130 131
        result = transactional_cache[cache_id] = method(wrapped_self)
      return result
132 133
    return wrapper

134
list_type_list = list, tuple, set, frozenset
135 136 137 138
try:
  from ZPublisher.HTTPRequest import record
except ImportError:
  dict_type_list = (dict, )
139 140
else:
  dict_type_list = (dict, record)
141 142


143
UID_BUFFER_SIZE = 300
144
OBJECT_LIST_SIZE = 300 # XXX 300 is arbitrary value of catalog object list
145
MAX_PATH_LEN = 255
146
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
147 148
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report',
                     'extra_key_list', )
149

150
valid_method_meta_type_list = ('Z SQL Method', 'LDIF Method', 'Script (Python)') # Nicer
151

152
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
153

154 155 156 157 158
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

159
def manage_addSQLCatalog(self, id, title,
160
             vocab_id='create_default_catalog_', # vocab_id is a strange name - not abbreviation
161 162 163
             REQUEST=None):
  """Add a Catalog object
  """
164 165 166
  id = str(id)
  title = str(title)
  vocab_id = str(vocab_id)
167 168 169
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

170
  c = Catalog(id, title, self)
171 172 173 174
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

175 176
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
177

Yoshinori Okuji's avatar
Yoshinori Okuji committed
178
  def __init__(self):
179
    """Initialize some variables.
180

181
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
182

183
      finished_buffer is used to hold reserved uids created by committed-transactions.
184

185
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
186
      invalid afterwards, so they may not be used by other transactions."""
187 188
    self.temporary_buffer = {}
    self.finished_buffer = []
189

190 191 192 193 194 195 196 197
  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
198

199 200 201 202 203 204 205
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
206

207 208 209 210 211 212 213 214
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
215

216 217 218 219 220 221 222 223 224 225 226
  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
227

228 229 230 231
  def pop(self):
    self._register()
    tid = get_ident()
    try:
232
      uid = self.temporary_buffer[tid].pop()
233
    except (KeyError, IndexError):
234 235
      uid = self.finished_buffer.pop()
    return uid
236

237 238 239
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
240
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
241

242 243 244 245
class DummyDict(dict):
  def __setitem__(self, key, value):
    pass

246 247 248 249 250 251 252 253 254 255 256 257
class LazyIndexationParameterList(tuple):
  def __new__(cls, document_list, attribute, global_cache):
    self = super(LazyIndexationParameterList, cls).__new__(cls)
    self._document_list = document_list
    self._attribute = attribute
    self._global_cache = global_cache
    return self

  def __getitem__(self, index):
    document = self._document_list[index]
    attribute = self._attribute
    global_cache_key = (document.uid, attribute)
258 259 260
    try:
      value = self._global_cache[global_cache_key]
    except KeyError:
261 262 263 264 265 266 267 268 269 270 271 272
      value = getattr(document, attribute, None)
      if callable(value):
        try:
          value = value()
        except ConflictError:
          raise
        except Exception:
          LOG('SQLCatalog', WARNING,
            'Failed to call method %s on %r' % (attribute, document),
            error=True,
          )
          value = None
273
      self._global_cache[global_cache_key] = value
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
    return value

  def __iter__(self):
    for index in xrange(len(self)):
      yield self[index]

  def __len__(self):
    return len(self._document_list)

  def __repr__(self):
    return '<%s(%i documents, %r) at %x>' % (self.__class__.__name__,
      len(self), self._attribute, id(self))

ContainerAssertions[LazyIndexationParameterList] = 1

289
related_key_warned_column_set = set()
290

291 292 293
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
294
              ActiveObject,
295
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
296 297 298 299
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
300
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
301 302 303 304 305 306 307 308

  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

309 310
  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.
311 312 313
  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).
314 315 316
  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
317

318
 """
319

320
  implements(ISearchKeyCatalog)
321

322

323
  meta_type = "SQLCatalog"
324
  icon = 'misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
  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'),}
354
    ) + OFS.History.Historical.manage_options
355

356
  __ac_permissions__= (
357 358

    ('Manage ZCatalog Entries',
359
     ['manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
360 361
      'manage_catalogFilter',
      'manage_catalogAdvanced',
362
      'manage_main',],
363 364 365 366
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
367 368
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
369
      'getFilterableMethodList',],
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
     ['Anonymous', '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' },
391 392 393 394 395
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
396 397 398 399 400
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
401 402
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
403 404 405 406 407 408 409 410
      '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' },
411 412 413
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
414 415
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
416 417 418
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
419 420
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
421 422
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
423 424 425
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
426
    { 'id'      : 'sql_record_object_list',
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
      '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
446 447 448 449 450
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    { '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' },
476 477 478 479 480
    { 'id'      : 'sql_optimizer_switch',
      'description': 'Method to get optimizer_switch value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
481 482
    { 'id'      : 'sql_catalog_schema',
      'description' : 'Method to get the main catalog schema',
483 484 485
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
486
    { 'id'      : 'sql_catalog_multi_schema',
487 488 489 490
      'description' : 'Method to get the main catalog schema',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
491 492 493 494 495
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
496 497 498 499 500 501 502 503 504 505
    { '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' },
506 507 508 509 510
    { 'id': 'sql_catalog_search_keys',
      'title': 'Search Key Mappings',
      'description': 'A list of Search Key mappings',
      'type': 'lines',
      'mode': 'w' },
511
    { 'id'      : 'sql_catalog_keyword_search_keys',
512
      'description' : 'Columns which should be considered as keyword search',
513 514 515
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
516
    { 'id'      : 'sql_catalog_datetime_search_keys',
517
      'description' : 'Columns which should be considered as datetime search',
518 519 520
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
    { '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' },
536 537 538 539 540
    { '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' },
541 542 543 544 545 546 547 548 549
    { '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' },
550 551 552 553 554
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
555 556 557 558 559 560 561 562 563 564 565
    { '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' },
566 567 568 569 570 571 572 573
    { 'id': 'sql_catalog_security_uid_columns',
      'title': 'Security Uid Columns',
      'description': 'A list of mappings "local_roles_group_id | security_uid_column"'
                     ' local_roles_group_id will be the name of a local roles'
                     ' group, and security_uid_column is the corresponding'
                     ' column in catalog table',
      'type': 'lines',
      'mode': 'w' },
574 575 576 577 578 579
    { 'id': 'sql_catalog_table_vote_scripts',
      'title': 'Table vote scripts',
      'description': 'Scripts helping column mapping resolution',
      'type': 'multiple selection',
      'select_variable' : 'getPythonMethodIds',
      'mode': 'w' },
580 581 582 583 584 585
    { 'id': 'sql_catalog_raise_error_on_uid_check',
      'title': 'Raise error on UID check',
      'description': 'Boolean used to tell if we raise error when uid check fail',
      'type': 'boolean',
      'default' : True,
      'mode': 'w' },
586

587 588
  )

589
  sql_catalog_produce_reserved = ''
590
  sql_catalog_delete_uid = ''
591 592 593 594 595 596 597 598 599 600 601
  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
602
  sql_search_security = ''
603 604 605
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
606
  sql_optimizer_switch = ''
607 608
  sql_search_tables = ()
  sql_catalog_schema = ''
609
  sql_catalog_multi_schema = ''
610
  sql_catalog_index = ''
611 612
  sql_unique_values = ''
  sql_catalog_paths = ''
613
  sql_catalog_search_keys = ()
614
  sql_catalog_keyword_search_keys =  ()
615
  sql_catalog_datetime_search_keys = ()
616 617 618 619 620
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
621
  sql_catalog_index_on_order_keys = ()
622
  sql_catalog_related_keys = ()
623
  sql_catalog_scriptable_keys = ()
624 625
  sql_catalog_role_keys = ()
  sql_catalog_local_role_keys = ()
626
  sql_catalog_security_uid_columns = (' | security_uid',)
627
  sql_catalog_table_vote_scripts = ()
628
  sql_catalog_raise_error_on_uid_check = True
629

630 631 632 633 634 635
  # 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
636

637 638 639 640 641 642 643
  # 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
644

645 646 647 648 649
  manage_catalogView = DTMLFile('dtml/catalogView',globals())
  manage_catalogFilter = DTMLFile('dtml/catalogFilter',globals())
  manage_catalogFind = DTMLFile('dtml/catalogFind',globals())
  manage_catalogAdvanced = DTMLFile('dtml/catalogAdvanced', globals())

650 651
  _cache_sequence_number = 0

652 653 654 655 656
  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
657 658 659
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
660
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
661

662 663 664 665 666 667 668
  def manage_afterClone(self, item):
    try:
      del self._v_physical_path
    except AttributeError:
      pass
    super(Catalog, self).manage_afterClone(item)

669
  security.declarePrivate('getCacheSequenceNumber')
670 671 672 673 674 675
  def getCacheSequenceNumber(self):
    return self._cache_sequence_number

  def _clearCaches(self):
    self._cache_sequence_number += 1

676
  security.declarePrivate('getSQLCatalogRoleKeysList')
677 678 679 680
  def getSQLCatalogRoleKeysList(self):
    """
    Return the list of role keys.
    """
681 682 683 684 685
    role_key_dict = {}
    for role_key in self.sql_catalog_role_keys:
      role, column = role_key.split('|')
      role_key_dict[role.strip()] = column.strip()
    return role_key_dict.items()
686

687
  security.declareProtected(permissions.ManagePortal, 'getSQLCatalogSecurityUidGroupsColumnsDict')
688 689 690 691 692 693 694 695 696 697 698 699
  def getSQLCatalogSecurityUidGroupsColumnsDict(self):
    """
    Return a mapping of local_roles_group_id name to the name of the column
    storing corresponding security_uid.
    The default mappiny is {'': 'security_uid'}
    """
    local_roles_group_id_dict = {}
    for local_roles_group_id_key in self.sql_catalog_security_uid_columns:
      local_roles_group_id, column = local_roles_group_id_key.split('|')
      local_roles_group_id_dict[local_roles_group_id.strip()] = column.strip()
    return local_roles_group_id_dict

700
  security.declarePrivate('getSQLCatalogLocalRoleKeysList')
701 702 703 704
  def getSQLCatalogLocalRoleKeysList(self):
    """
    Return the list of local role keys.
    """
705 706 707 708
    local_role_key_dict = {}
    for role_key in self.sql_catalog_local_role_keys:
      role, column = role_key.split('|')
      local_role_key_dict[role.strip()] = column.strip()
709
    return local_role_key_dict.items()
710

711
  security.declareProtected(import_export_objects, 'manage_exportProperties')
712 713 714 715 716 717
  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')
718 719 720 721 722 723 724 725
    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
726
    property_list.sort(key=lambda x: x[0])
727 728 729
    for property in property_list:
      property_id = property[0]
      value       = property[1]
730
      if isinstance(value, basestring):
731
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
732
      elif isinstance(value, (tuple, list)):
733 734 735
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
736
        for item in value:
737
          if isinstance(item, basestring):
738 739 740 741
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
742
        f.write('  </property>\n')
743 744 745
    # 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'):
746 747
      filter_list = []
      for filter_id in self.filter_dict.keys():
748
        filter_definition = self.filter_dict[filter_id]
749 750
        filter_list.append((filter_id, filter_definition))
      # Sort for easy diff
751
      filter_list.sort(key=lambda x: x[0])
752 753 754 755
      for filter_item in filter_list:
        filter_id  = filter_item[0]
        filter_def = filter_item[1]
        if not filter_def['filtered']:
756 757
          # If a filter is not activated, no need to output it.
          continue
758
        if not filter_def['expression']:
759 760
          # If the expression is not specified, meaningless to specify it.
          continue
761
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
762
        # For now, portal types are not exported, because portal types are too specific to each site.
763 764 765 766 767 768 769 770
    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()

771
  security.declareProtected(import_export_objects, 'manage_importProperties')
772 773 774 775
  def manage_importProperties(self, file):
    """
      Import properties from an XML file.
    """
776
    with open(file) as f:
777 778 779 780 781 782 783
      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):
784
            raise CatalogError, 'unknown property id %r' % (id,)
785
          if type not in ('str', 'tuple'):
786
            raise CatalogError, 'unknown property type %r' % (type,)
787 788 789 790
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
791
                value = str(text.data)
792 793 794 795 796 797
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
798
                raise CatalogError, 'unknown item type %r' % (item_type,)
799 800
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
801
                  value.append(str(text.data))
802 803 804 805
                  break
            value = tuple(value)

          setattr(self, id, value)
806

807 808 809
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
810
          id = str(filt.getAttribute("id"))
811 812 813 814 815 816 817 818 819 820 821 822
          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
823 824
      finally:
        doc.unlink()
Aurel's avatar
Aurel committed
825

826
  security.declareProtected(manage_zcatalog_entries, 'manage_historyCompare')
827 828 829 830 831 832 833
  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__)))
834 835 836

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
837
    self.security_uid_index = None
838

839 840 841 842
  def _clearSubjectCache(self):
    self.subject_set_uid_dict = OIBTree()
    self.subject_set_uid_index = None

843 844
  security.declarePrivate('getSecurityUidDict')
  def getSecurityUidDict(self, wrapped_object):
845
    """
846 847
    returns a tuple with a dict of security uid by local group id, and a tuple
    containing optimised_roles_and_users that might have been created.
848
    """
849
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
850
      self._clearSecurityCache()
851 852

    optimised_roles_and_users = []
853
    local_roles_group_id_to_security_uid_mapping = {}
854 855

    # Get security information
856 857 858
    security_uid = None
    for key in wrapped_object.getLocalRolesGroupIdDict().iteritems():
      local_roles_group_id, allowed_roles_and_users = key
859
      if key in self.security_uid_dict:
860 861
        local_roles_group_id_to_security_uid_mapping[local_roles_group_id] \
                = self.security_uid_dict[key]
862
      elif allowed_roles_and_users in self.security_uid_dict \
863 864 865 866 867 868 869
           and not local_roles_group_id:
        # This key is present in security_uid_dict without
        # local_roles_group_id, it has been inserted before
        # local_roles_group_id were introduced.
        local_roles_group_id_to_security_uid_mapping[local_roles_group_id] = \
          self.security_uid_dict[allowed_roles_and_users]
      else:
870 871 872 873 874 875 876 877 878 879 880
        if not security_uid:
          getTransactionalVariable().pop('getSecurityUidDictAndRoleColumnDict',
                                         None)
          id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
          # We must keep compatibility with existing sites
          security_uid = getattr(self, 'security_uid_index', None)
          if security_uid is None:
            security_uid = 0
          # At some point, it was a Length
          elif isinstance(security_uid, Length):
            security_uid = security_uid()
881 882 883 884
        # 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
885
        security_uid += 1
886 887
        if id_tool is not None:
          security_uid = int(id_tool.generateNewId(id_generator='uid',
888
              id_group='security_uid_index', default=security_uid))
889
        else:
890 891 892 893 894 895 896 897 898 899 900 901
          self.security_uid_index = security_uid

        self.security_uid_dict[key] = security_uid
        local_roles_group_id_to_security_uid_mapping[local_roles_group_id]\
            = security_uid

        # If some optimised_roles_and_users are returned by this method it
        # means that new entries will have to be added to roles_and_users table.
        for user in allowed_roles_and_users:
          optimised_roles_and_users.append((security_uid, local_roles_group_id, user))

    return (local_roles_group_id_to_security_uid_mapping, optimised_roles_and_users)
902

903
  security.declarePrivate('getRoleAndSecurityUidList')
904 905
  def getRoleAndSecurityUidList(self):
    """
906
      Return a list of 3-tuples, suitable for direct use in a zsqlmethod.
907 908 909
      Goal: make it possible to regenerate a table containing this data.
    """
    result = []
910 911
    for role_list, security_uid in getattr(
            aq_base(self), 'security_uid_dict', {}).iteritems():
912 913 914 915 916 917 918
      if role_list:
        if isinstance(role_list[-1], tuple):
          local_role_group_id, role_list = role_list
        else:
          local_role_group_id = ''
        result += [(local_role_group_id, role, security_uid)
                  for role in role_list]
919 920
    return result

921 922 923 924 925 926 927 928 929 930 931 932 933
  security.declarePrivate('getSubjectSetUid')
  def getSubjectSetUid(self, wrapped_object):
    """
    Cache a uid for each unique subject tuple.
    Return a tuple with a subject uid (string) and a new subject tuple
    if not exist already.
    """
    getSubjectList = getattr(wrapped_object, 'getSubjectList', None)
    if getSubjectList is None:
      return (None, None)
    # Get subject information
    # XXX if more collation is available, we can have smaller number of
    # unique subject sets.
934
    subject_list = tuple(sorted({(x or '').lower() for x in getSubjectList()}))
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
    if not subject_list:
      return (None, None)
    # Make sure no duplicates
    if getattr(aq_base(self), 'subject_set_uid_dict', None) is None:
      self._clearSubjectCache()
    elif self.subject_set_uid_dict.has_key(subject_list):
      return (self.subject_set_uid_dict[subject_list], None)
    # If the id_tool is there, it is better to use it, it allows
    # to create many new subject 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
      previous_subject_set_uid = getattr(self, 'subject_set_uid_index', None)
      if previous_subject_set_uid is not None:
        default = previous_subject_set_uid
      subject_set_uid = int(id_tool.generateNewId(id_generator='uid',
          id_group='subject_set_uid_index', default=default))
    else:
      previous_subject_set_uid = getattr(self, 'subject_set_uid_index', None)
      if previous_subject_set_uid is None:
        previous_subject_set_uid = 0
      subject_set_uid = previous_subject_set_uid + 1
      self.subject_set_uid_index = subject_set_uid
    self.subject_set_uid_dict[subject_list] = subject_set_uid
    return (subject_set_uid, subject_list)

964
  def _clear(self):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
965 966 967 968 969
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
970
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
971 972
      try:
        method()
973 974
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
975
      except:
976
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
977
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
978
        raise
979

980
    # Reserved uids have been removed.
981
    self._clearReserved()
982

983 984 985 986
    id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
    if id_tool is None:
      # Add a dummy item so that SQLCatalog will not use existing uids again.
      self.insertMaxUid()
987

988
    self._clearSecurityCache()
989
    self._clearSubjectCache()
990
    self._clearCaches()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
991

992
  security.declarePrivate('insertMaxUid')
993 994 995 996 997 998 999 1000 1001 1002
  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()])

1003
  def _clearReserved(self):
1004 1005 1006 1007 1008
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
Romain Courteaud's avatar
Romain Courteaud committed
1009 1010 1011 1012 1013
    try:
      method()
    except ConflictError:
      raise
    except:
1014
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
1015 1016 1017
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
1018
    self._last_clear_reserved_time += 1
1019

1020
  security.declarePrivate('getRecordForUid')
1021
  def getRecordForUid(self, uid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1022 1023 1024 1025
    """
    Get an object by UID
    Note: brain is defined in Z SQL Method object
    """
1026
    # this method used to be __getitem__(self, uid) but was found to hurt more
1027
    # than it helped: It would be inadvertently called by
1028 1029 1030 1031 1032 1033
    # (un)restrictedTraverse and if there was any error in rendering the SQL
    # expression or contacting the database, an error different from KeyError
    # would be raised, causing confusion.
    # It could also have a performance impact for traversals to objects in
    # the acquisition context on Zope 2.12 even when it didn't raise a weird
    # error.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1034 1035 1036 1037
    method = getattr(self,  self.sql_getitem_by_uid)
    search_result = method(uid = uid)
    if len(search_result) > 0:
      return search_result[0]
1038
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1039

1040
  security.declarePrivate('editSchema')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
  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

1060
  security.declarePrivate('getCatalogSearchTableIds')
1061 1062 1063 1064
  def getCatalogSearchTableIds(self):
    """Return selected tables of catalog which are used in JOIN.
       catalaog is always first
    """
1065 1066 1067 1068 1069 1070
    search_tables = list(self.sql_search_tables) or ['catalog']
    if search_tables[0] != 'catalog':
      search_tables = ['catalog'] + [x for x in search_tables if x != 'catalog']
      # XXX: cast to tuple to avoid a mutable persistent property ?
      self.sql_search_tables = search_tables
    return search_tables
1071

1072
  security.declarePublic('getCatalogSearchResultKeys')
1073 1074 1075 1076
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
1077

1078 1079 1080
  @transactional_cache_decorator('SQLCatalog._getCatalogSchema')
  def _getCatalogSchema(self):
    method = getattr(self, self.sql_catalog_multi_schema, None)
1081
    result = {}
1082 1083
    if method is None:
      # BBB: deprecated
1084 1085 1086 1087
      warnings.warn("The usage of sql_catalog_schema is much slower. "
              "than sql_catalog_multi_schema. It makes many SQL queries "
              "instead of one",
              DeprecationWarning)
1088
      method_name = self.sql_catalog_schema
1089
      try:
1090 1091 1092
        method = getattr(self, method_name)
      except AttributeError:
        return {}
1093
      for table in self.getCatalogSearchTableIds():
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
        try:
          result[table] = [c.Field for c in method(table=table)]
        except (ConflictError, DatabaseError):
          raise
        except Exception:
          LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s'
            % method_name, error=sys.exc_info())
      return result
    for row in method():
      result.setdefault(row.TABLE_NAME, []).append(row.COLUMN_NAME)
    return result
1105

1106 1107 1108 1109 1110 1111 1112
  security.declarePrivate('getTableColumnList')
  def getTableColumnList(self, table):
    """
    Returns the list of columns in given table.
    Raises KeyError on unknown table.
    """
    return self._getCatalogSchema()[table]
1113

1114
  security.declarePrivate('getColumnIds')
1115
  @transactional_cache_decorator('SQLCatalog.getColumnIds')
1116 1117 1118 1119 1120
  def getColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1121 1122
    keys = set()
    add_key = keys.add
1123
    table_dict = self._getCatalogSchema()
1124
    for table in self.getCatalogSearchTableIds():
1125
      for field in table_dict[table]:
1126 1127
        add_key(field)
        add_key('%s.%s' % (table, field))  # Is this inconsistent ?
1128 1129
    for related in self.getSQLCatalogRelatedKeyList():
      related_tuple = related.split('|')
1130
      add_key(related_tuple[0].strip())
1131 1132
    for scriptable in self.getSQLCatalogScriptableKeyList():
      scriptable_tuple = scriptable.split('|')
1133 1134
      add_key(scriptable_tuple[0].strip())
    return sorted(keys)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1135

1136
  security.declarePrivate('getColumnMap')
1137
  @transactional_cache_decorator('SQLCatalog.getColumnMap')
1138 1139 1140 1141 1142
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1143
    result = {}
1144
    table_dict = self._getCatalogSchema()
1145
    for table in self.getCatalogSearchTableIds():
1146
      for field in table_dict[table]:
1147 1148 1149
        result.setdefault(field, []).append(table)
        result.setdefault('%s.%s' % (table, field), []).append(table) # Is this inconsistent ?
    return result
1150

1151
  security.declarePrivate('getResultColumnIds')
1152
  @transactional_cache_decorator('SQLCatalog.getResultColumnIds')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1153 1154 1155 1156 1157
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1158
    keys = set()
1159
    table_dict = self._getCatalogSchema()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1160
    for table in self.getCatalogSearchTableIds():
1161
      for field in table_dict[table]:
1162 1163
        keys.add('%s.%s' % (table, field))
    return sorted(keys)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1164

1165
  security.declarePrivate('getSortColumnIds')
1166
  @transactional_cache_decorator('SQLCatalog.getSortColumnIds')
1167 1168 1169 1170 1171
  def getSortColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids that can be used for a sort
    """
1172
    keys = set()
1173
    table_dict = self._getCatalogSchema()
1174
    for table in self.getTableIds():
1175
      for field in table_dict[table]:
1176 1177
        keys.add('%s.%s' % (table, field))
    return sorted(keys)
1178

1179
  security.declarePrivate('getTableIds')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1180 1181 1182
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1183 1184
    Field Ids
    """
1185
    return self._getCatalogSchema().keys()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1186

1187
  security.declarePrivate('getUIDBuffer')
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
  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]
1201

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1202
  # the cataloging API
1203
  security.declarePrivate('produceUid')
1204 1205 1206
  def produceUid(self):
    """
      Produces reserved uids in advance
1207
    """
1208 1209 1210 1211
    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.
1212 1213 1214 1215
    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:
1216 1217 1218
      id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
      if id_tool is not None:
        if self._max_uid is None:
1219
          self._max_uid = Length(1)
1220
        uid_list = id_tool.generateNewIdList(id_generator='uid', id_group='catalog_uid',
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
                     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
1236
        instance_id = md5(str(random_factor_list)).hexdigest()
1237
        uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
1238
      uid_buffer.extend(uid_list)
1239

1240
  security.declarePrivate('isIndexable')
1241 1242 1243 1244 1245 1246
  def isIndexable(self):
    """
    This is required to check in many methods that
    the site root and zope root are indexable
    """
    zope_root = self.getZopeRoot()
1247
    site_root = self.getSiteRoot() # XXX-JPS - Why don't we use getPortalObject here ?
1248 1249 1250 1251 1252 1253

    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
1254

1255
  security.declarePrivate('getSiteRoot')
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
  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

1266
  security.declarePrivate('getZopeRoot')
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
  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

1277
  security.declarePrivate('newUid')
1278 1279 1280
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1281 1282
      with multiple ZEO clients on a single ZEO server.

1283
      The main risk is the following:
1284

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

1287
      - one reindexing node N1 starts reindexing f
1288

1289
      - another reindexing node N2 starts reindexing e
1290

1291 1292 1293
      - 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

1294
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1295
      with the risk of graph loops
1296
    """
1297
    if not self.isIndexable():
1298 1299
      return None

1300 1301 1302 1303
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1304 1305 1306
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1307
        if self._max_uid is None:
1308
          self._max_uid = Length(1)
1309 1310
        if uid > self._max_uid():
          self._max_uid.set(uid)
1311
        return long(uid)
1312 1313 1314 1315
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1316

1317
  security.declareProtected(manage_zcatalog_entries, 'manage_catalogObject')
1318 1319 1320
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1321
      if isinstance(urls, str):
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
        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')

1333
  security.declareProtected(manage_zcatalog_entries, 'manage_uncatalogObject')
1334 1335 1336 1337
  def manage_uncatalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ removes Zope object(s) 'urls' from catalog """

    if urls:
1338
      if isinstance(urls, str):
1339 1340 1341 1342 1343 1344 1345
        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')

1346
  security.declareProtected(manage_zcatalog_entries, 'manage_catalogReindex')
1347
  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1, urls=None):
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
    """ 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`)))

1363
  security.declareProtected(manage_zcatalog_entries, 'manage_catalogClear')
1364
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1365
                          URL1=None, sql_catalog_id=None):
1366
    """ clears the whole enchilada """
1367 1368
    self.beforeCatalogClear()

1369
    self._clear()
1370 1371

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1372
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1373
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1374

1375
  security.declareProtected(manage_zcatalog_entries, 'manage_catalogClearReserved')
1376
  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1377
    """ clears reserved uids """
1378
    self._clearReserved()
1379 1380

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1381
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1382
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1383

1384
  security.declareProtected(manage_zcatalog_entries, 'manage_catalogFoundItems')
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
  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`)))

1421
  security.declarePrivate('catalogObject')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1422
  def catalogObject(self, object, path, is_object_moved=0):
1423 1424
    """Add an object to the Catalog by calling all SQL methods and
    providing needed arguments.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1425

1426 1427
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1428

1429
  security.declarePrivate('catalogObjectList')
1430
  def catalogObjectList(self, object_list, method_id_list=None,
1431 1432 1433
                        disable_cache=0, check_uid=1, idxs=None):
    """Add objects to the Catalog by calling all SQL methods and
    providing needed arguments.
1434

1435 1436
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1437 1438

      disable_cache : do not use cache, so values will be computed each time,
1439 1440 1441 1442 1443 1444
                      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.
1445

1446 1447 1448 1449
    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."""
1450 1451
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1452 1453 1454 1455
                              method_id_list=method_id_list,
                              disable_cache=disable_cache,
                              check_uid=check_uid,
                              idxs=idxs)
1456 1457

  def _catalogObjectList(self, object_list, method_id_list=None,
1458 1459 1460 1461 1462
                         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?"""
1463
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1464
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1465

1466
    if idxs not in (None, []):
1467
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING,
1468
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1469

1470
    if not self.isIndexable():
1471
      return
1472

1473 1474
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
    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)

1493 1494 1495 1496 1497
    # 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 = {}

1498
    for object in object_list:
1499
      uid = getattr(aq_base(object), 'uid', None)
1500 1501
      # Generate unique uid for object having 0 or None as uid
      if uid is None or uid == 0:
1502
        try:
1503
          object.uid = self.newUid()
1504 1505
        except ConflictError:
          raise
1506
        except:
1507
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1508
      elif check_uid:
1509
        if uid in assigned_uid_dict:
1510 1511 1512 1513 1514 1515 1516
            error_message = 'uid of %r is %r and ' \
                  'is already assigned to %s in catalog !!! This can be fatal.' % \
                  (object, uid, assigned_uid_dict[uid])
            if not self.sql_catalog_raise_error_on_uid_check:
                LOG("SQLCatalog.catalogObjectList", ERROR, error_message)
            else:
                raise ValueError(error_message)
1517

1518
        path = object.getPath()
1519
        index = path_uid_dict.get(path)
1520 1521 1522
        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)
1523 1524
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1525 1526 1527 1528 1529 1530
            error_message = 'uid of %r changed from %r (property) to %r '\
	                    '(catalog, by path) !!! This can be fatal' % (object, uid, index)
            if not self.sql_catalog_raise_error_on_uid_check:
              LOG("SQLCatalog.catalogObjectList", ERROR, error_message)
            else:
              raise ValueError(error_message)
1531 1532 1533 1534
        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
1535
          if uid in uid_path_dict:
1536 1537 1538
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1539 1540 1541
          #LOG('catalogObject', 0, 'uid = %r, catalog_path = %r' % (uid, catalog_path))
          if catalog_path == "reserved":
            # Reserved line in catalog table
1542
            lock = self.__class__._reserved_uid_lock
1543
            try:
1544
              lock.acquire()
1545 1546
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1547 1548 1549 1550 1551 1552 1553 1554
                # 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.
1555
                try:
1556
                  uid_buffer.remove(uid)
1557 1558
                except ValueError:
                  pass
1559
            finally:
1560
              lock.release()
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
          elif catalog_path == 'deleted':
            # Two possible cases:
            # - Reindexed object's path changed (ie, it or at least one of its
            #   parents was renamed) but unindexObject was not called yet.
            #   Reindexing is harmelss: unindexObject and then an
            #   immediateReindexObject will be called.
            # - Reindexed object was deleted by a concurrent transaction, which
            #   committed after we got our ZODB snapshot of this object.
            #   Reindexing is harmless: unindexObject will be called, and
            #   cannot be executed in parallel thanks to activity's
            #   serialisation_tag (so we cannot end up with a fantom object in
            #   catalog).
            # So we index object.
            # We could also not index it to save the time needed to index, but
            # this would slow down all regular case to slightly improve an
            # exceptional case.
            pass
1578 1579
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1580
            # can be due to path length
1581
            if len(path) > MAX_PATH_LEN:
1582
              LOG('SQLCatalog', ERROR, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))
1583

1584
            LOG('SQLCatalog', ERROR,
1585 1586
                'uid of %r changed from %r to %r as old one is assigned'
                ' to %s in catalog !!! This can be fatal.' % (
1587 1588 1589 1590 1591 1592 1593 1594 1595
                object, uid, object.uid, catalog_path))

            error_message = 'uid of %r is %r and ' \
                            'is already assigned to %s in catalog !!! This can be fatal.' \
                            % (object, uid, catalog_path)
            if not self.sql_catalog_raise_error_on_uid_check:
                LOG('SQLCatalog', ERROR, error_message)
            else:
                raise ValueError(error_message)
1596 1597 1598
            uid = object.uid

        assigned_uid_dict[uid] = object
1599

1600 1601
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1602
    econtext = getEngine().getContext()
1603 1604 1605 1606
    if disable_cache:
      argument_cache = DummyDict()
    else:
      argument_cache = {}
1607

1608 1609
    with (noReadOnlyTransactionCache if disable_cache else
          readOnlyTransactionCache)():
1610
      filter_dict = self.filter_dict
1611
      catalogged_object_list_cache = {}
1612
      for method_name in method_id_list:
1613 1614 1615 1616 1617
        # We will check if there is an filter on this
        # method, if so we may not call this zsqlMethod
        # for this object
        expression = None
        try:
1618
          filter = filter_dict[method_name]
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
          if filter['filtered']:
            if filter.get('type'):
              expression = Expression('python: context.getPortalType() in '
                                      + repr(tuple(filter['type'])))
              LOG('SQLCatalog', WARNING,
                  "Convert deprecated type filter for %r into %r expression"
                  % (method_name, expression.text))
              filter['type'] = ()
              filter['expression'] = expression.text
              filter['expression_instance'] = expression
            else:
              expression = filter['expression_instance']
        except KeyError:
          pass
        if expression is None:
          catalogged_object_list = object_list
        else:
          text = expression.text
          catalogged_object_list = catalogged_object_list_cache.get(text)
          if catalogged_object_list is None:
            catalogged_object_list_cache[text] = catalogged_object_list = []
            append = catalogged_object_list.append
            old_context = new_context_search(text) is None
            if old_context:
              warnings.warn("Filter expression for %r (%r): using variables"
                            " other than 'context' is deprecated and slower."
                            % (method_name, text), DeprecationWarning)
            expression_cache_key_list = filter.get('expression_cache_key', ())
            expression_result_cache = {}
            for object in object_list:
1649
              if expression_cache_key_list:
1650 1651 1652 1653
                # Expressions are slow to evaluate because they are executed
                # in restricted environment. So we try to save results of
                # expressions by portal_type or any other key.
                # This cache is built each time we reindex
1654 1655
                # objects but we could also use over multiple transactions
                # if this can improve performance significantly
1656 1657 1658
                # ZZZ - we could find a way to compute this once only
                cache_key = tuple(object.getProperty(key) for key
                                  in expression_cache_key_list)
1659
                try:
1660 1661 1662
                  if expression_result_cache[cache_key]:
                    append(object)
                  continue
1663
                except KeyError:
1664 1665 1666
                  pass
              if old_context:
                result = expression(self.getExpressionContext(object))
1667
              else:
1668
                econtext.setLocal('context', object)
1669
                result = expression(econtext)
1670
              if expression_cache_key_list:
1671
                expression_result_cache[cache_key] = result
1672 1673
              if result:
                append(object)
1674

1675
        if not catalogged_object_list:
1676
          continue
1677

1678 1679
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1680
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1681
          # Build the dictionnary of values
1682
          arguments = method.arguments_src.split()
1683 1684 1685
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1686 1687
        else:
          arguments = []
1688 1689 1690
        kw = {x: LazyIndexationParameterList(catalogged_object_list,
                                             x, argument_cache)
          for x in arguments}
1691

1692 1693 1694
        # Alter/Create row
        try:
          #start_time = DateTime()
1695
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1696 1697 1698 1699 1700 1701 1702
          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]))
1703

1704 1705 1706
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1707
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1708 1709
              error=sys.exc_info())
          raise
1710

1711 1712
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1713

1714
  security.declarePrivate('beforeUncatalogObject')
1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
  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
1727 1728 1729 1730
    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
1731
      return self.uncatalogObject(path=path,uid=uid)
1732 1733 1734
    method = getattr(self, method_name)
    method(uid = uid)

1735
  security.declarePrivate('uncatalogObject')
1736
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
    """
    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

    """
1749
    if not self.isIndexable():
1750 1751
      return None

1752 1753
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1754 1755
    methods = self.sql_uncatalog_object
    if uid is None:
1756
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1757
    for method_name in methods:
1758 1759
      # 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
1760
      method = getattr(self, method_name)
1761
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1762

1763
  security.declarePrivate('catalogTranslationList')
1764 1765 1766 1767
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1768 1769
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1770

1771
  security.declarePrivate('deleteTranslationList')
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
  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())
1783

1784
  security.declarePrivate('uniqueValuesFor')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1785 1786 1787
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1788
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1789

1790
  security.declarePrivate('getPaths')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1791 1792 1793 1794 1795
  def getPaths(self):
    """ Returns all object paths stored inside catalog """
    method = getattr(self, self.sql_catalog_paths)
    return method()

1796
  security.declarePrivate('getUidForPath')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1797 1798
  def getUidForPath(self, path):
    """ Looks up into catalog table to convert path into uid """
1799
    return self.getUidDictForPathList([path]).get(path)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1800

1801
  security.declarePrivate('getUidDictForPathList')
1802 1803
  def getUidDictForPathList(self, path_list):
    """ Looks up into catalog table to convert path into uid """
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
    return  {
      x.path: x.uid
      for x in getattr(
        self,
        self.sql_getitem_by_path,
      )(
        path=None,
        path_list=path_list,
        uid_only=False,
      )
    }
1815

1816
  security.declarePrivate('getPathDictForUidList')
1817 1818
  def getPathDictForUidList(self, uid_list):
    """ Looks up into catalog table to convert uid into path """
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829
    return  {
      x.uid: x.path
      for x in getattr(
        self,
        self.sql_getitem_by_uid,
      )(
        uid=None,
        uid_list=uid_list,
        path_only=False,
      )
    }
1830

1831
  security.declarePrivate('hasPath')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1832 1833 1834 1835
  def hasPath(self, path):
    """ Checks if path is catalogued """
    return self.getUidForPath(path) is not None

1836
  security.declarePrivate('getPathForUid')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1837 1838
  def getPathForUid(self, uid):
    """ Looks up into catalog table to convert uid into path """
1839
    return self.getPathDictForUidList([uid]).get(uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1840

1841
  security.declarePrivate('getMetadataForUid')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1842 1843 1844
  def getMetadataForUid(self, uid):
    """ Accesses a single record for a given uid """
    result = {}
1845 1846 1847 1848
    path = self.getPathForUid(uid)
    if uid is not None:
      result['path'] = path
      result['uid'] = uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1849 1850
    return result

1851
  security.declarePrivate('getIndexDataForUid')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1852 1853 1854 1855
  def getIndexDataForUid(self, uid):
    """ Accesses a single record for a given uid """
    return self.getMetadataForUid(uid)

1856
  security.declarePrivate('getMetadataForPath')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1857 1858
  def getMetadataForPath(self, path):
    """ Accesses a single record for a given path """
1859 1860 1861 1862 1863 1864
    result = {}
    uid = self.getUidForPath(path)
    if uid is not None:
      result['path'] = path
      result['uid'] = uid
    return result
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1865

1866
  security.declarePrivate('getIndexDataForPath')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1867 1868 1869 1870
  def getIndexDataForPath(self, path):
    """ Accesses a single record for a given path """
    return self.getMetadataForPath(path)

1871
  security.declarePrivate('getCatalogMethodIds')
1872 1873
  def getCatalogMethodIds(self,
      valid_method_meta_type_list=valid_method_meta_type_list):
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
    """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
1885 1886
            if not isinstance(id, str):
              id=id()
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
            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

1898
  security.declarePrivate('getPythonMethodIds')
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
  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)', ))

  @transactional_cache_decorator('SQLCatalog._getSQLCatalogRelatedKeyList')
  def _getSQLCatalogRelatedKeySet(self):
    column_map = self.getColumnMap()
    column_set = set(column_map)
    for related_key in self.sql_catalog_related_keys:
1911 1912
      split_entire_definition = related_key.split('|')
      if len(split_entire_definition) != 2:
1913
        LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (related_key, ))
1914 1915
        continue
      related_key_id = split_entire_definition[0].strip()
1916 1917 1918
      if related_key_id in column_set and \
         related_key_id not in related_key_warned_column_set:
        related_key_warned_column_set.add(related_key_id)
1919
        if related_key_id in column_map:
1920
          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]))
1921
        else:
1922
          LOG('SQLCatalog', WARNING, 'Related key %r is declared more than once.' % (related_key_id, ))
1923 1924 1925
      column_set.add(related_key_id)
    return column_set

1926
  security.declarePrivate('getSQLCatalogRelatedKeyList')
1927
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1928 1929
    """
    Return the list of related keys.
1930
    This method can be overidden in order to implement
1931 1932
    dynamic generation of some related keys.
    """
1933 1934
    if key_list is None:
      key_list = []
1935
    column_map = self._getSQLCatalogRelatedKeySet()
1936 1937 1938 1939
    return self.getDynamicRelatedKeyList(
      [k for k in key_list if k not in column_map],
      sql_catalog_id=self.id,
    ) + list(self.sql_catalog_related_keys)
1940

1941
  # Compatibililty SQL Sql
1942
  security.declarePrivate('getSqlCatalogRelatedKeyList')
1943 1944
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1945
  security.declarePrivate('getSQLCatalogScriptableKeyList')
1946 1947 1948 1949 1950
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1951

1952
  @transactional_cache_decorator('SQLCatalog.getTableIndex')
1953
  def _getTableIndex(self, table):
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
    table_index = {}
    method = getattr(self, self.sql_catalog_index, '')
    if method in ('', None):
      return {}
    index = list(method(table=table))
    for line in index:
      if table_index.has_key(line.KEY_NAME):
        table_index[line.KEY_NAME].append(line.COLUMN_NAME)
      else:
        table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
1964 1965
    return table_index

1966
  security.declarePrivate('getTableIndex')
1967 1968 1969 1970 1971
  def getTableIndex(self, table):
    """
    Return a map between index and column for a given table
    """
    return self._getTableIndex(table).copy()
1972

1973
  security.declareProtected(access_contents_information, 'isValidColumn')
1974 1975 1976 1977
  def isValidColumn(self, column_id):
    """
      Tells wether given name is or not an existing column.

1978 1979
      Warning: This includes "virtual" columns, such as related keys and
      scriptable keys.
1980
    """
1981
    result = self.getScriptableKeyScript(column_id) is not None
1982
    if not result:
1983 1984 1985
      result = column_id in self.getColumnMap()
      if not result:
        result = self.getRelatedKeyDefinition(column_id) is not None
1986 1987
    return result

1988
  security.declarePrivate('getRelatedKeyDefinition')
1989 1990 1991 1992 1993
  def getRelatedKeyDefinition(self, key):
    """
      Returns the definition of given related key name if found, None
      otherwise.
    """
1994 1995
    related_key_definition_cache = getTransactionalVariable().setdefault(
      'SQLCatalog.getRelatedKeyDefinition', {})
1996 1997 1998 1999
    try:
      result = related_key_definition_cache[key]
    except KeyError:
      for entire_definition in self.getSQLCatalogRelatedKeyList([key]):
2000 2001
        split_entire_definition = entire_definition.split('|')
        if len(split_entire_definition) != 2:
2002
          LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (entire_definition, ))
2003
          continue
2004 2005
        if split_entire_definition[0].strip() == key:
          result = split_entire_definition[1].strip()
2006
          break
2007 2008 2009
      else:
        result = None
      related_key_definition_cache[key] = result
2010
    return result
2011

2012 2013 2014 2015 2016 2017
  @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:
2018
        LOG('SQLCatalog', WARNING, 'Malformed scriptable key definition: %r. Ignored.' % (scriptable_key_definition, ))
2019 2020 2021 2022
        continue
      key, script_id = [x.strip() for x in split_scriptable_key_definition]
      script = getattr(self, script_id, None)
      if script is None:
2023
        LOG('SQLCatalog', WARNING, 'Scriptable key %r script %r is missing.' \
2024 2025 2026 2027 2028
            ' Skipped.' % (key, script_id))
      else:
        result[key] = script
    return result

2029
  security.declarePrivate('getScriptableKeyScript')
2030 2031 2032
  def getScriptableKeyScript(self, key):
    return self._getgetScriptableKeyDict().get(key)

2033
  security.declarePrivate('getColumnSearchKey')
2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
  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
2044 2045 2046

      If both a related key and a real column are found, the related key
      is used.
2047
    """
2048 2049 2050 2051 2052
    # Is key a related key or a "real" column ?
    related_key_definition = self.getRelatedKeyDefinition(key)
    if related_key_definition is None:
      if key in self.getColumnMap():
        search_key = self.getSearchKey(key, search_key_name)
2053
      else:
2054 2055 2056
        search_key = None
    else:
      search_key = self.getSearchKey(key, 'RelatedKey')
2057 2058
    return search_key, related_key_definition

2059
  security.declarePrivate('hasColumn')
2060 2061 2062
  def hasColumn(self, column):
    return self.getColumnSearchKey(column)[0] is not None

2063
  security.declarePrivate('getColumnDefaultSearchKey')
2064
  def getColumnDefaultSearchKey(self, key, search_key_name=None):
2065 2066 2067 2068
    """
      Return a SearchKey instance which would ultimately receive the value
      associated with given key.
    """
2069 2070
    search_key, related_key_definition = self.getColumnSearchKey(key,
      search_key_name=search_key_name)
2071 2072 2073 2074
    if search_key is None:
      result = None
    else:
      if related_key_definition is not None:
2075 2076
        search_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
2077 2078
    return search_key

2079
  security.declareProtected(access_contents_information, 'buildSingleQuery')
2080 2081 2082 2083 2084
  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.
    """
2085 2086 2087 2088 2089
    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
2090
      else:
2091
        if related_key_definition is None:
2092
          build_key = search_key
2093
        else:
2094 2095 2096
          build_key = search_key.getSearchKey(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_key_name=search_key_name)
2097 2098 2099
        result = build_key.buildQuery(value, logical_operator=logical_operator,
                                      comparison_operator=comparison_operator)
        if related_key_definition is not None:
2100 2101 2102
          result = search_key.buildQuery(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_value=result)
2103 2104
    else:
      result = script(value)
2105 2106
    return result

2107
  def _buildQueryFromAbstractSyntaxTreeNode(self, node, search_key, wrap, ignore_unknown_columns):
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
    """
    node
      Abstract syntax tree node (see SearchText/AdvancedSearchTextParser.py,
      classes inheriting from Node).
    search_key
      Search key to generate queries from values found during syntax tree walk.
    wrap
      Callback transforming a value just before it is passed to
      search_key.buildQuery .
    """
2118 2119 2120 2121
    if search_key.dequoteParsedText():
      _dequote = dequote
    else:
      _dequote = lambda x: x
2122
    if node.isLeaf():
2123
      result = search_key.buildQuery(wrap(_dequote(node.getValue())),
2124
        comparison_operator=node.getComparisonOperator())
2125
    elif node.isColumn():
2126 2127 2128 2129 2130
      result = self.buildQueryFromAbstractSyntaxTreeNode(
        node.getSubNode(),
        node.getColumnName(),
        ignore_unknown_columns=ignore_unknown_columns,
      )
2131 2132 2133 2134 2135 2136
    else:
      query_list = []
      value_dict = {}
      append = query_list.append
      for subnode in node.getNodeList():
        if subnode.isLeaf():
2137
          value_dict.setdefault(subnode.getComparisonOperator(),
2138
            []).append(wrap(_dequote(subnode.getValue())))
2139
        else:
2140 2141 2142 2143 2144 2145
          subquery = self._buildQueryFromAbstractSyntaxTreeNode(
            subnode,
            search_key,
            wrap,
            ignore_unknown_columns,
          )
2146 2147
          if subquery is not None:
            append(subquery)
2148
      logical_operator = node.getLogicalOperator()
2149 2150 2151 2152
      if logical_operator == 'not':
        query_logical_operator = None
      else:
        query_logical_operator = logical_operator
2153
      for comparison_operator, value_list in value_dict.iteritems():
2154
        append(search_key.buildQuery(value_list, comparison_operator=comparison_operator, logical_operator=query_logical_operator))
2155 2156
      if logical_operator == 'not' or len(query_list) > 1:
        result = ComplexQuery(query_list, logical_operator=logical_operator)
2157 2158
      elif len(query_list) == 1:
        result = query_list[0]
2159
      else:
2160 2161 2162
        result = None
    return result

2163
  security.declareProtected(access_contents_information, 'buildQueryFromAbstractSyntaxTreeNode')
2164
  def buildQueryFromAbstractSyntaxTreeNode(self, node, key, wrap=lambda x: x, ignore_unknown_columns=False):
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
    """
      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).

2175
      Expected node API is described in interfaces/abstract_syntax_node.py .
2176
    """
2177 2178 2179 2180 2181 2182
    script = self.getScriptableKeyScript(key)
    if script is None:
      search_key, related_key_definition = self.getColumnSearchKey(key)
    else:
      search_key = SearchKeyWrapperForScriptableKey(key, script)
      related_key_definition = None
2183
    if search_key is None:
2184 2185 2186
      message = 'Unknown column ' + repr(key)
      if not ignore_unknown_columns:
        raise ValueError(message)
2187
      # Unknown, skip loudly
2188
      LOG('SQLCatalog', WARNING, message)
2189
      result = None
2190 2191 2192 2193
    else:
      if related_key_definition is None:
        build_key = search_key
      else:
2194 2195
        build_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
2196
      result = self._buildQueryFromAbstractSyntaxTreeNode(node, build_key,
2197
        wrap, ignore_unknown_columns)
2198
      if related_key_definition is not None:
2199 2200 2201
        result = search_key.buildQuery(sql_catalog=self,
          related_key_definition=related_key_definition,
          search_value=result)
2202 2203
    return result

2204 2205 2206 2207 2208
  def _parseSearchText(self, search_key, search_text, is_valid=None):
    if is_valid is None:
      is_valid = self.isValidColumn
    return search_key.parseSearchText(search_text, is_valid)

2209
  security.declareProtected(access_contents_information, 'parseSearchText')
2210 2211 2212 2213 2214 2215 2216 2217
  def parseSearchText(self, search_text, column=None, search_key=None,
                      is_valid=None):
    if column is None and search_key is None:
      raise ValueError, 'One of column and search_key must be different '\
                        'from None'
    return self._parseSearchText(self.getSearchKey(
      column, search_key=search_key), search_text, is_valid=is_valid)

2218
  security.declareProtected(access_contents_information, 'buildQuery')
2219
  def buildQuery(self, kw, ignore_empty_string=True, operator='and', ignore_unknown_columns=False):
2220 2221 2222 2223 2224 2225 2226 2227 2228
    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 = {}
2229 2230 2231
    # empty_value_dict: contains all keys whose value causes them to be
    # discarded.
    empty_value_dict = {}
2232 2233 2234 2235 2236 2237 2238
    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 == ''
2239
          or (isinstance(value, list_type_list) and not value)
2240 2241 2242
          or (isinstance(value, dict) and (
            'query' not in value
            or value['query'] == ''
2243 2244
            or (isinstance(value['query'], list_type_list)
              and not value['query'])))):
2245
        # We have an empty value, do not create a query from it
2246
        empty_value_dict[key] = value
2247
      else:
2248
        script = self.getScriptableKeyScript(key)
2249
        if isinstance(value, dict):
2250 2251 2252 2253 2254 2255
          # 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'
2256 2257 2258 2259
          # Backward compatibility: former "ExactMatch" is now only available
          # as "RawKey"
          elif search_key_name == 'ExactMatch':
            search_key_name = value['key'] = 'RawKey'
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
        if isinstance(value, _Query):
          # Query instance: use as such, ignore key.
          result = value
        elif script is not None:
          result = script(value)
        elif isinstance(value, (basestring, dict)):
          # String: parse using key's default search key.
          raw_value = value
          if isinstance(value, dict):
            # De-wrap value for parsing, and re-wrap when building queries.
            def wrap(x):
              result = raw_value.copy()
              result['query'] = x
              return result
            value = value['query']
          else:
            wrap = lambda x: x
            search_key_name = None
          search_key = self.getColumnDefaultSearchKey(key,
            search_key_name=search_key_name)
          if search_key is not None:
            if isinstance(value, basestring):
              abstract_syntax_tree = self._parseSearchText(search_key, value)
            else:
              abstract_syntax_tree = None
            if abstract_syntax_tree is None:
              # Parsing failed, create a query from the bare string.
              result = self.buildSingleQuery(key, raw_value, search_key_name)
            else:
              result = self.buildQueryFromAbstractSyntaxTreeNode(
2290 2291 2292
                abstract_syntax_tree, key, wrap,
                ignore_unknown_columns=ignore_unknown_columns,
              )
2293 2294 2295 2296 2297 2298 2299 2300
        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)
2301 2302
    if len(empty_value_dict):
      LOG('SQLCatalog', WARNING, 'Discarding columns with empty values: %r' % (empty_value_dict, ))
2303
    if len(unknown_column_dict):
2304 2305 2306 2307 2308
      message = 'Unknown columns ' + repr(unknown_column_dict.keys())
      if ignore_unknown_columns:
        LOG('SQLCatalog', WARNING, message)
      else:
        raise TypeError(message)
2309 2310
    return ComplexQuery(query_list, logical_operator=operator,
        unknown_column_dict=unknown_column_dict)
2311

2312
  security.declarePrivate('buildOrderByList')
2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
  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:
2331
        LOG('SQLCatalog', WARNING, 'order_by_expression (%r) and sort_on (%r) were given. Ignoring order_by_expression.' % (order_by_expression, sort_on))
2332 2333 2334 2335 2336
      if not isinstance(sort_on, (tuple, list)):
        sort_on = [[sort_on]]
      for item in sort_on:
        if isinstance(item, (tuple, list)):
          item = list(item)
2337
        else:
2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
          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'
2349 2350
            elif item[2] == 'float':
              item[2] = 'DECIMAL'
2351 2352 2353 2354
        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, )
2355 2356 2357 2358 2359 2360 2361
      for x in order_by_expression.split(','):
        x = x.strip()
        item = x.rsplit(None, 1)
        if len(item) > 1 and item[-1].upper() in ('ASC', 'DESC'):
          append(item)
        else:
          append([x])
2362 2363
    return order_by_list

2364
  security.declarePrivate('buildEntireQuery')
2365
  def buildEntireQuery(self, kw, query_table='catalog', ignore_empty_string=1,
2366
                       limit=None, extra_column_list=(),
2367
                       ignore_unknown_columns=False):
2368 2369 2370
    kw = self.getCannonicalArgumentDict(kw)
    group_by_list = kw.pop('group_by_list', [])
    select_dict = kw.pop('select_dict', {})
2371 2372
    # Handle left_join_list
    left_join_list = kw.pop('left_join_list', ())
2373 2374 2375 2376 2377
    # Handle implicit_join. It's True by default, as there's a lot of code
    # in BT5s and elsewhere that calls buildSQLQuery() expecting implicit
    # join. self._queryResults() defaults it to False for those using
    # catalog.searchResults(...) or catalog(...) directly.
    implicit_join = kw.pop('implicit_join', True)
2378
    # Handle order_by_list
2379
    order_by_list = kw.pop('order_by_list', [])
2380 2381 2382 2383 2384
    # 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):
2385
      LOG('SQLCatalog', INFO, 'Giving where_expression a string value is deprecated.')
2386 2387 2388 2389 2390 2391
      # 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.
2392
    order_by_override_list = kw.pop('select_expression_key', ())
2393
    return EntireQuery(
2394
      query=self.buildQuery(kw, ignore_empty_string=ignore_empty_string, ignore_unknown_columns=ignore_unknown_columns),
2395 2396 2397 2398
      order_by_list=order_by_list,
      order_by_override_list=order_by_override_list,
      group_by_list=group_by_list,
      select_dict=select_dict,
2399
      left_join_list=left_join_list,
2400
      implicit_join=implicit_join,
2401 2402 2403 2404
      limit=limit,
      catalog_table_name=query_table,
      extra_column_list=extra_column_list,
      from_expression=from_expression)
2405

2406
  security.declarePrivate('buildSQLQuery')
2407 2408
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
                          ignore_empty_string=1, only_group_columns=False,
2409
                          limit=None, extra_column_list=(),
2410
                          ignore_unknown_columns=False,
2411
                          **kw):
2412 2413 2414 2415 2416 2417
    return self.buildEntireQuery(
      kw,
      query_table=query_table,
      ignore_empty_string=ignore_empty_string,
      limit=limit,
      extra_column_list=extra_column_list,
2418
      ignore_unknown_columns=ignore_unknown_columns,
2419 2420 2421 2422
    ).asSQLExpression(
      self,
      only_group_columns,
    ).asSQLExpressionDict()
2423

2424 2425 2426
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2427
  security.declareProtected(access_contents_information, 'getCannonicalArgumentDict')
2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
  def getCannonicalArgumentDict(self, kw):
    """
    Convert some catalog arguments to generic arguments.

    group_by, group_by_expression -> group_by_list
    select_list, select_expression -> select_dict
    sort_on, sort_on_order, order_by_expression -> order_list
    """
    kw = kw.copy()
    group_by = kw.pop('group_by', None)
    group_by_expression = kw.pop('group_by_expression', None)
    group_by_list = kw.pop('group_by_list', None) or group_by or group_by_expression or []
    if isinstance(group_by_list, basestring):
      group_by_list = [x.strip() for x in group_by_list.split(',')]
    kw['group_by_list'] = group_by_list

    select_list = kw.pop('select_list', None)
    select_expression = kw.pop('select_expression', None)
    select_dict = kw.pop('select_dict', None) or select_list or select_expression or {}
    if isinstance(select_dict, (list, tuple)):
      select_dict = dict.fromkeys(select_dict)
    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.fromkeys(select_dict)
    kw['select_dict'] = select_dict

    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,
      )
    else:
      if sort_on is not None:
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_on were given, ignoring sort_on.')
      if sort_order is not None:
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_order were given, ignoring sort_order.')
      if order_by_expression is not None:
        LOG('SQLCatalog', WARNING, 'order_by_list and order_by_expression were given, ignoring order_by_expression.')
    kw['order_by_list'] = order_by_list or []
    return kw

2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
  @transactional_cache_decorator('SQLCatalog._getSearchKeyDict')
  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:
2496
          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))
2497 2498
        else:
          result[column] = key
2499 2500 2501 2502 2503 2504
    for line in self.sql_catalog_search_keys:
      try:
        column, key = [x.strip() for x in line.split('|', 2)]
        result[column] = key
      except ValueError:
        LOG('SQLCatalog', WARNING, 'Wrong configuration for sql_catalog_search_keys: %r' % line)
2505 2506
    return result

2507
  security.declarePrivate('getSearchKey')
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
  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)

2523
  security.declarePrivate('getComparisonOperator')
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533
  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)

2534

2535
  security.declarePrivate('queryResults')
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548
  def queryResults(
        self,
        sql_method,
        REQUEST=None,
        src__=0,
        build_sql_query_method=None,
        selection_domain=None,
        selection_report=None,
        # XXX should get zsql_brain from ZSQLMethod class itself
        zsql_brain=None,
        implicit_join=False,
        **kw
      ):
2549 2550
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
    query = build_sql_query_method(
      REQUEST=REQUEST,
      implicit_join=implicit_join,
      **kw
    )
    return sql_method(
      src__=src__,
      zsql_brain=zsql_brain,
      selection_domain=selection_domain,
      selection_report=selection_report,
      where_expression=query['where_expression'],
      select_expression=query['select_expression'],
      group_by_expression=query['group_by_expression'],
      from_table_list=query['from_table_list'],
      from_expression=query['from_expression'],
      sort_on=query['order_by_expression'],
      limit_expression=query['limit_expression'],
    )
2569

2570
  security.declarePrivate('getSearchResultsMethod')
2571 2572 2573
  def getSearchResultsMethod(self):
    return getattr(self, self.sql_search_results)

2574
  security.declarePrivate('searchResults')
2575
  def searchResults(self, REQUEST=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2576
    """ Returns a list of brains from a set of constraints on variables """
2577 2578 2579 2580
    if 'only_group_columns' in kw:
      # searchResults must be consistent in API with countResults
      raise ValueError('only_group_columns does not belong to this API '
        'level, use queryResults directly')
2581 2582 2583 2584 2585 2586
    return self.queryResults(
      self.getSearchResultsMethod(),
      REQUEST=REQUEST,
      extra_column_list=self.getCatalogSearchResultKeys(),
      **kw
    )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2587 2588 2589

  __call__ = searchResults

2590
  security.declarePrivate('getCountResultsMethod')
2591 2592 2593
  def getCountResultsMethod(self):
    return getattr(self, self.sql_count_results)

2594
  security.declarePrivate('countResults')
2595
  def countResults(self, REQUEST=None, **kw):
2596
    """ Returns the number of items which satisfy the where_expression """
2597 2598 2599 2600 2601 2602 2603
    return self.queryResults(
      self.getCountResultsMethod(),
      REQUEST=REQUEST,
      extra_column_list=self.getCatalogSearchResultKeys(),
      only_group_columns=True,
      **kw
    )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2604

2605
  security.declarePrivate('isAdvancedSearchText')
2606 2607 2608
  def isAdvancedSearchText(self, search_text):
    return isAdvancedSearchText(search_text, self.isValidColumn)

2609
  security.declarePrivate('recordObjectList')
2610
  def recordObjectList(self, path_list, catalog=1):
2611
    """
2612
      Record the path of an object being catalogged or uncatalogged.
2613
    """
2614 2615
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2616

2617
  security.declarePrivate('deleteRecordedObjectList')
2618
  def deleteRecordedObjectList(self, uid_list=()):
2619 2620 2621 2622
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2623
    method(uid_list=uid_list)
2624

2625
  security.declarePrivate('readRecordedObjectList')
2626
  def readRecordedObjectList(self, catalog=1):
2627 2628 2629 2630
    """
      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)
2631
    return method(catalog=catalog)
2632

2633
  # Filtering
2634
  security.declareProtected(manage_zcatalog_entries, 'manage_editFilter')
2635 2636 2637 2638 2639 2640 2641
  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:
2642
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2643

2644 2645 2646 2647
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2648

2649
      for id in method_id_list:
2650 2651 2652
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2653

2654 2655 2656 2657 2658
        if REQUEST.has_key('%s_box' % id):
          self.filter_dict[id]['filtered'] = 1
        else:
          self.filter_dict[id]['filtered'] = 0

2659 2660 2661 2662
        expression = REQUEST.get('%s_expression' % id, '').strip()
        self.filter_dict[id]['expression'] = expression
        if expression:
          self.filter_dict[id]['expression_instance'] = Expression(expression)
2663 2664 2665 2666 2667
        else:
          self.filter_dict[id]['expression_instance'] = None

        if REQUEST.has_key('%s_type' % id):
          list_type = REQUEST['%s_type' % id]
2668
          if isinstance(list_type, str):
2669 2670 2671 2672 2673
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2674 2675
        self.filter_dict[id]['expression_cache_key'] = \
          tuple(sorted(REQUEST.get('%s_expression_cache_key' % id, '').split()))
2676

2677 2678 2679
    if RESPONSE and URL1:
      RESPONSE.redirect(URL1 + '/manage_catalogFilter?manage_tabs_message=Filter%20Changed')

2680
  security.declarePrivate('isMethodFiltered')
2681 2682 2683 2684 2685 2686 2687
  def isMethodFiltered(self, method_name):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      # Reset Filtet dict
2688
      if getattr(aq_base(self), 'filter_dict', None) is None:
2689 2690
        self.filter_dict = PersistentMapping()
        return 0
2691
      try:
2692
        return self.filter_dict[method_name]['filtered']
2693 2694
      except KeyError:
        return 0
2695 2696
    return 0

2697
  security.declarePrivate('getExpression')
2698
  def getExpression(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2699
    """ Get the filter expression text for this method.
2700 2701
    """
    if withCMF:
2702
      if getattr(aq_base(self), 'filter_dict', None) is None:
2703 2704
        self.filter_dict = PersistentMapping()
        return ""
2705
      try:
2706
        return self.filter_dict[method_name]['expression']
2707 2708
      except KeyError:
        return ""
2709 2710
    return ""

2711
  security.declarePrivate('getExpressionCacheKey')
2712 2713 2714 2715 2716 2717 2718 2719 2720
  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:
2721
        return ' '.join(self.filter_dict[method_name]['expression_cache_key'])
2722 2723 2724 2725
      except KeyError:
        return ""
    return ""

2726
  security.declarePrivate('getExpressionInstance')
2727
  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2728
    """ Get the filter expression instance for this method.
2729 2730
    """
    if withCMF:
2731
      if getattr(aq_base(self), 'filter_dict', None) is None:
2732 2733
        self.filter_dict = PersistentMapping()
        return None
2734
      try:
2735
        return self.filter_dict[method_name]['expression_instance']
2736 2737
      except KeyError:
        return None
2738 2739
    return None

2740
  security.declarePrivate('setFilterExpression')
Rafael Monnerat's avatar
Rafael Monnerat committed
2741
  def setFilterExpression(self, method_name, expression):
2742
    """ Set the Expression for a certain method name. This allow set
Rafael Monnerat's avatar
Rafael Monnerat committed
2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
        expressions by scripts.
    """
    if withCMF:
      if getattr(aq_base(self), 'filter_dict', None) is None:
        self.filter_dict = PersistentMapping()
        return None
      self.filter_dict[method_name]['expression'] = expression
      if expression:
        self.filter_dict[method_name]['expression_instance'] = Expression(expression)
      else:
        self.filter_dict[method_name]['expression_instance'] = None

2755
  security.declarePrivate('isPortalTypeSelected')
Jérome Perrin's avatar
Jérome Perrin committed
2756 2757
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2758
      XXX deprecated
2759 2760
    """
    if withCMF:
2761
      if getattr(aq_base(self), 'filter_dict', None) is None:
2762 2763
        self.filter_dict = PersistentMapping()
        return 0
2764 2765 2766 2767
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2768 2769
    return 0

2770
  security.declarePrivate('getFilteredPortalTypeList')
2771 2772 2773
  def getFilteredPortalTypeList(self, method_name):
    """ Returns the list of portal types which define
        the filter.
2774
      XXX deprecated
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784
    """
    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 []
2785

2786
  security.declarePrivate('getFilterDict')
Rafael Monnerat's avatar
Rafael Monnerat committed
2787 2788 2789
  def getFilterDict(self):
    """
      Utility Method.
2790
      Filter Dict is a dictionary and used at Python Scripts,
Rafael Monnerat's avatar
Rafael Monnerat committed
2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805
      This method returns a filter dict as a dictionary.
    """
    if withCMF:
      if getattr(aq_base(self), 'filter_dict', None) is None:
        self.filter_dict = PersistentMapping()
        return None
      filter_dict = {}
      for key in self.filter_dict:
        # Filter is also a Persistence dict.
        filter_dict[key] = {}
        for sub_key in self.filter_dict[key]:
           filter_dict[key][sub_key] = self.filter_dict[key][sub_key]
      return filter_dict
    return None

2806
  security.declarePrivate('getFilterableMethodList')
2807 2808 2809 2810 2811 2812
  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2813 2814 2815 2816
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2817 2818 2819 2820 2821
      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)

2822
  security.declarePrivate('getExpressionContext')
2823 2824 2825
  def getExpressionContext(self, ob):
      '''
      An expression context provides names for TALES expressions.
2826
      XXX deprecated
2827 2828 2829 2830 2831
      '''
      if withCMF:
        data = {
            'here':         ob,
            'container':    aq_parent(aq_inner(ob)),
2832 2833 2834 2835
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
2836 2837 2838 2839 2840 2841 2842 2843 2844
            # 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,
2845 2846 2847
            }
        return getEngine().getContext(data)

2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871
  def _getOptimizerSwitch(self):
    method_name = self.sql_optimizer_switch
    try:
      method = getattr(self, method_name)
    except AttributeError:
      pass
    else:
      try:
        return method()[0][0]
      except (ConflictError, DatabaseError):
        raise
      except Exception:
        pass

    LOG('SQLCatalog', WARNING, 'getTableIds failed with the method %s'
        % method_name, error=sys.exc_info())
    return ''

  security.declarePublic('getOptimizerSwitchKeyList')
  @transactional_cache_decorator('SQLCatalog.getOptimizerSwitchKeyList')
  def getOptimizerSwitchKeyList(self):
    return [pair.split('=', 1)[0] for pair in \
              self._getOptimizerSwitch().split(',')]

2872
InitializeClass(Catalog)
2873

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

2876 2877
from Query.Query import Query as _Query
from Query.SimpleQuery import SimpleQuery
Ivan Tyagov's avatar
Ivan Tyagov committed
2878
from Query.ComplexQuery import ComplexQuery
2879 2880
from Query.AutoQuery import AutoQuery
Query = AutoQuery
2881 2882

def NegatedQuery(query):
2883
  return ComplexQuery(query, logical_operator='not')
2884

2885 2886 2887 2888 2889 2890
def AndQuery(*args):
  return ComplexQuery(logical_operator='and', *args)

def OrQuery(*args):
  return ComplexQuery(logical_operator='or', *args)

2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915
allow_class(SimpleQuery)
allow_class(ComplexQuery)

import SearchKey
SEARCH_KEY_INSTANCE_POOL = {}
SEARCH_KEY_CLASS_CACHE = {}

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

2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942
class SearchKeyWrapperForScriptableKey(SearchKey.SearchKey.SearchKey):
  """
    This SearchKey is a simple wrapper around a ScriptableKey, so such script
    can be used in place of a regular SearchKey.
  """
  default_comparison_operator = None
  get_operator_from_value = False

  def __init__(self, column, script):
    self.script = script
    super(SearchKeyWrapperForScriptableKey, self).__init__(column)

  def buildQuery(self, search_value, group=None, logical_operator=None,
                 comparison_operator=None):
    # XXX: It would be better to extend ScriptableKey API to support other
    # parameters.
    if group is not None:
      raise ValueError, 'ScriptableKey cannot be used inside a group ' \
        '(%r given).' % (group, )
    if logical_operator is not None:
      raise ValueError, 'ScriptableKey ignores logical operators ' \
        '(%r given).' % (logical_operator, )
    if comparison_operator != '':
      raise ValueError, 'ScriptableKey ignores comparison operators ' \
        '(%r given).' % (comparison_operator, )
    return self.script(search_value)

2943 2944 2945 2946 2947 2948 2949 2950
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)