SQLCatalog.py 97.3 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
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache, \
87
       disableReadOnlyTransactionCache, caching_instance_method
88
except ImportError:
89
  LOG('SQLCatalog', WARNING, 'Count not import caching_instance_method, expect slowness.')
90 91
  def doNothing(context):
    pass
92
  def caching_instance_method(*args, **kw):
93
    return lambda method: method
94 95
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
96 97 98 99

try:
  from Products.ERP5Type.TransactionalVariable import getTransactionalVariable
except ImportError:
100
  LOG('SQLCatalog', WARNING, 'Count not import getTransactionalVariable, expect slowness.')
101
  def getTransactionalVariable():
102 103 104 105 106 107 108 109 110 111 112 113
    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):
114
      transactional_cache = getTransactionalVariable()
115
      cache_id = self.cache_id
116
      try:
117
        result = transactional_cache[cache_id]
118
      except KeyError:
119 120
        result = transactional_cache[cache_id] = method(wrapped_self)
      return result
121 122
    return wrapper

123 124 125 126
try:
  from ZPublisher.HTTPRequest import record
except ImportError:
  dict_type_list = (dict, )
127 128
else:
  dict_type_list = (dict, record)
129 130


131
UID_BUFFER_SIZE = 300
132
OBJECT_LIST_SIZE = 300 # XXX 300 is arbitrary value of catalog object list
133
MAX_PATH_LEN = 255
134
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
135 136
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report',
                     'extra_key_list', )
137

138
valid_method_meta_type_list = ('Z SQL Method', 'LDIF Method', 'Script (Python)') # Nicer
139

140
manage_addSQLCatalogForm = DTMLFile('dtml/addSQLCatalog',globals())
141

142 143 144 145 146
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

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

158
  c = Catalog(id, title, self)
159 160 161 162
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)

163 164
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
165

Yoshinori Okuji's avatar
Yoshinori Okuji committed
166
  def __init__(self):
167
    """Initialize some variables.
168

169
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
170

171
      finished_buffer is used to hold reserved uids created by committed-transactions.
172

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

178 179 180 181 182 183 184 185
  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
186

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

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

204 205 206 207 208 209 210 211 212 213 214
  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
215

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

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

230
related_key_definition_cache = {}
231
related_key_warned_column_set = set()
232

233 234 235
class Catalog(Folder,
              Persistent,
              Acquisition.Implicit,
236
              ActiveObject,
237
              OFS.History.Historical):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
238 239 240 241
  """ An Object Catalog

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

  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

251 252
  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.
253 254 255
  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).
256 257 258
  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
259

260
 """
261

262 263
  implements(ISearchKeyCatalog)
  
264

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

298
  __ac_permissions__= (
299 300 301 302 303

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

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
304 305
      'manage_catalogFilter',
      'manage_catalogAdvanced',
306 307

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

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

527 528
  )

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

568 569 570 571 572 573
  # 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
574

575 576 577 578 579 580 581
  # 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
582

583 584 585 586 587 588 589 590 591 592
  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
593 594 595
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
596
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
597

598 599 600 601 602 603 604 605 606 607 608 609 610 611
  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]

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

          setattr(self, id, value)
706

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

728 729 730 731 732 733 734
  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__)))
735 736 737

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
738
    self.security_uid_index = None
739 740

  security.declarePrivate('getSecurityUid')
741
  def getSecurityUid(self, wrapped_object):
742 743
    """
      Cache a uid for each security permission
744 745 746 747 748 749 750 751 752 753 754 755 756
      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.
                                   
757 758 759 760
      We try to create a unique security (to reduce number of lines)
      and to assign security only to root document
    """
    # Get security information
761
    allowed_roles_and_users = tuple(wrapped_object.allowedRolesAndUsers())
762 763
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
764
      self._clearSecurityCache()
765
    elif self.security_uid_dict.has_key(allowed_roles_and_users):
766
      return (self.security_uid_dict[allowed_roles_and_users], None)
767 768 769 770 771 772 773 774
    # 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
775 776
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
777 778 779 780
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
781
          default = previous_security_uid
782 783
      security_uid = int(id_tool.generateNewId(id_generator='uid',
          id_group='security_uid_index', default=default))
784 785 786 787 788 789 790 791 792
    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
793 794
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
795

796 797 798 799 800 801 802 803 804 805 806
  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
807 808 809 810 811 812
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
813
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
814 815
      try:
        method()
816 817
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
818
      except:
819
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
820
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
821
        raise
822

823
    # Reserved uids have been removed.
824
    self.clearReserved()
825

826 827 828 829
    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()
830

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

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

843 844 845 846 847 848
  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
849 850 851 852 853
    try:
      method()
    except ConflictError:
      raise
    except:
854
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
855 856 857
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
858
    self._last_clear_reserved_time += 1
859

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

  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

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
  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

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

921
  def _getCatalogSchema(self, table=None):
922 923 924 925 926 927 928 929 930 931 932 933 934
    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)
    except ConflictError:
      raise
    except:
      LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
      pass
    return tuple(result_list)
935

936
  @caching_instance_method(id='SQLCatalog.getColumnIds',
937 938
    cache_factory='erp5_content_long',
  )
939
  def _getColumnIds(self):
940 941
    keys = set()
    add_key = keys.add
942 943 944
    for table in self.getCatalogSearchTableIds():
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
945 946
        add_key(field)
        add_key('%s.%s' % (table, field))  # Is this inconsistent ?
947 948
    for related in self.getSQLCatalogRelatedKeyList():
      related_tuple = related.split('|')
949
      add_key(related_tuple[0].strip())
950 951
    for scriptable in self.getSQLCatalogScriptableKeyList():
      scriptable_tuple = scriptable.split('|')
952 953
      add_key(scriptable_tuple[0].strip())
    return sorted(keys)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
954

955 956 957 958 959 960 961
  def getColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    return self._getColumnIds()[:]

962 963 964
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog.getColumnMap')
  @profiler_decorator
965 966 967
  @caching_instance_method(id='SQLCatalog.getColumnMap',
    cache_factory='erp5_content_long',
  )
968
  @profiler_decorator
969 970 971 972 973
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
974 975 976 977 978 979
    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
980

Jean-Paul Smets's avatar
Jean-Paul Smets committed
981 982 983 984 985 986 987
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
988 989 990
      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
991 992 993 994
    keys = keys.keys()
    keys.sort()
    return keys

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
  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
1009 1010 1011
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012 1013 1014
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1015 1016
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1017 1018 1019
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1020
        keys.append(c[0])
1021 1022
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1023 1024
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1025 1026
    return keys

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
  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
1041
  # the cataloging API
1042 1043 1044
  def produceUid(self):
    """
      Produces reserved uids in advance
1045
    """
1046 1047 1048 1049
    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.
1050 1051 1052 1053
    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:
1054 1055 1056
      id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
      if id_tool is not None:
        if self._max_uid is None:
1057
          self._max_uid = Length(1)
1058
        uid_list = id_tool.generateNewIdList(id_generator='uid', id_group='catalog_uid',
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
                     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
1074
        instance_id = md5(str(random_factor_list)).hexdigest()
1075
        uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
1076
      uid_buffer.extend(uid_list)
1077

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

    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
1091

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
  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

1112 1113 1114
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1115 1116
      with multiple ZEO clients on a single ZEO server.

1117
      The main risk is the following:
1118

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

1121
      - one reindexing node N1 starts reindexing f
1122

1123
      - another reindexing node N2 starts reindexing e
1124

1125 1126 1127
      - 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

1128
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1129
      with the risk of graph loops
1130
    """
1131
    if not self.isIndexable():
1132 1133
      return None

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

1151 1152 1153
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1154
      if isinstance(urls, str):
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
        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:
1170
      if isinstance(urls, str):
1171 1172 1173 1174 1175 1176 1177
        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')

1178
  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1, urls=None):
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    """ 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`)))

1194
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1195
                          URL1=None, sql_catalog_id=None):
1196
    """ clears the whole enchilada """
1197 1198
    self.beforeCatalogClear()

1199 1200 1201
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1202
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1203
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1204 1205

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1206
    """ clears reserved uids """
1207 1208 1209
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1210
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1211
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1212 1213 1214 1215 1216 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

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

1253 1254
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1255

1256 1257 1258 1259
  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.
1260

1261 1262
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1263 1264

      disable_cache : do not use cache, so values will be computed each time,
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
                      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."""
1276 1277
    for i in xrange(0, len(object_list), OBJECT_LIST_SIZE):
      self._catalogObjectList(object_list[i:i + OBJECT_LIST_SIZE],
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
                              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?"""
1289
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1290
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1291

1292
    if idxs not in (None, []):
1293 1294
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1295

1296
    if not self.isIndexable():
1297
      return
1298

1299 1300
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
    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)

1319 1320 1321 1322 1323
    # 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 = {}

1324
    for object in object_list:
1325 1326 1327 1328
      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:
1329
        try:
1330
          object.uid = self.newUid()
1331 1332
        except ConflictError:
          raise
1333
        except:
1334
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1335
      elif check_uid:
1336
        if uid in assigned_uid_dict:
1337 1338 1339 1340 1341 1342 1343
            error_message = 'uid of %r is %r and ' \
                  'is already assigned to %s in catalog !!! This can be fatal.' % \
                  (object, uid, assigned_uid_dict[uid])
            if not self.sql_catalog_raise_error_on_uid_check:
                LOG("SQLCatalog.catalogObjectList", ERROR, error_message)
            else:
                raise ValueError(error_message)
1344

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

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

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

        assigned_uid_dict[uid] = object
1405

1406 1407
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1408
    econtext = getEngine().getContext()
1409 1410
    argument_cache = {}

1411
    try:
1412
      if not disable_cache:
1413
        enableReadOnlyTransactionCache()
1414

1415
      filter_dict = self.filter_dict
1416
      catalogged_object_list_cache = {}
1417
      for method_name in method_id_list:
1418 1419 1420 1421 1422
        # 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:
1423
          filter = filter_dict[method_name]
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 1451 1452 1453
          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:
1454
              if expression_cache_key_list:
1455 1456 1457 1458
                # 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
1459 1460
                # objects but we could also use over multiple transactions
                # if this can improve performance significantly
1461 1462 1463
                # ZZZ - we could find a way to compute this once only
                cache_key = tuple(object.getProperty(key) for key
                                  in expression_cache_key_list)
1464
                try:
1465 1466 1467
                  if expression_result_cache[cache_key]:
                    append(object)
                  continue
1468
                except KeyError:
1469 1470 1471
                  pass
              if old_context:
                result = expression(self.getExpressionContext(object))
1472
              else:
1473
                econtext.setLocal('context', object)
1474
                result = expression(econtext)
1475
              if expression_cache_key_list:
1476
                expression_result_cache[cache_key] = result
1477 1478
              if result:
                append(object)
1479

1480
        if not catalogged_object_list:
1481
          continue
1482

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

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

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

1539 1540
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1541

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

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

    """
1575
    if not self.isIndexable():
1576 1577
      return None

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

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

1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
  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())
1607

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

  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 """
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
    #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
1630 1631
      return None

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 1668 1669 1670
  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
1671
          uid_path_dict[uid] = search_result[0].path
1672 1673
    return uid_path_dict

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1674 1675 1676 1677 1678 1679 1680 1681 1682
  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
1683 1684 1685 1686
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1687 1688 1689 1690 1691 1692 1693 1694
      # 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
1695 1696
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1697 1698 1699
    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
1700
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
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 1726 1727 1728
      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
1729 1730
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1731 1732 1733
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1734 1735
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1736 1737 1738 1739 1740 1741
      return None

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

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

1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
  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:
1782 1783
      split_entire_definition = related_key.split('|')
      if len(split_entire_definition) != 2:
1784
        LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (related_key, ))
1785 1786
        continue
      related_key_id = split_entire_definition[0].strip()
1787 1788 1789
      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)
1790
        if related_key_id in column_map:
1791
          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]))
1792
        else:
1793
          LOG('SQLCatalog', WARNING, 'Related key %r is declared more than once.' % (related_key_id, ))
1794 1795 1796
      column_set.add(related_key_id)
    return column_set

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

1812 1813 1814
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1815 1816 1817 1818 1819
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1820

1821
  @caching_instance_method(id='SQLCatalog.getTableIndex',
1822 1823
    cache_factory='erp5_content_long',
  )
1824
  def _getTableIndex(self, table):
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,]
1835 1836 1837 1838 1839 1840 1841
    return table_index

  def getTableIndex(self, table):
    """
    Return a map between index and column for a given table
    """
    return self._getTableIndex(table).copy()
1842

1843 1844 1845 1846 1847
  @profiler_decorator
  def isValidColumn(self, column_id):
    """
      Tells wether given name is or not an existing column.

1848 1849
      Warning: This includes "virtual" columns, such as related keys and
      scriptable keys.
1850
    """
1851
    result = self.getScriptableKeyScript(column_id) is not None
1852
    if not result:
1853 1854 1855
      result = column_id in self.getColumnMap()
      if not result:
        result = self.getRelatedKeyDefinition(column_id) is not None
1856 1857
    return result

1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
  @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]):
1869 1870
        split_entire_definition = entire_definition.split('|')
        if len(split_entire_definition) != 2:
1871
          LOG('SQLCatalog', WARNING, 'Malformed related key definition: %r. Ignored.' % (entire_definition, ))
1872 1873
          continue
        name, definition = [x.strip() for x in split_entire_definition]
1874 1875 1876 1877 1878 1879
        if name == key:
          result = definition
          break
      if result is not None:
        related_key_definition_cache[key] = result
    return result
1880

1881 1882 1883 1884 1885 1886
  @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:
1887
        LOG('SQLCatalog', WARNING, 'Malformed scriptable key definition: %r. Ignored.' % (scriptable_key_definition, ))
1888 1889 1890 1891
        continue
      key, script_id = [x.strip() for x in split_scriptable_key_definition]
      script = getattr(self, script_id, None)
      if script is None:
1892
        LOG('SQLCatalog', WARNING, 'Scriptable key %r script %r is missing.' \
1893 1894 1895 1896 1897 1898 1899 1900
            ' Skipped.' % (key, script_id))
      else:
        result[key] = script
    return result

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

1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
  @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
    """
1913
    # Is key a "real" column or some related key ?
1914 1915 1916 1917 1918 1919
    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)
1920
      if related_key_definition is None:
Yusei Tahara's avatar
Yusei Tahara committed
1921 1922
        # Unknown
        search_key = None
1923 1924 1925
      else:
        # It's a related key
        search_key = self.getSearchKey(key, 'RelatedKey')
1926 1927
    return search_key, related_key_definition

1928 1929 1930
  def hasColumn(self, column):
    return self.getColumnSearchKey(column)[0] is not None

1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
  @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:
1942 1943
        search_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
1944 1945 1946 1947 1948 1949 1950 1951
    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.
    """
1952 1953 1954 1955 1956
    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
1957
      else:
1958
        if related_key_definition is None:
1959
          build_key = search_key
1960
        else:
1961 1962 1963
          build_key = search_key.getSearchKey(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_key_name=search_key_name)
1964 1965 1966
        result = build_key.buildQuery(value, logical_operator=logical_operator,
                                      comparison_operator=comparison_operator)
        if related_key_definition is not None:
1967 1968 1969
          result = search_key.buildQuery(sql_catalog=self,
            related_key_definition=related_key_definition,
            search_value=result)
1970 1971
    else:
      result = script(value)
1972 1973 1974
    return result

  @profiler_decorator
1975
  def _buildQueryFromAbstractSyntaxTreeNode(self, node, search_key):
1976
    if node.isLeaf():
1977
      result = search_key.buildQuery(node.getValue(), comparison_operator=node.getComparisonOperator())
1978 1979 1980 1981 1982 1983 1984 1985 1986
    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())
1987
        else:
1988
          subquery = self._buildQueryFromAbstractSyntaxTreeNode(subnode, search_key)
1989 1990
          if subquery is not None:
            append(subquery)
1991
      logical_operator = node.getLogicalOperator()
1992 1993 1994 1995
      if logical_operator == 'not':
        query_logical_operator = None
      else:
        query_logical_operator = logical_operator
1996
      for comparison_operator, value_list in value_dict.iteritems():
1997
        append(search_key.buildQuery(value_list, comparison_operator=comparison_operator, logical_operator=query_logical_operator))
1998 1999
      if logical_operator == 'not' or len(query_list) > 1:
        result = ComplexQuery(query_list, logical_operator=logical_operator)
2000 2001
      elif len(query_list) == 1:
        result = query_list[0]
2002
      else:
2003 2004 2005
        result = None
    return result

2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
  @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).

2018
      Expected node API is described in interfaces/abstract_syntax_node.py .
2019
    """
2020 2021 2022 2023 2024 2025
    script = self.getScriptableKeyScript(key)
    if script is None:
      search_key, related_key_definition = self.getColumnSearchKey(key)
    else:
      search_key = SearchKeyWrapperForScriptableKey(key, script)
      related_key_definition = None
2026 2027
    if search_key is None:
      # Unknown, skip loudly
2028
      LOG('SQLCatalog', WARNING, 'Unknown column %r, skipped.' % (key, ))
2029
      result = None
2030 2031 2032 2033
    else:
      if related_key_definition is None:
        build_key = search_key
      else:
2034 2035
        build_key = search_key.getSearchKey(sql_catalog=self,
          related_key_definition=related_key_definition)
2036 2037
      result = self._buildQueryFromAbstractSyntaxTreeNode(node, build_key)
      if related_key_definition is not None:
2038 2039 2040
        result = search_key.buildQuery(sql_catalog=self,
          related_key_definition=related_key_definition,
          search_value=result)
2041 2042
    return result

2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
  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)

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070
  @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 = []
2071 2072 2073
    # empty_value_dict: contains all keys whose value causes them to be
    # discarded.
    empty_value_dict = {}
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
    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)
2095
        empty_value_dict[key] = value
2096
      else:
2097
        script = self.getScriptableKeyScript(key)
2098 2099 2100
        if isinstance(value, _Query):
          # Query instance: use as such, ignore key.
          result = value
2101 2102
        elif script is not None:
          result = script(value)
2103 2104 2105 2106
        elif isinstance(value, basestring):
          # String: parse using key's default search key.
          search_key = self.getColumnDefaultSearchKey(key)
          if search_key is not None:
2107
            abstract_syntax_tree = self._parseSearchText(search_key, value)
2108 2109 2110
            if abstract_syntax_tree is None:
              # Parsing failed, create a query from the bare string.
              result = self.buildSingleQuery(key, value)
2111
            else:
2112 2113 2114 2115 2116 2117 2118 2119
              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'
2120 2121 2122 2123
          # Backward compatibility: former "ExactMatch" is now only available
          # as "RawKey"
          elif search_key_name == 'ExactMatch':
            search_key_name = value['key'] = 'RawKey'
2124 2125 2126 2127 2128 2129 2130 2131 2132
          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)
2133 2134
    if len(empty_value_dict):
      LOG('SQLCatalog', WARNING, 'Discarding columns with empty values: %r' % (empty_value_dict, ))
2135
    if len(unknown_column_dict):
2136
      LOG('SQLCatalog', WARNING, 'Unknown columns %r, skipped.' % (unknown_column_dict.keys(), ))
2137
    return ComplexQuery(query_list, logical_operator=operator, unknown_column_dict=unknown_column_dict, implicit_table_list=implicit_table_list)
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157

  @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:
2158
        LOG('SQLCatalog', WARNING, 'order_by_expression (%r) and sort_on (%r) were given. Ignoring order_by_expression.' % (order_by_expression, sort_on))
2159 2160 2161 2162 2163
      if not isinstance(sort_on, (tuple, list)):
        sort_on = [[sort_on]]
      for item in sort_on:
        if isinstance(item, (tuple, list)):
          item = list(item)
2164
        else:
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
          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
2184 2185
  def buildEntireQuery(self, kw, query_table='catalog', ignore_empty_string=1,
                       limit=None, extra_column_list=()):
2186
    group_by_list = kw.pop('group_by_list', kw.pop('group_by', kw.pop('group_by_expression', ())))
2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
    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
      )
2215
    else:
2216
      if sort_on is not None:
2217
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_on were given, ignoring sort_on.')
2218
      if sort_order is not None:
2219
        LOG('SQLCatalog', WARNING, 'order_by_list and sort_order were given, ignoring sort_order.')
2220
      if order_by_expression is not None:
2221
        LOG('SQLCatalog', WARNING, 'order_by_list and order_by_expression were given, ignoring order_by_expression.')
2222 2223 2224 2225 2226
    # 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):
2227
      LOG('SQLCatalog', INFO, 'Giving where_expression a string value is deprecated.')
2228 2229 2230 2231 2232 2233
      # 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.
2234
    order_by_override_list = kw.pop('select_expression_key', ())
2235
    return EntireQuery(
2236 2237 2238 2239 2240 2241 2242 2243 2244
      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)
2245 2246 2247 2248 2249 2250 2251 2252 2253

  @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)
2254 2255
    result = query.asSQLExpression(self, only_group_columns).asSQLExpressionDict()
    return result
2256

2257 2258 2259
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2260 2261 2262
  @profiler_decorator
  @transactional_cache_decorator('SQLCatalog._getSearchKeyDict')
  @profiler_decorator
2263 2264 2265
  @caching_instance_method(id='SQLCatalog._getSearchKeyDict',
    cache_factory='erp5_content_long',
  )
2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
  @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:
2277
          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))
2278 2279
        else:
          result[column] = key
2280 2281 2282 2283 2284 2285
    for line in self.sql_catalog_search_keys:
      try:
        column, key = [x.strip() for x in line.split('|', 2)]
        result[column] = key
      except ValueError:
        LOG('SQLCatalog', WARNING, 'Wrong configuration for sql_catalog_search_keys: %r' % line)
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
    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):
2316
    """ Returns a list of brains from a set of constraints on variables """
2317 2318 2319
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2320 2321 2322 2323 2324 2325 2326 2327 2328
    # 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
2329 2330 2331
    kw['where_expression'] = query['where_expression']
    kw['sort_on'] = query['order_by_expression']
    kw['from_table_list'] = query['from_table_list']
2332
    kw['from_expression'] = query['from_expression']
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2333
    kw['limit_expression'] = query['limit_expression']
2334
    kw['select_expression'] = query['select_expression']
2335
    kw['group_by_expression'] = query['group_by_expression']
2336
    return kw
2337

2338 2339 2340
  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
2341
      
2342
  def searchResults(self, REQUEST=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2343
    """ Returns a list of brains from a set of constraints on variables """
2344
    method = getattr(self, self.sql_search_results)
2345
    return self.queryResults(method, REQUEST=REQUEST, extra_column_list=self.getCatalogSearchResultKeys(), **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2346 2347 2348

  __call__ = searchResults

2349
  def countResults(self, REQUEST=None, **kw):
2350
    """ Returns the number of items which satisfy the where_expression """
2351 2352
    # Get the search method
    method = getattr(self, self.sql_count_results)
2353
    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
2354

2355 2356 2357
  def isAdvancedSearchText(self, search_text):
    return isAdvancedSearchText(search_text, self.isValidColumn)

2358
  def recordObjectList(self, path_list, catalog=1):
2359
    """
2360
      Record the path of an object being catalogged or uncatalogged.
2361
    """
2362 2363
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2364

2365
  def deleteRecordedObjectList(self, uid_list=()):
2366 2367 2368 2369
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2370
    method(uid_list=uid_list)
2371

2372
  def readRecordedObjectList(self, catalog=1):
2373 2374 2375 2376
    """
      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)
2377
    return method(catalog=catalog)
Ivan Tyagov's avatar
Ivan Tyagov committed
2378
   
2379 2380 2381 2382 2383 2384 2385 2386
  # 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:
2387
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
2388

2389 2390 2391 2392
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2393

2394
      for id in method_id_list:
2395 2396 2397
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
2398

2399 2400 2401 2402 2403
        if REQUEST.has_key('%s_box' % id):
          self.filter_dict[id]['filtered'] = 1
        else:
          self.filter_dict[id]['filtered'] = 0

2404 2405 2406 2407
        expression = REQUEST.get('%s_expression' % id, '').strip()
        self.filter_dict[id]['expression'] = expression
        if expression:
          self.filter_dict[id]['expression_instance'] = Expression(expression)
2408 2409 2410 2411 2412
        else:
          self.filter_dict[id]['expression_instance'] = None

        if REQUEST.has_key('%s_type' % id):
          list_type = REQUEST['%s_type' % id]
2413
          if isinstance(list_type, str):
2414 2415 2416 2417 2418
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

2419 2420
        self.filter_dict[id]['expression_cache_key'] = \
          tuple(sorted(REQUEST.get('%s_expression_cache_key' % id, '').split()))
2421

2422 2423 2424 2425 2426 2427 2428 2429 2430 2431
    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
2432
      if getattr(aq_base(self), 'filter_dict', None) is None:
2433 2434
        self.filter_dict = PersistentMapping()
        return 0
2435
      try:
2436
        return self.filter_dict[method_name]['filtered']
2437 2438
      except KeyError:
        return 0
2439 2440 2441
    return 0

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

2454 2455 2456 2457 2458 2459 2460 2461 2462
  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:
2463
        return ' '.join(self.filter_dict[method_name]['expression_cache_key'])
2464 2465 2466 2467
      except KeyError:
        return ""
    return ""

2468
  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2469
    """ Get the filter expression instance for this method.
2470 2471
    """
    if withCMF:
2472
      if getattr(aq_base(self), 'filter_dict', None) is None:
2473 2474
        self.filter_dict = PersistentMapping()
        return None
2475
      try:
2476
        return self.filter_dict[method_name]['expression_instance']
2477 2478
      except KeyError:
        return None
2479 2480
    return None

Rafael Monnerat's avatar
Rafael Monnerat committed
2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
  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
2495 2496
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2497
      XXX deprecated
2498 2499
    """
    if withCMF:
2500
      if getattr(aq_base(self), 'filter_dict', None) is None:
2501 2502
        self.filter_dict = PersistentMapping()
        return 0
2503 2504 2505 2506
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2507 2508
    return 0

2509 2510 2511
  def getFilteredPortalTypeList(self, method_name):
    """ Returns the list of portal types which define
        the filter.
2512
      XXX deprecated
2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
    """
    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 []
2523

Rafael Monnerat's avatar
Rafael Monnerat committed
2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542
  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

2543 2544 2545 2546 2547 2548
  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2549 2550 2551 2552
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2553 2554 2555 2556 2557 2558 2559 2560
      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.
2561
      XXX deprecated
2562 2563 2564 2565 2566
      '''
      if withCMF:
        data = {
            'here':         ob,
            'container':    aq_parent(aq_inner(ob)),
2567 2568 2569 2570
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
2571 2572 2573 2574 2575 2576 2577 2578 2579
            # 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,
2580 2581 2582 2583
            }
        return getEngine().getContext(data)


2584
InitializeClass(Catalog)
2585

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

2588 2589
from Query.Query import Query as _Query
from Query.SimpleQuery import SimpleQuery
Ivan Tyagov's avatar
Ivan Tyagov committed
2590
from Query.ComplexQuery import ComplexQuery
2591 2592 2593
from Query.AutoQuery import AutoQuery as Query

def NegatedQuery(query):
2594
  return ComplexQuery(query, logical_operator='not')
2595

2596 2597 2598 2599 2600 2601
def AndQuery(*args):
  return ComplexQuery(logical_operator='and', *args)

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

2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627
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

2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654
class SearchKeyWrapperForScriptableKey(SearchKey.SearchKey.SearchKey):
  """
    This SearchKey is a simple wrapper around a ScriptableKey, so such script
    can be used in place of a regular SearchKey.
  """
  default_comparison_operator = None
  get_operator_from_value = False

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

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

2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672
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
2673