SQLCatalog.py 95.5 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 BTrees.OIBTree import OIBTree
26 27
from App.config import getConfiguration
from BTrees.Length import Length
28
from Shared.DC.ZRDB.TM import TM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
29

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

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

51
from interfaces.query_catalog import ISearchKeyCatalog
52 53
from zope.interface.verify import verifyClass
from zope.interface import implements
54

55 56
from SearchText import isAdvancedSearchText

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


64 65 66 67 68 69
PROFILING_ENABLED = False
if PROFILING_ENABLED:
  from tiny_profiler import profiler_decorator, profiler_report, profiler_reset
else:
  def profiler_decorator(func):
    return func
70 71 72 73 74

try:
  from Products.CMFCore.Expression import Expression
  from Products.PageTemplates.Expressions import getEngine
  from Products.CMFCore.utils import getToolByName
75
  new_context_search = re.compile(r'\bcontext\b').search
76 77 78 79
  withCMF = 1
except ImportError:
  withCMF = 0

80 81 82 83
try:
  import psyco
except ImportError:
  psyco = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
84

85
try:
86 87
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache, \
       disableReadOnlyTransactionCache, CachingMethod, \
88
       caching_instance_method
89
except ImportError:
90
  LOG('SQLCatalog', WARNING, 'Count not import CachingMethod, expect slowness.')
91 92
  def doNothing(context):
    pass
93 94 95 96 97 98
  class CachingMethod:
    """
      Dummy CachingMethod class.
    """
    def __init__(self, callable, **kw):
      self.function = callable
Yoshinori Okuji's avatar
Yoshinori Okuji committed
99
    def __call__(self, *opts, **kw):
100
      return self.function(*opts, **kw)
101
  def caching_instance_method(*args, **kw):
102
    return lambda method: method
103 104
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
105 106 107 108

try:
  from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
except ImportError:
109
  LOG('SQLCatalog', WARNING, 'Count not import getTransactionalVariable, expect slowness.')
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  def getTransactionalVariable(context):
    return {}

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

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

131 132 133 134
try:
  from ZPublisher.HTTPRequest import record
except ImportError:
  dict_type_list = (dict, )
135 136
else:
  dict_type_list = (dict, record)
137 138


139
UID_BUFFER_SIZE = 300
140 141
OBJECT_LIST_SIZE = 300
MAX_PATH_LEN = 255
142
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
143 144
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report',
                     'extra_key_list', )
145

146
valid_method_meta_type_list = ('Z SQL Method', 'LDIF Method', 'Script (Python)') # Nicer
147

148
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
149

150 151 152 153 154
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

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

166
  c = Catalog(id, title, self)
167 168 169 170
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

171 172
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
173

Yoshinori Okuji's avatar
Yoshinori Okuji committed
174
  def __init__(self):
175
    """Initialize some variables.
176

177
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
178

179
      finished_buffer is used to hold reserved uids created by committed-transactions.
180

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

186 187 188 189 190 191 192 193
  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
194

195 196 197 198 199 200 201
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
202

203 204 205 206 207 208 209 210
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
211

212 213 214 215 216 217 218 219 220 221 222
  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
223

224 225 226 227
  def pop(self):
    self._register()
    tid = get_ident()
    try:
228
      uid = self.temporary_buffer[tid].pop()
229
    except (KeyError, IndexError):
230 231
      uid = self.finished_buffer.pop()
    return uid
232

233 234 235
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
236
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
237

238
related_key_definition_cache = {}
239
related_key_warned_column_set = set()
240

241 242 243
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
244
              ActiveObject,
245
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
246 247 248 249
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
250
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
251 252 253 254 255 256 257 258

  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

259 260
  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.
261 262 263
  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).
264 265 266
  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
267

268
 """
269

270 271
  implements(ISearchKeyCatalog)
  
272

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

306
  __ac_permissions__= (
307 308 309 310 311

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

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
312 313
      'manage_catalogFilter',
      'manage_catalogAdvanced',
314 315

      'manage_catalogReindex', 'manage_catalogFoundItems',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
316 317
      'manage_catalogClear',
      'manage_main',
318 319 320 321 322 323
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
324 325
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
326
      'getFilterableMethodList',],
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
     ['Anonymous', 'Manager']),

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

    )

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

    # Z SQL Methods
    { 'id'      : 'sql_catalog_produce_reserved',
      'description' : 'A method to produce new uid values in advance',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_clear_reserved',
      'description' : 'A method to clear reserved uid values',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
352 353 354 355 356
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
357 358 359 360 361
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
362 363
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
364 365 366 367 368 369 370 371
      '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' },
372 373 374
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
375 376
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
377 378 379
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
380 381
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
382 383
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
384 385 386
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
387
    { 'id'      : 'sql_record_object_list',
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
      '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
407 408 409 410 411
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
    { 'id'      : 'sql_search_tables',
      'description' : 'Tables to join in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getTableIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_result_keys',
      'description' : 'Keys to display in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getResultColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_count_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_path',
      'description' : 'Get a catalog brain by path',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_uid',
      'description' : 'Get a catalog brain by uid',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_tables',
      'description' : 'Method to get the main catalog tables',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_schema',
      'description' : 'Method to get the main catalog schema',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
447 448 449 450 451
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    { 'id'      : 'sql_unique_values',
      'description' : 'Find unique disctinct values in a column',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_paths',
      'description' : 'List all object paths in catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_keyword_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
467 468 469 470 471
    { 'id'      : 'sql_catalog_datetime_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    { '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' },
487 488 489 490 491
    { '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' },
492 493 494 495 496 497 498 499 500
    { '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' },
501 502 503 504 505
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
506 507 508 509 510 511 512 513 514 515 516
    { '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' },
517 518 519 520 521 522 523
    { 'id': 'sql_catalog_table_vote_scripts',
      'title': 'Table vote scripts',
      'description': 'Scripts helping column mapping resolution',
      'type': 'multiple selection',
      'select_variable' : 'getPythonMethodIds',
      'mode': 'w' },

524 525
  )

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

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

570 571 572 573 574 575 576
  # 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
577

578 579 580 581 582 583 584 585 586 587
  manage_catalogView = DTMLFile('dtml/catalogView',globals())
  manage_catalogFilter = DTMLFile('dtml/catalogFilter',globals())
  manage_catalogFind = DTMLFile('dtml/catalogFind',globals())
  manage_catalogAdvanced = DTMLFile('dtml/catalogAdvanced', globals())

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

593 594 595 596 597 598 599 600 601 602 603 604 605 606
  def getSQLCatalogRoleKeysList(self):
    """
    Return the list of role keys.
    """
    return [tuple([y.strip() for y in x.split('|')]) \
              for x in self.sql_catalog_role_keys]

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

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

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

  def manage_importProperties(self, file):
    """
      Import properties from an XML file.
    """
    f = open(file)
    try:
      doc = parse(f)
      root = doc.documentElement
      try:
        for prop in root.getElementsByTagName("property"):
          id = prop.getAttribute("id")
          type = prop.getAttribute("type")
          if not id or not hasattr(self, id):
679
            raise CatalogError, 'unknown property id %r' % (id,)
680
          if type not in ('str', 'tuple'):
681
            raise CatalogError, 'unknown property type %r' % (type,)
682 683 684 685
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
686
                value = str(text.data)
687 688 689 690 691 692
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
693
                raise CatalogError, 'unknown item type %r' % (item_type,)
694 695
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
696
                  value.append(str(text.data))
697 698 699 700
                  break
            value = tuple(value)

          setattr(self, id, value)
701

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

723 724 725 726 727 728 729
  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__)))
730 731 732

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
733
    self.security_uid_index = None
734 735

  security.declarePrivate('getSecurityUid')
736
  def getSecurityUid(self, wrapped_object):
737 738
    """
      Cache a uid for each security permission
739 740 741 742 743 744 745 746 747 748 749 750 751
      Return a tuple with a security uid (string) and a new tuple content the
      roles and users if not exist already.

     With the roles of object, search the security_uid associate in the
     catalog_innodb:
      - if the security not exist a security uid is generated with id_tool
        or security_uid_index property and
        return the new security_uid and the tuple contains the new roles
        to add the roles in roles_and_user table of the database.
      - if the security exist the security uid is returned and the second
        element is None for not recreate the security in roles_and_user
        table of the database.
                                   
752 753 754 755
      We try to create a unique security (to reduce number of lines)
      and to assign security only to root document
    """
    # Get security information
756
    allowed_roles_and_users = tuple(wrapped_object.allowedRolesAndUsers())
757 758
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
759
      self._clearSecurityCache()
760
    elif self.security_uid_dict.has_key(allowed_roles_and_users):
761
      return (self.security_uid_dict[allowed_roles_and_users], None)
762 763 764 765 766 767 768 769
    # If the id_tool is there, it is better to use it, it allows
    # to create many new security uids by the same time
    # because with this tool we are sure that we will have 2 different
    # uids if two instances are doing this code in the same time
    id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
    if id_tool is not None:
      default = 1
      # We must keep compatibility with existing sites
770 771
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
772 773 774 775
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
776
          default = previous_security_uid
777 778
      security_uid = int(id_tool.generateNewId(id_generator='uid',
          id_group='security_uid_index', default=default))
779 780 781 782 783 784 785 786 787
    else:
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is None:
        previous_security_uid = 0
      # At some point, it was a Length
      if isinstance(previous_security_uid, Length):
        previous_security_uid = previous_security_uid()
      security_uid = previous_security_uid + 1
      self.security_uid_index = security_uid
788 789
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
790

791 792 793 794 795 796 797 798 799 800 801
  def getRoleAndSecurityUidList(self):
    """
      Return a list of 2-tuples, suitable for direct use in a zsqlmethod.
      Goal: make it possible to regenerate a table containing this data.
    """
    result = []
    extend = result.extend
    for role_list, security_uid in getattr(aq_base(self), 'security_uid_dict', {}).iteritems():
      extend([(role, security_uid) for role in role_list])
    return result

Jean-Paul Smets's avatar
Jean-Paul Smets committed
802 803 804 805 806 807
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
808
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
809 810
      try:
        method()
811 812
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
813
      except:
814
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
815
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
816
        raise
817

818
    # Reserved uids have been removed.
819
    self.clearReserved()
820

821 822 823 824
    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()
825

826
    # Remove the cache of catalog schema.
827 828
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
829

830
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
831

832 833 834 835 836 837 838 839 840 841
  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()])

842 843 844 845 846 847
  def clearReserved(self):
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
Romain Courteaud's avatar
Romain Courteaud committed
848 849 850 851 852
    try:
      method()
    except ConflictError:
      raise
    except:
853
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
854 855 856
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
857
    self._last_clear_reserved_time += 1
858

859
  def getRecordForUid(self, uid):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
860 861 862 863
    """
    Get an object by UID
    Note: brain is defined in Z SQL Method object
    """
864 865 866 867 868 869 870 871
    # this method used to be __getitem__(self, uid) but was found to hurt more
    # than it helped: It would be inadvertently called by 
    # (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
872 873 874 875
    method = getattr(self,  self.sql_getitem_by_uid)
    search_result = method(uid = uid)
    if len(search_result) > 0:
      return search_result[0]
876
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896

  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

897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
  def getCatalogSearchTableIds(self):
    """Return selected tables of catalog which are used in JOIN.
       catalaog is always first
    """
    search_tables = self.sql_search_tables
    if len(search_tables) > 0:
      if search_tables[0] != 'catalog':
        result = ['catalog']
        for t in search_tables:
          if t != 'catalog':
            result.append(t)
        self.sql_search_tables = result
    else:
      self.sql_search_tables = ['catalog']

    return self.sql_search_tables

914
  security.declarePublic('getCatalogSearchResultKeys')
915 916 917 918
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
919

920
  def _getCatalogSchema(self, table=None):
921 922 923
    # XXX: Using a volatile as a cache makes it impossible to flush
    # consistently on all connections containing the volatile. Another
    # caching scheme must be used here.
924
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
925

926 927 928 929 930 931 932 933
    if table not in catalog_schema_dict:
      result_list = []
      try:
        method_name = self.sql_catalog_schema
        method = getattr(self, method_name)
        search_result = method(table=table)
        for c in search_result:
          result_list.append(c.Field)
934 935
      except ConflictError:
        raise
936
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
937
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
938 939 940
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
941

942
    return catalog_schema_dict[table]
943

944 945
  @caching_instance_method(id='SQLCatalog.getColumnIds',
                           cache_factory='erp5_content_long')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
946 947
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
948 949 950
    Calls the show column method and returns dictionnary of
    Field Ids
    """
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
    keys = {}
    for table in self.getCatalogSearchTableIds():
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys[field] = None
        keys['%s.%s' % (table, field)] = None  # Is this inconsistent ?
    for related in self.getSQLCatalogRelatedKeyList():
      related_tuple = related.split('|')
      related_key = related_tuple[0].strip()
      keys[related_key] = None
    for scriptable in self.getSQLCatalogScriptableKeyList():
      scriptable_tuple = scriptable.split('|')
      scriptable = scriptable_tuple[0].strip()
      keys[scriptable] = None
    keys = list(keys.keys())
    keys.sort()
    return keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
968

969 970 971
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog.getColumnMap')
  @profiler_decorator
972
  @caching_instance_method(id='SQLCatalog.getColumnMap', cache_factory='erp5_content_long')
973
  @profiler_decorator
974 975 976 977 978
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
979 980 981 982 983 984
    result = {}
    for table in self.getCatalogSearchTableIds():
      for field in self._getCatalogSchema(table=table):
        result.setdefault(field, []).append(table)
        result.setdefault('%s.%s' % (table, field), []).append(table) # Is this inconsistent ?
    return result
985

Jean-Paul Smets's avatar
Jean-Paul Smets committed
986 987 988 989 990 991 992
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
993 994 995
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys['%s.%s' % (table, field)] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
996 997 998 999
    keys = keys.keys()
    keys.sort()
    return keys

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
  def getSortColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids that can be used for a sort
    """
    keys = {}
    for table in self.getTableIds():
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys['%s.%s' % (table, field)] = 1
    keys = keys.keys()
    keys.sort()
    return keys

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1014 1015 1016
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1017 1018 1019
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1020 1021
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1022 1023 1024
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1025
        keys.append(c[0])
1026 1027
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1028 1029
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1030 1031
    return keys

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
  def getUIDBuffer(self, force_new_buffer=False):
    global global_uid_buffer_dict
    klass = self.__class__
    assert klass._reserved_uid_lock.locked()
    assert getattr(self, 'aq_base', None) is not None
    instance_key = self.getPhysicalPath()
    if instance_key not in global_uid_buffer_dict:
      global_uid_buffer_dict[instance_key] = {}
    uid_buffer_dict = global_uid_buffer_dict[instance_key]
    thread_key = get_ident()
    if force_new_buffer or thread_key not in uid_buffer_dict:
      uid_buffer_dict[thread_key] = UidBuffer()
    return uid_buffer_dict[thread_key]
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1046
  # the cataloging API
1047 1048 1049
  def produceUid(self):
    """
      Produces reserved uids in advance
1050
    """
1051 1052 1053 1054
    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.
1055 1056 1057 1058
    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:
1059 1060 1061
      id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
      if id_tool is not None:
        if self._max_uid is None:
1062
          self._max_uid = Length(1)
1063
        uid_list = id_tool.generateNewIdList(id_generator='uid', id_group='catalog_uid',
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
                     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
1079
        instance_id = md5(str(random_factor_list)).hexdigest()
1080
        uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
1081
      uid_buffer.extend(uid_list)
1082

1083 1084 1085 1086 1087 1088
  def isIndexable(self):
    """
    This is required to check in many methods that
    the site root and zope root are indexable
    """
    zope_root = self.getZopeRoot()
1089
    site_root = self.getSiteRoot() # XXX-JPS - Why don't we use getPortalObject here ?
1090 1091 1092 1093 1094 1095

    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
1096

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
  def getSiteRoot(self):
    """
    Returns the root of the site
    """
    if withCMF:
      site_root = getToolByName(self, 'portal_url').getPortalObject()
    else:
      site_root = self.aq_parent
    return site_root

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

1117 1118 1119
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1120 1121
      with multiple ZEO clients on a single ZEO server.

1122
      The main risk is the following:
1123

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

1126
      - one reindexing node N1 starts reindexing f
1127

1128
      - another reindexing node N2 starts reindexing e
1129

1130 1131 1132
      - 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

1133
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1134
      with the risk of graph loops
1135
    """
1136
    if not self.isIndexable():
1137 1138
      return None

1139 1140 1141 1142
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1143 1144 1145
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1146
        if self._max_uid is None:
1147
          self._max_uid = Length(1)
1148 1149
        if uid > self._max_uid():
          self._max_uid.set(uid)
1150
        return long(uid)
1151 1152 1153 1154
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1155

1156 1157 1158
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1159
      if isinstance(urls, str):
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
        urls=(urls,)

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

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

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

    if urls:
1175
      if isinstance(urls, str):
1176 1177 1178 1179 1180 1181 1182
        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')

1183
  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1, urls=None):
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    """ 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`)))

1199
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1200
                          URL1=None, sql_catalog_id=None):
1201
    """ clears the whole enchilada """
1202 1203
    self.beforeCatalogClear()

1204 1205 1206
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1207
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1208
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1209 1210

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1211
    """ clears reserved uids """
1212 1213 1214
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1215
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1216
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253

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

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

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

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

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

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

1258 1259
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1260

1261 1262 1263 1264
  def catalogObjectList(self, object_list, method_id_list=None, 
                        disable_cache=0, check_uid=1, idxs=None):
    """Add objects to the Catalog by calling all SQL methods and
    providing needed arguments.
1265

1266 1267
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1268 1269

      disable_cache : do not use cache, so values will be computed each time,
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
                      only useful in some particular cases, most of the time
                      you don't need to use it.

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

    'uid' is the unique Catalog identifier for this object.
    
    Note that this method calls _catalogObjectList with fragments of
    the object list, because calling _catalogObjectList with too many
    objects at a time bloats the process's memory consumption, due to
    caching."""
    # XXX 300 is arbitrary.
1282 1283
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
                              method_id_list=method_id_list,
                              disable_cache=disable_cache,
                              check_uid=check_uid,
                              idxs=idxs)
    
  def _catalogObjectList(self, object_list, method_id_list=None, 
                         disable_cache=0, check_uid=1, idxs=None):
    """This is the real method to catalog objects.

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

1298
    if idxs not in (None, []):
1299 1300
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1301

1302
    if not self.isIndexable():
1303
      return
1304

1305 1306
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
    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)

1325 1326 1327 1328 1329
    # 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 = {}

1330
    for object in object_list:
1331 1332 1333 1334
      uid = getattr(aq_base(object), 'uid', None)
      # Several Tool objects have uid=0 (not 0L) from the beginning, but
      # we need an unique uid for each object.
      if uid is None or isinstance(uid, int) and uid == 0:
1335
        try:
1336
          object.uid = self.newUid()
1337 1338
        except ConflictError:
          raise
1339
        except:
1340
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1341
      elif check_uid:
1342
        if uid in assigned_uid_dict:
1343 1344
          raise ValueError('uid of %r is %r and '
              'is already assigned to %s in catalog !!! This can be fatal.' %
1345
              (object, uid, assigned_uid_dict[uid]))
1346

1347
        path = object.getPath()
1348
        index = path_uid_dict.get(path)
1349 1350 1351
        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)
1352 1353
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1354 1355
            raise ValueError('uid of %r changed from %r (property) to %r '
                '(catalog, by path) !!! This can be fatal' % (object, uid, index))
1356 1357 1358 1359
        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
1360
          if uid in uid_path_dict:
1361 1362 1363
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1364 1365 1366
          #LOG('catalogObject', 0, 'uid = %r, catalog_path = %r' % (uid, catalog_path))
          if catalog_path == "reserved":
            # Reserved line in catalog table
1367
            lock = self.__class__._reserved_uid_lock
1368
            try:
1369
              lock.acquire()
1370 1371
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1372 1373 1374 1375 1376 1377 1378 1379
                # 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.
1380
                try:
1381
                  uid_buffer.remove(uid)
1382 1383
                except ValueError:
                  pass
1384
            finally:
1385
              lock.release()
1386 1387
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1388
            # can be due to path length
1389
            if len(path) > MAX_PATH_LEN:
1390
              LOG('SQLCatalog', ERROR, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))
1391

1392
            LOG('SQLCatalog', ERROR,
1393 1394 1395 1396 1397
                'uid of %r changed from %r to %r as old one is assigned'
                ' to %s in catalog !!! This can be fatal.' % (
                  object, uid, object.uid, catalog_path))
            raise ValueError('uid of %r is %r and '
                'is already assigned to %s in catalog !!! This can be fatal.' %
1398
                (object, uid, catalog_path))
1399 1400 1401
            uid = object.uid

        assigned_uid_dict[uid] = object
1402

1403 1404
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1405
    econtext = getEngine().getContext()
1406 1407
    argument_cache = {}

1408
    try:
1409
      if not disable_cache:
1410
        enableReadOnlyTransactionCache(self)
1411

1412
      filter_dict = self.filter_dict
1413
      catalogged_object_list_cache = {}
1414
      for method_name in method_id_list:
1415 1416 1417 1418 1419
        # 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:
1420
          filter = filter_dict[method_name]
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
          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:
1451
              if expression_cache_key_list:
1452 1453 1454 1455
                # 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
1456 1457
                # objects but we could also use over multiple transactions
                # if this can improve performance significantly
1458 1459 1460
                # ZZZ - we could find a way to compute this once only
                cache_key = tuple(object.getProperty(key) for key
                                  in expression_cache_key_list)
1461
                try:
1462 1463 1464
                  if expression_result_cache[cache_key]:
                    append(object)
                  continue
1465
                except KeyError:
1466 1467 1468
                  pass
              if old_context:
                result = expression(self.getExpressionContext(object))
1469
              else:
1470
                econtext.setLocal('context', object)
1471
                result = expression(econtext)
1472
              if expression_cache_key_list:
1473
                expression_result_cache[cache_key] = result
1474 1475
              if result:
                append(object)
1476

1477
        if not catalogged_object_list:
1478
          continue
1479

1480 1481
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1482
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1483
          # Build the dictionnary of values
1484
          arguments = method.arguments_src.split()
1485 1486 1487
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1488 1489
        else:
          arguments = []
1490
        kw = {}
1491 1492 1493 1494
        for arg in arguments:
          value_list = []
          append = value_list.append
          for object in catalogged_object_list:
1495
            argument_cache_key = (object.uid, arg)
1496
            try:
1497
              value = argument_cache[argument_cache_key]
1498
            except KeyError:
1499
              try:
1500 1501 1502 1503 1504 1505
                value = getattr(object, arg, None)
                if callable(value):
                  value = value()
              except ConflictError:
                raise
              except:
1506
                LOG('SQLCatalog', WARNING, 'Failed to call method %s on %r' %
1507
                    (arg, object), error=sys.exc_info())
1508 1509
                value = None
              if not disable_cache:
1510
                argument_cache[argument_cache_key] = value
1511 1512
            append(value)
          kw[arg] = value_list
1513

1514 1515 1516
        # Alter/Create row
        try:
          #start_time = DateTime()
1517
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1518 1519 1520 1521 1522 1523 1524
          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]))
1525

1526 1527 1528
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1529
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1530 1531 1532
              error=sys.exc_info())
          raise
    finally:
1533
      if not disable_cache:
1534
        disableReadOnlyTransactionCache(self)
1535

1536 1537
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1538

1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
  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
1551 1552 1553 1554
    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
1555
      return self.uncatalogObject(path=path,uid=uid)
1556 1557 1558
    method = getattr(self, method_name)
    method(uid = uid)

1559
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
    """
    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

    """
1572
    if not self.isIndexable():
1573 1574
      return None

1575 1576
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1577 1578
    methods = self.sql_uncatalog_object
    if uid is None:
1579
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1580
    for method_name in methods:
1581 1582
      # 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
1583
      method = getattr(self, method_name)
1584
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1585

1586 1587 1588 1589
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1590 1591
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1592

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
  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())
1604

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1605 1606 1607
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1608
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1609 1610 1611 1612 1613 1614 1615 1616

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

  def getUidForPath(self, path):
    """ Looks up into catalog table to convert path into uid """
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
    #try:
    if path is None:
      return None
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    search_result = method(path = path, uid_only=1)
    # If not empty, return first record
    if len(search_result) > 0:
      return long(search_result[0].uid)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1627 1628
      return None

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
  def getUidDictForPathList(self, path_list):
    """ Looks up into catalog table to convert path into uid """
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    path_uid_dict = {}
    try:
      search_result = method(path_list = path_list)
      # If not empty, return first record
      for result in search_result:
        path_uid_dict[result.path] = result.uid
    except ValueError, message:
      # This code is only there for backward compatibility
      # XXX this must be removed one day
      # This means we have the previous zsql method
      # and we must call the method for every path
      for path in path_list:
        search_result = method(path = path)
        if len(search_result) > 0:
          path_uid_dict[path] = search_result[0].uid
    return path_uid_dict

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1671 1672 1673 1674 1675 1676 1677 1678 1679
  def hasPath(self, path):
    """ Checks if path is catalogued """
    return self.getUidForPath(path) is not None

  def getPathForUid(self, uid):
    """ Looks up into catalog table to convert uid into path """
    try:
      if uid is None:
        return None
1680 1681 1682 1683
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1684 1685 1686 1687 1688 1689 1690 1691
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_uid)
      search_result = method(uid = uid)
      # If not empty return first record
      if len(search_result) > 0:
        return search_result[0].path
      else:
        return None
1692 1693
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1694 1695 1696
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1697
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
      return None

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

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

  def getMetadataForPath(self, path):
    """ Accesses a single record for a given path """
    try:
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_path)
      brain = method(path = path)[0]
      result = {}
      for k in brain.__record_schema__.keys():
        result[k] = getattr(brain,k)
      return result
1726 1727
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1728 1729 1730
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1731 1732
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1733 1734 1735 1736 1737 1738
      return None

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

1739 1740
  def getCatalogMethodIds(self,
      valid_method_meta_type_list=valid_method_meta_type_list):
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
    """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
1752 1753
            if not isinstance(id, str):
              id=id()
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
            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

1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
  def getPythonMethodIds(self):
    """
      Returns a list of all python scripts available in
      current sql catalog.
    """
    return self.getCatalogMethodIds(valid_method_meta_type_list=('Script (Python)', ))

  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog._getSQLCatalogRelatedKeyList')
  @profiler_decorator
  def _getSQLCatalogRelatedKeySet(self):
    column_map = self.getColumnMap()
    column_set = set(column_map)
    for related_key in self.sql_catalog_related_keys:
1779 1780
      split_entire_definition = related_key.split('|')
      if len(split_entire_definition) != 2:
1781
        LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (related_key, ))
1782 1783
        continue
      related_key_id = split_entire_definition[0].strip()
1784 1785 1786
      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)
1787
        if related_key_id in column_map:
1788
          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]))
1789
        else:
1790
          LOG('SQLCatalog', WARNING, 'Related key %r is declared more than once.' % (related_key_id, ))
1791 1792 1793
      column_set.add(related_key_id)
    return column_set

1794
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1795 1796
    """
    Return the list of related keys.
1797
    This method can be overidden in order to implement
1798 1799
    dynamic generation of some related keys.
    """
1800 1801
    if key_list is None:
      key_list = []
1802
    column_map = self._getSQLCatalogRelatedKeySet()
1803
    # Do not generate dynamic related key for acceptable_keys
1804
    dynamic_key_list = [k for k in key_list if k not in column_map]
1805
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1806 1807 1808
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1809 1810 1811
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1812 1813 1814 1815 1816
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1817

1818 1819
  @caching_instance_method(id='SQLCatalog.getTableIndex',
                           cache_factory='erp5_content_long')
1820 1821
  def getTableIndex(self, table):
    """
1822
    Return a map between index and column for a given table
1823
    """
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
    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,]
    return table_index.copy()
1835

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
  @profiler_decorator
  def isValidColumn(self, column_id):
    """
      Tells wether given name is or not an existing column.

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

1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
  @profiler_decorator
  def getRelatedKeyDefinition(self, key):
    """
      Returns the definition of given related key name if found, None
      otherwise.
    """
    try:
      result = related_key_definition_cache[key]
    except KeyError:
      result = None
      for entire_definition in self.getSQLCatalogRelatedKeyList([key]):
1859 1860
        split_entire_definition = entire_definition.split('|')
        if len(split_entire_definition) != 2:
1861
          LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (entire_definition, ))
1862 1863
          continue
        name, definition = [x.strip() for x in split_entire_definition]
1864 1865 1866 1867 1868 1869
        if name == key:
          result = definition
          break
      if result is not None:
        related_key_definition_cache[key] = result
    return result
1870

1871 1872 1873 1874 1875 1876
  @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:
1877
        LOG('SQLCatalog', WARNING, 'Malformed scriptable key definition: %r. Ignored.' % (scriptable_key_definition, ))
1878 1879 1880 1881
        continue
      key, script_id = [x.strip() for x in split_scriptable_key_definition]
      script = getattr(self, script_id, None)
      if script is None:
1882
        LOG('SQLCatalog', WARNING, 'Scriptable key %r script %r is missing.' \
1883 1884 1885 1886 1887 1888 1889 1890
            ' Skipped.' % (key, script_id))
      else:
        result[key] = script
    return result

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

1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
  @profiler_decorator
  def getColumnSearchKey(self, key, search_key_name=None):
    """
      Return a SearchKey instance for given key, using search_key_name
      as a SearchKey name if given, otherwise guessing from catalog
      configuration. If there is no search_key_name given and no
      SearchKey can be found, return None.

      Also return a related key definition string with following rules:
       - If returned SearchKey is a RelatedKey, value is its definition
       - Otherwise, value is None
    """
1903
    # Is key a "real" column or some related key ?
1904 1905 1906 1907 1908 1909
    related_key_definition = None
    if key in self.getColumnMap():
      search_key = self.getSearchKey(key, search_key_name)
    else:
      # Maybe a related key...
      related_key_definition = self.getRelatedKeyDefinition(key)
1910
      if related_key_definition is None:
Yusei Tahara's avatar
Yusei Tahara committed
1911 1912
        # Unknown
        search_key = None
1913 1914 1915
      else:
        # It's a related key
        search_key = self.getSearchKey(key, 'RelatedKey')
1916 1917
    return search_key, related_key_definition

1918 1919 1920
  def hasColumn(self, column):
    return self.getColumnSearchKey(column)[0] is not None

1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
  @profiler_decorator
  def getColumnDefaultSearchKey(self, key):
    """
      Return a SearchKey instance which would ultimately receive the value
      associated with given key.
    """
    search_key, related_key_definition = self.getColumnSearchKey(key)
    if search_key is None:
      result = None
    else:
      if related_key_definition is not None:
1932 1933
        search_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
1934 1935 1936 1937 1938 1939 1940 1941
    return search_key

  @profiler_decorator
  def buildSingleQuery(self, key, value, search_key_name=None, logical_operator=None, comparison_operator=None):
    """
      From key and value, determine the SearchKey to use and generate a Query
      from it.
    """
1942 1943 1944 1945 1946
    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
1947
      else:
1948
        if related_key_definition is None:
1949
          build_key = search_key
1950
        else:
1951 1952 1953
          build_key = search_key.getSearchKey(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_key_name=search_key_name)
1954 1955 1956
        result = build_key.buildQuery(value, logical_operator=logical_operator,
                                      comparison_operator=comparison_operator)
        if related_key_definition is not None:
1957 1958 1959
          result = search_key.buildQuery(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_value=result)
1960 1961
    else:
      result = script(value)
1962 1963 1964
    return result

  @profiler_decorator
1965
  def _buildQueryFromAbstractSyntaxTreeNode(self, node, search_key):
1966
    if node.isLeaf():
1967
      result = search_key.buildQuery(node.getValue(), comparison_operator=node.getComparisonOperator())
1968 1969 1970 1971 1972 1973 1974 1975 1976
    elif node.isColumn():
      result = self.buildQueryFromAbstractSyntaxTreeNode(node.getSubNode(), node.getColumnName())
    else:
      query_list = []
      value_dict = {}
      append = query_list.append
      for subnode in node.getNodeList():
        if subnode.isLeaf():
          value_dict.setdefault(subnode.getComparisonOperator(), []).append(subnode.getValue())
1977
        else:
1978
          subquery = self._buildQueryFromAbstractSyntaxTreeNode(subnode, search_key)
1979 1980
          if subquery is not None:
            append(subquery)
1981
      logical_operator = node.getLogicalOperator()
1982 1983 1984 1985
      if logical_operator == 'not':
        query_logical_operator = None
      else:
        query_logical_operator = logical_operator
1986
      for comparison_operator, value_list in value_dict.iteritems():
1987
        append(search_key.buildQuery(value_list, comparison_operator=comparison_operator, logical_operator=query_logical_operator))
1988 1989
      if logical_operator == 'not' or len(query_list) > 1:
        result = ComplexQuery(query_list, logical_operator=logical_operator)
1990 1991
      elif len(query_list) == 1:
        result = query_list[0]
1992
      else:
1993 1994 1995
        result = None
    return result

1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
  @profiler_decorator
  def buildQueryFromAbstractSyntaxTreeNode(self, node, key):
    """
      Build a query from given Abstract Syntax Tree (AST) node by recursing in
      its childs.
      This method calls itself recursively when walking the tree.

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

2008
      Expected node API is described in interfaces/abstract_syntax_node.py .
2009 2010 2011 2012
    """
    search_key, related_key_definition = self.getColumnSearchKey(key)
    if search_key is None:
      # Unknown, skip loudly
2013
      LOG('SQLCatalog', WARNING, 'Unknown column %r, skipped.' % (key, ))
2014
      result = None
2015 2016 2017 2018
    else:
      if related_key_definition is None:
        build_key = search_key
      else:
2019 2020
        build_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
2021 2022
      result = self._buildQueryFromAbstractSyntaxTreeNode(node, build_key)
      if related_key_definition is not None:
2023 2024 2025
        result = search_key.buildQuery(sql_catalog=self,
          related_key_definition=related_key_definition,
          search_value=result)
2026 2027
    return result

2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
  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)

  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)

2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
  @profiler_decorator
  def buildQuery(self, kw, ignore_empty_string=True, operator='and'):
    query_list = []
    append = query_list.append
    # unknown_column_dict: contains all (key, value) pairs which could not be
    # changed into queries. This is here for backward compatibility, because
    # scripts can invoke this method and expect extra parameters (such as
    # from_expression) to be handled. As they are normaly handled at
    # buildSQLQuery level, we must store them into final ComplexQuery, which
    # will handle them.
    unknown_column_dict = {}
    # implicit_table_list: contains all tables explicitely given as par of
    # column names with empty values. This is for backward compatibility. See
    # comment about empty values.
    implicit_table_list = []
2056 2057 2058
    # empty_value_dict: contains all keys whose value causes them to be
    # discarded.
    empty_value_dict = {}
2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
    for key, value in kw.iteritems():
      result = None
      if isinstance(value, dict_type_list):
        # Cast dict-ish types into plain dicts.
        value = dict(value)
      if ignore_empty_string and (
          value == ''
          or (isinstance(value, (list, tuple)) and len(value) == 0)
          or (isinstance(value, dict) and (
            'query' not in value
            or value['query'] == ''
            or (isinstance(value['query'], (list, tuple))
              and len(value['query']) == 0)))):
        # We have an empty value:
        # - do not create a query from it
        # - if key has a dot, add its left part to the list of "hint" tables
        #   This is for backward compatibility, when giving a mapped column
        #   with an empty value caused a join with catalog to appear in
        #   resulting where-expression)
        if '.' in key:
          implicit_table_list.append(key)
2080
        empty_value_dict[key] = value
2081
      else:
2082
        script = self.getScriptableKeyScript(key)
2083 2084 2085
        if isinstance(value, _Query):
          # Query instance: use as such, ignore key.
          result = value
2086 2087
        elif script is not None:
          result = script(value)
2088 2089 2090 2091
        elif isinstance(value, basestring):
          # String: parse using key's default search key.
          search_key = self.getColumnDefaultSearchKey(key)
          if search_key is not None:
2092
            abstract_syntax_tree = self._parseSearchText(search_key, value)
2093 2094 2095
            if abstract_syntax_tree is None:
              # Parsing failed, create a query from the bare string.
              result = self.buildSingleQuery(key, value)
2096
            else:
2097 2098 2099 2100 2101 2102 2103 2104
              result = self.buildQueryFromAbstractSyntaxTreeNode(abstract_syntax_tree, key)
        elif isinstance(value, dict):
          # Dictionnary: might contain the search key to use.
          search_key_name = value.get('key')
          # Backward compatibility: former "Keyword" key is now named
          # "KeywordKey".
          if search_key_name == 'Keyword':
            search_key_name = value['key'] = 'KeywordKey'
2105 2106 2107 2108
          # Backward compatibility: former "ExactMatch" is now only available
          # as "RawKey"
          elif search_key_name == 'ExactMatch':
            search_key_name = value['key'] = 'RawKey'
2109 2110 2111 2112 2113 2114 2115 2116 2117
          result = self.buildSingleQuery(key, value, search_key_name)
        else:
          # Any other type, just create a query. (can be a DateTime, ...)
          result = self.buildSingleQuery(key, value)
        if result is None:
          # No query could be created, emit a log, add to unknown column dict.
          unknown_column_dict[key] = value
        else:
          append(result)
2118 2119
    if len(empty_value_dict):
      LOG('SQLCatalog', WARNING, 'Discarding columns with empty values: %r' % (empty_value_dict, ))
2120
    if len(unknown_column_dict):
2121
      LOG('SQLCatalog', WARNING, 'Unknown columns %r, skipped.' % (unknown_column_dict.keys(), ))
2122
    return ComplexQuery(query_list, logical_operator=operator, unknown_column_dict=unknown_column_dict, implicit_table_list=implicit_table_list)
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142

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

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

      It does not preserve backward compatibility for:
        'sort-on' parameter
        'sort-on' property
        'sort-order' parameter
        'sort-order' property
    """
    order_by_list = []
    append = order_by_list.append
    if sort_on is not None:
      if order_by_expression is not None:
2143
        LOG('SQLCatalog', WARNING, 'order_by_expression (%r) and sort_on (%r) were given. Ignoring order_by_expression.' % (order_by_expression, sort_on))
2144 2145 2146 2147 2148
      if not isinstance(sort_on, (tuple, list)):
        sort_on = [[sort_on]]
      for item in sort_on:
        if isinstance(item, (tuple, list)):
          item = list(item)
2149
        else:
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168
          item = [item]
        if sort_order is not None and len(item) == 1:
          item.append(sort_order)
        if len(item) > 1:
          if item[1] in ('descending', 'reverse', 'DESC'):
            item[1] = 'DESC'
          else:
            item[1] = 'ASC'
          if len(item) > 2:
            if item[2] == 'int':
              item[2] = 'SIGNED'
        append(item)
    elif order_by_expression is not None:
      if not isinstance(order_by_expression, basestring):
        raise TypeError, 'order_by_expression must be a basestring instance. Got %r.' % (order_by_expression, )
      order_by_list = [[x.strip()] for x in order_by_expression.split(',')]
    return order_by_list

  @profiler_decorator
2169 2170
  def buildEntireQuery(self, kw, query_table='catalog', ignore_empty_string=1,
                       limit=None, extra_column_list=()):
2171
    group_by_list = kw.pop('group_by_list', kw.pop('group_by', kw.pop('group_by_expression', ())))
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199
    if isinstance(group_by_list, basestring):
      group_by_list = [x.strip() for x in group_by_list.split(',')]
    select_dict = kw.pop('select_dict', kw.pop('select_list', kw.pop('select_expression', None)))
    if isinstance(select_dict, basestring):
      if len(select_dict):
        real_select_dict = {}
        for column in select_dict.split(','):
          index = column.lower().find(' as ')
          if index != -1:
            real_select_dict[column[index + 4:].strip()] = column[:index].strip()
          else:
            real_select_dict[column.strip()] = None
        select_dict = real_select_dict
      else:
        select_dict = None
    elif isinstance(select_dict, (list, tuple)):
      select_dict = dict([(x, None) for x in select_dict])
    # Handle order_by_list
    order_by_list = kw.pop('order_by_list', None)
    sort_on = kw.pop('sort_on', None)
    sort_order = kw.pop('sort_order', None)
    order_by_expression = kw.pop('order_by_expression', None)
    if order_by_list is None:
      order_by_list = self.buildOrderByList(
        sort_on=sort_on,
        sort_order=sort_order,
        order_by_expression=order_by_expression
      )
2200
    else:
2201
      if sort_on is not None:
2202
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_on were given, ignoring sort_on.')
2203
      if sort_order is not None:
2204
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_order were given, ignoring sort_order.')
2205
      if order_by_expression is not None:
2206
        LOG('SQLCatalog', WARNING, 'order_by_list and order_by_expression were given, ignoring order_by_expression.')
2207 2208 2209 2210 2211
    # 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):
2212
      LOG('SQLCatalog', INFO, 'Giving where_expression a string value is deprecated.')
2213 2214 2215 2216 2217 2218
      # 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.
2219
    order_by_override_list = kw.pop('select_expression_key', ())
2220
    return EntireQuery(
2221 2222 2223 2224 2225 2226 2227 2228 2229
      query=self.buildQuery(kw, ignore_empty_string=ignore_empty_string),
      order_by_list=order_by_list,
      order_by_override_list=order_by_override_list,
      group_by_list=group_by_list,
      select_dict=select_dict,
      limit=limit,
      catalog_table_name=query_table,
      extra_column_list=extra_column_list,
      from_expression=from_expression)
2230 2231 2232 2233 2234 2235 2236 2237 2238

  @profiler_decorator
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
                          ignore_empty_string=1, only_group_columns=False,
                          limit=None, extra_column_list=(),
                          **kw):
    query = self.buildEntireQuery(kw, query_table=query_table,
      ignore_empty_string=ignore_empty_string, limit=limit,
      extra_column_list=extra_column_list)
2239 2240
    result = query.asSQLExpression(self, only_group_columns).asSQLExpressionDict()
    return result
2241

2242 2243 2244
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2245 2246 2247
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog._getSearchKeyDict')
  @profiler_decorator
2248
  @caching_instance_method(id='SQLCatalog._getSearchKeyDict', cache_factory='erp5_content_long')
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
  @profiler_decorator
  def _getSearchKeyDict(self):
    result = {}
    search_key_column_dict = {
      'KeywordKey': self.sql_catalog_keyword_search_keys,
      'FullTextKey': self.sql_catalog_full_text_search_keys,
      'DateTimeKey': self.sql_catalog_datetime_search_keys,
    }
    for key, column_list in search_key_column_dict.iteritems():
      for column in column_list:
        if column in result:
2260
          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))
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 2290 2291 2292
        else:
          result[column] = key
    return result

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

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

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

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

  @profiler_decorator
  def _queryResults(self, REQUEST=None, build_sql_query_method=None, **kw):
2293
    """ Returns a list of brains from a set of constraints on variables """
2294 2295 2296
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2297 2298 2299 2300 2301 2302 2303 2304 2305
    # XXX: decide if this should be made normal
    ENFORCE_SEPARATION = True
    if ENFORCE_SEPARATION:
      new_kw = {}
      # Some parameters must be propagated:
      for parameter_id in ('selection_domain', 'selection_report'):
        if parameter_id in kw:
          new_kw[parameter_id] = kw[parameter_id]
      kw = new_kw
2306 2307 2308
    kw['where_expression'] = query['where_expression']
    kw['sort_on'] = query['order_by_expression']
    kw['from_table_list'] = query['from_table_list']
2309
    kw['from_expression'] = query['from_expression']
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2310
    kw['limit_expression'] = query['limit_expression']
2311
    kw['select_expression'] = query['select_expression']
2312
    kw['group_by_expression'] = query['group_by_expression']
2313
    return kw
2314

2315 2316 2317
  def queryResults(self, sql_method, REQUEST=None, src__=0, build_sql_query_method=None, **kw):
    sql_kw = self._queryResults(REQUEST=REQUEST, build_sql_query_method=build_sql_query_method, **kw)
    return sql_method(src__=src__, **sql_kw)
Ivan Tyagov's avatar
Ivan Tyagov committed
2318
      
2319
  def searchResults(self, REQUEST=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2320
    """ Returns a list of brains from a set of constraints on variables """
2321
    method = getattr(self, self.sql_search_results)
2322
    return self.queryResults(method, REQUEST=REQUEST, extra_column_list=self.getCatalogSearchResultKeys(), **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2323 2324 2325

  __call__ = searchResults

2326
  def countResults(self, REQUEST=None, **kw):
2327
    """ Returns the number of items which satisfy the where_expression """
2328 2329
    # Get the search method
    method = getattr(self, self.sql_count_results)
2330
    return self.queryResults(method, REQUEST=REQUEST, extra_column_list=self.getCatalogSearchResultKeys(), only_group_columns=True, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2331

2332 2333 2334
  def isAdvancedSearchText(self, search_text):
    return isAdvancedSearchText(search_text, self.isValidColumn)

2335
  def recordObjectList(self, path_list, catalog=1):
2336
    """
2337
      Record the path of an object being catalogged or uncatalogged.
2338
    """
2339 2340
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2341

2342
  def deleteRecordedObjectList(self, uid_list=()):
2343 2344 2345 2346
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2347
    method(uid_list=uid_list)
2348

2349
  def readRecordedObjectList(self, catalog=1):
2350 2351 2352 2353
    """
      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)
2354
    return method(catalog=catalog)
Ivan Tyagov's avatar
Ivan Tyagov committed
2355
   
2356 2357 2358 2359 2360 2361 2362 2363
  # Filtering
  def manage_editFilter(self, REQUEST=None, RESPONSE=None, URL1=None):
    """
    This methods allows to set a filter on each zsql method called,
    so we can test if we should or not call a zsql method, so we can
    increase a lot the speed.
    """
    if withCMF:
2364
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2365

2366 2367 2368 2369
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2370

2371
      for id in method_id_list:
2372 2373 2374
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2375

2376 2377 2378 2379 2380
        if REQUEST.has_key('%s_box' % id):
          self.filter_dict[id]['filtered'] = 1
        else:
          self.filter_dict[id]['filtered'] = 0

2381 2382 2383 2384
        expression = REQUEST.get('%s_expression' % id, '').strip()
        self.filter_dict[id]['expression'] = expression
        if expression:
          self.filter_dict[id]['expression_instance'] = Expression(expression)
2385 2386 2387 2388 2389
        else:
          self.filter_dict[id]['expression_instance'] = None

        if REQUEST.has_key('%s_type' % id):
          list_type = REQUEST['%s_type' % id]
2390
          if isinstance(list_type, str):
2391 2392 2393 2394 2395
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2396 2397
        self.filter_dict[id]['expression_cache_key'] = \
          tuple(sorted(REQUEST.get('%s_expression_cache_key' % id, '').split()))
2398

2399 2400 2401 2402 2403 2404 2405 2406 2407 2408
    if RESPONSE and URL1:
      RESPONSE.redirect(URL1 + '/manage_catalogFilter?manage_tabs_message=Filter%20Changed')

  def isMethodFiltered(self, method_name):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      # Reset Filtet dict
2409
      if getattr(aq_base(self), 'filter_dict', None) is None:
2410 2411
        self.filter_dict = PersistentMapping()
        return 0
2412
      try:
2413
        return self.filter_dict[method_name]['filtered']
2414 2415
      except KeyError:
        return 0
2416 2417 2418
    return 0

  def getExpression(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2419
    """ Get the filter expression text for this method.
2420 2421
    """
    if withCMF:
2422
      if getattr(aq_base(self), 'filter_dict', None) is None:
2423 2424
        self.filter_dict = PersistentMapping()
        return ""
2425
      try:
2426
        return self.filter_dict[method_name]['expression']
2427 2428
      except KeyError:
        return ""
2429 2430
    return ""

2431 2432 2433 2434 2435 2436 2437 2438 2439
  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:
2440
        return ' '.join(self.filter_dict[method_name]['expression_cache_key'])
2441 2442 2443 2444
      except KeyError:
        return ""
    return ""

2445
  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2446
    """ Get the filter expression instance for this method.
2447 2448
    """
    if withCMF:
2449
      if getattr(aq_base(self), 'filter_dict', None) is None:
2450 2451
        self.filter_dict = PersistentMapping()
        return None
2452
      try:
2453
        return self.filter_dict[method_name]['expression_instance']
2454 2455
      except KeyError:
        return None
2456 2457
    return None

Rafael Monnerat's avatar
Rafael Monnerat committed
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
  def setFilterExpression(self, method_name, expression):
    """ Set the Expression for a certain method name. This allow set 
        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

Jérome Perrin's avatar
Jérome Perrin committed
2472 2473
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2474
      XXX deprecated
2475 2476
    """
    if withCMF:
2477
      if getattr(aq_base(self), 'filter_dict', None) is None:
2478 2479
        self.filter_dict = PersistentMapping()
        return 0
2480 2481 2482 2483
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2484 2485
    return 0

2486 2487 2488
  def getFilteredPortalTypeList(self, method_name):
    """ Returns the list of portal types which define
        the filter.
2489
      XXX deprecated
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
    """
    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 []
2500

Rafael Monnerat's avatar
Rafael Monnerat committed
2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519
  def getFilterDict(self):
    """
      Utility Method.
      Filter Dict is a dictionary and used at Python Scripts, 
      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

2520 2521 2522 2523 2524 2525
  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2526 2527 2528 2529
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2530 2531 2532 2533 2534 2535 2536 2537
      for method_id in methods:
        method_dict[method_id] = 1
    method_list = map(lambda method_id: getattr(self, method_id, None), method_dict.keys())
    return filter(lambda method: method is not None, method_list)

  def getExpressionContext(self, ob):
      '''
      An expression context provides names for TALES expressions.
2538
      XXX deprecated
2539 2540 2541 2542 2543
      '''
      if withCMF:
        data = {
            'here':         ob,
            'container':    aq_parent(aq_inner(ob)),
2544 2545 2546 2547
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
2548 2549 2550 2551 2552 2553 2554 2555 2556
            # 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,
2557 2558 2559 2560
            }
        return getEngine().getContext(data)


2561
InitializeClass(Catalog)
2562

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

2565 2566
from Query.Query import Query as _Query
from Query.SimpleQuery import SimpleQuery
Ivan Tyagov's avatar
Ivan Tyagov committed
2567
from Query.ComplexQuery import ComplexQuery
2568 2569 2570
from Query.AutoQuery import AutoQuery as Query

def NegatedQuery(query):
2571
  return ComplexQuery(query, logical_operator='not')
2572

2573 2574 2575 2576 2577 2578
def AndQuery(*args):
  return ComplexQuery(logical_operator='and', *args)

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

2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
allow_class(SimpleQuery)
allow_class(ComplexQuery)

import SearchKey
SEARCH_KEY_INSTANCE_POOL = {}
SEARCH_KEY_CLASS_CACHE = {}

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

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

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

verifyClass(ISearchKeyCatalog, Catalog)

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

  def Catalog_resetProfilerData(self):
    profiler_reset()

  Catalog.dumpProfilerData = Catalog_dumpProfilerData
  Catalog.resetProfilerData = Catalog_resetProfilerData
2623