SQLCatalog.py 75.7 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL. All Rights Reserved.
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
#
##############################################################################

from Persistence import Persistent
import Acquisition
import ExtensionClass
18 19
import Globals
from Globals import DTMLFile, PersistentMapping
Jean-Paul Smets's avatar
Jean-Paul Smets committed
20
from string import lower, split, join
21
from thread import allocate_lock, get_ident
22 23 24
from OFS.Folder import Folder
from AccessControl import ClassSecurityInfo, getSecurityManager
from BTrees.OIBTree import OIBTree
25 26
from App.config import getConfiguration
from BTrees.Length import Length
27
from Shared.DC.ZRDB.TM import TM
Jean-Paul Smets's avatar
Jean-Paul Smets committed
28

29
from DateTime import DateTime
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from Products.PluginIndexes.common.randid import randid
from Acquisition import aq_parent, aq_inner, aq_base, aq_self
32
from zLOG import LOG, WARNING, INFO, TRACE, DEBUG
33
from ZODB.POSException import ConflictError
34
from DocumentTemplate.DT_Var import sql_quote
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35 36

import time
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37
import sys
38 39 40 41 42
import urllib
import string
from cStringIO import StringIO
from xml.dom.minidom import parse, parseString, getDOMImplementation
from xml.sax.saxutils import escape, quoteattr
43 44
import os
import md5
Yoshinori Okuji's avatar
Yoshinori Okuji committed
45
import threading
46
import types
47 48 49 50 51 52 53 54 55 56

try:
  from Products.PageTemplates.Expressions import SecureModuleImporter
  from Products.CMFCore.Expression import Expression
  from Products.PageTemplates.Expressions import getEngine
  from Products.CMFCore.utils import getToolByName
  withCMF = 1
except ImportError:
  withCMF = 0

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

62
try:
63
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache, disableReadOnlyTransactionCache, CachingMethod
64 65 66
except ImportError:
  def doNothing(context):
    pass
67 68 69 70 71 72 73 74
  class CachingMethod:
    """
      Dummy CachingMethod class.
    """
    def __init__(self, callable, **kw):
      self.function = callable
    def __call__(*opts, **kw):
      return self.function(*opts, **kw)
75 76
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
77

78
UID_BUFFER_SIZE = 300
79

80 81
valid_method_meta_type_list = ('Z SQL Method', 'Script (Python)')

82 83 84 85
full_text_search_modes = { 'natural': '',
                           'in_boolean_mode': 'IN BOOLEAN MODE',
                           'with_query_expansion': 'WITH QUERY EXPANSION' }

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
manage_addSQLCatalogForm=DTMLFile('dtml/addSQLCatalog',globals())

def manage_addSQLCatalog(self, id, title,
             vocab_id='create_default_catalog_',
             REQUEST=None):
  """Add a Catalog object
  """
  id=str(id)
  title=str(title)
  vocab_id=str(vocab_id)
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

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

104

105 106
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
107

Yoshinori Okuji's avatar
Yoshinori Okuji committed
108
  def __init__(self):
109
    """Initialize some variables.
110

111
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
112

113
      finished_buffer is used to hold reserved uids created by committed-transactions.
114

115
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
116
      invalid afterwards, so they may not be used by other transactions."""
117 118
    self.temporary_buffer = {}
    self.finished_buffer = []
119

120 121 122 123 124 125 126 127
  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
128

129 130 131 132 133 134 135
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
136

137 138 139 140 141 142 143 144
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
145

146 147 148 149 150 151 152 153 154 155 156
  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
157

158 159 160 161
  def pop(self):
    self._register()
    tid = get_ident()
    try:
162
      uid = self.temporary_buffer[tid].pop()
163
    except (KeyError, IndexError):
164 165
      uid = self.finished_buffer.pop()
    return uid
166

167 168 169
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
170
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
171 172

class Catalog(Folder, Persistent, Acquisition.Implicit, ExtensionClass.Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
173 174 175 176
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
177
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
178 179 180 181 182 183 184 185

  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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
195 196 197 198 199 200 201 202

  bgrain defined in meyhods...

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  meta_type = "SQLCatalog"
  icon='misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
  security = ClassSecurityInfo()

  manage_options = (
    {'label': 'Contents',       # TAB: Contents
     'action': 'manage_main',
     'help': ('OFSP','ObjectManager_Contents.stx')},
    {'label': 'Catalog',      # TAB: Catalogged Objects
     'action': 'manage_catalogView',
     'target': 'manage_main',
     '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',
     'target':'manage_main',
     'help':('ZCatalog','ZCatalog_Find-Items-to-ZCatalog.stx')},
    {'label': 'Advanced',       # TAB: Advanced
     'action': 'manage_catalogAdvanced',
     'target':'manage_main',
     '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'),}
    )

  __ac_permissions__=(

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

      'manage_catalogView', 'manage_catalogFind',
      'manage_catalogSchema', 'manage_catalogFilter',
      'manage_catalogAdvanced', 'manage_objectInformation',

      'manage_catalogReindex', 'manage_catalogFoundItems',
      'manage_catalogClear', 'manage_editSchema',
      'manage_reindexIndex', 'manage_main',
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
      'getpath', 'schema', 'names', 'columns', 'indexes', 'index_objects',
      'all_meta_types', 'valid_roles', 'resolve_url',
      'getobject', 'getObject', 'getObjectList', 'getCatalogSearchTableIds',
260
      'getFilterableMethodList', ],
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
     ['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' },
286 287 288 289 290
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
291 292
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
293 294 295 296 297 298 299 300
      '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' },
301 302 303
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
304 305
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
306 307 308
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
309 310
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
311 312
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
313 314 315
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
316
    { 'id'      : 'sql_record_object_list',
317 318 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 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
      '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' },
    { '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' },
    { 'id'      : 'sql_unique_values',
      'description' : 'Find unique disctinct values in a column',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_paths',
      'description' : 'List all object paths in catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_keyword_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { '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' },
    { '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' },
  )

  sql_catalog_produce_reserved = 'z_produce_reserved_uid_list'
  sql_catalog_clear_reserved = 'z_clear_reserved'
414
  sql_catalog_reserve_uid = 'z_reserve_uid'
415
  sql_catalog_object_list = ('z_catalog_object_list',)
416 417
  sql_uncatalog_object = ('z_uncatalog_object',)
  sql_clear_catalog = ('z_drop_catalog', 'z_create_catalog')
418 419
  sql_catalog_translation_list = 'z_catalog_translation_list'
  sql_delete_translation_list = 'z_delete_translation_list'
420
  sql_record_object_list = 'z_record_object_list'
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
  sql_read_recorded_object_list = 'z_read_recorded_object_list'
  sql_delete_recorded_object_list = 'z_delete_recorded_object_list'
  sql_search_results = 'z_search_results'
  sql_count_results = 'z_count_results'
  sql_getitem_by_path = 'z_getitem_by_path'
  sql_getitem_by_uid = 'z_getitem_by_uid'
  sql_catalog_tables = 'z_catalog_tables'
  sql_search_tables = ('catalog',)
  sql_catalog_schema = 'z_catalog_schema'
  sql_unique_values = 'z_unique_values'
  sql_catalog_paths = 'z_catalog_paths'
  sql_catalog_keyword_search_keys =  ('Description', 'Title', 'SearchableText')
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
  sql_catalog_related_keys = ()

440 441 442 443 444 445
  # 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
446

447 448 449 450 451 452 453
  # 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
454

455 456 457 458 459 460 461 462 463 464
  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
465 466 467 468
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping

469 470 471 472 473 474
  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')
475 476 477 478 479 480 481 482 483 484 485 486
    property_id_list = self.propertyIds()
    # Get properties and values
    property_list = []
    for property_id in property_id_list:
      value = self.getProperty(property_id)
      if value is not None:
        property_list.append((property_id, value))
    # Sort for easy diff
    property_list.sort(lambda x, y: cmp(x[0], y[0]))
    for property in property_list:
      property_id = property[0]
      value       = property[1]
487
      if isinstance(value, basestring):
488
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
489
      elif isinstance(value, (tuple, list)):
490 491 492
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
493
        for item in value:
494
          if isinstance(item, basestring):
495 496 497 498
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
499
        f.write('  </property>\n')
500 501 502
    # 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'):
503 504
      filter_list = []
      for filter_id in self.filter_dict.keys():
505
        filter_definition = self.filter_dict[filter_id]
506 507 508 509 510 511 512
        filter_list.append((filter_id, filter_definition))
      # Sort for easy diff
      filter_list.sort(lambda x, y: cmp(x[0], y[0]))
      for filter_item in filter_list:
        filter_id  = filter_item[0]
        filter_def = filter_item[1]
        if not filter_def['filtered']:
513 514
          # If a filter is not activated, no need to output it.
          continue
515
        if not filter_def['expression']:
516 517
          # If the expression is not specified, meaningless to specify it.
          continue
518
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
519
        # For now, portal types are not exported, because portal types are too specific to each site.
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
    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):
541
            raise CatalogError, 'unknown property id %r' % (id,)
542
          if type not in ('str', 'tuple'):
543
            raise CatalogError, 'unknown property type %r' % (type,)
544 545 546 547
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
548
                value = str(text.data)
549 550 551 552 553 554
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
555
                raise CatalogError, 'unknown item type %r' % (item_type,)
556 557
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
558
                  value.append(str(text.data))
559 560 561 562
                  break
            value = tuple(value)

          setattr(self, id, value)
563

564 565 566
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
567
          id = str(filt.getAttribute("id"))
568 569 570 571 572 573 574 575 576 577 578 579
          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
580 581 582 583 584 585 586 587 588 589
      finally:
        doc.unlink()
    finally:
      f.close()

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
    self.security_uid_index = 0

  security.declarePrivate('getSecurityUid')
590
  def getSecurityUid(self, wrapped_object):
591 592 593 594 595 596 597
    """
      Cache a uid for each security permission

      We try to create a unique security (to reduce number of lines)
      and to assign security only to root document
    """
    # Get security information
598
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
599 600 601 602
    # Sort it
    allowed_roles_and_users = list(allowed_roles_and_users)
    allowed_roles_and_users.sort()
    allowed_roles_and_users = tuple(allowed_roles_and_users)
603 604
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
605 606 607 608 609 610 611
      self._clearSecurityCache()
    if self.security_uid_dict.has_key(allowed_roles_and_users):
      return (self.security_uid_dict[allowed_roles_and_users], None)
    self.security_uid_index = self.security_uid_index + 1
    self.security_uid_dict[allowed_roles_and_users] = self.security_uid_index
    return (self.security_uid_index, allowed_roles_and_users)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
612 613 614 615 616 617
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
618
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
619 620
      try:
        method()
621 622
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
623
      except:
624
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
625
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
626
        pass
627

628
    # Reserved uids have been removed.
629
    self.clearReserved()
630

631 632 633 634 635
    # 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)
636
      method(uid = [self._max_uid()])
637

638
    # Remove the cache of catalog schema.
639 640
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
641

642
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
643

644 645 646 647 648 649
  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
650 651 652 653 654
    try:
      method()
    except ConflictError:
      raise
    except:
655
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
656 657 658
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
659
    self._last_clear_reserved_time += 1
660

Jean-Paul Smets's avatar
Jean-Paul Smets committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
  def __getitem__(self, uid):
    """
    Get an object by UID
    Note: brain is defined in Z SQL Method object
    """
    method = getattr(self,  self.sql_getitem_by_uid)
    search_result = method(uid = uid)
    if len(search_result) > 0:
      return search_result[0]
    else:
      return None

  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

692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
  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

709
  security.declarePublic('getCatalogSearchResultKeys')
710 711 712 713
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
714

715 716
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
717

718 719 720 721 722 723 724 725 726
    if table not in catalog_schema_dict:
      result_list = []
      try:
        method_name = self.sql_catalog_schema
        method = getattr(self, method_name)
        #LOG('_getCatalogSchema', 0, 'method_name = %r, method = %r, table = %r' % (method_name, method, table))
        search_result = method(table=table)
        for c in search_result:
          result_list.append(c.Field)
727 728
      except ConflictError:
        raise
729
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
730
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
731 732 733
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
734

735
    return catalog_schema_dict[table]
736

Jean-Paul Smets's avatar
Jean-Paul Smets committed
737 738
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
739 740 741
    Calls the show column method and returns dictionnary of
    Field Ids
    """
742
    def _getColumnIds():
743 744 745 746 747 748 749 750 751 752 753 754 755
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
          keys[field] = 1
          keys['%s.%s' % (table, field)] = 1  # Is this inconsistent ?
      for related in self.getSqlCatalogRelatedKeyList():
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
        keys[related_key] = 1
      keys = keys.keys()
      keys.sort()
      return keys
756
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_duration=None)()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
757

758 759 760 761 762
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
763
    def _getColumnMap():
764 765 766 767 768 769 770 771 772 773 774
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
          key = field
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table)
          key = '%s.%s' % (table, key)
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table) # Is this inconsistent ?
      return keys
775
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_duration=None)()
776

Jean-Paul Smets's avatar
Jean-Paul Smets committed
777 778 779 780 781 782 783
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
784 785 786
      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
787 788 789 790 791 792 793
    keys = keys.keys()
    keys.sort()
    return keys

  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
794 795 796
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
797 798
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
799 800 801
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
802
        keys.append(c[0])
803 804
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
805 806
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
807 808 809
    return keys

  # the cataloging API
810 811 812
  def produceUid(self):
    """
      Produces reserved uids in advance
813
    """
814 815 816 817 818
    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.
    if klass._local_clear_reserved_time != self._last_clear_reserved_time:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
819
      self._v_uid_buffer = UidBuffer()
820
      klass._local_clear_reserved_time = self._last_clear_reserved_time
821
    elif getattr(self, '_v_uid_buffer', None) is None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
822
      self._v_uid_buffer = UidBuffer()
823
    if len(self._v_uid_buffer) == 0:
824 825
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
826 827 828 829 830 831 832 833
      # Generate an instance id randomly. Note that there is a small possibility that this
      # would conflict with others.
      random_factor_list = [time.time(), os.getpid(), os.times()]
      try:
        random_factor_list.append(os.getloadavg())
      except (OSError, AttributeError): # AttributeError is required under cygwin
        pass
      instance_id = md5.new(str(random_factor_list)).hexdigest()
834 835
      uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
      self._v_uid_buffer.extend(uid_list)
836

837 838 839
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
840 841
      with multiple ZEO clients on a single ZEO server.

842
      The main risk is the following:
843

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

846
      - one reindexing node N1 starts reindexing f
847

848
      - another reindexing node N2 starts reindexing e
849

850 851 852
      - 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

853
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
854
      with the risk of graph loops
855
    """
856 857 858 859 860 861 862 863 864 865 866 867
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
      site_root = getToolByName(self, 'portal_url').getPortalObject()
    else:
      zope_root = self.getPhysicalRoot()
      site_root = self.aq_parent

    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
    site_indexable = int(getattr(site_root, 'isIndexable', 1))
    if not (root_indexable and site_indexable):
      return None

868 869 870 871
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
872 873
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
874 875 876 877 878 879
        # Vincent added this 2006/01/25
        #if uid > 4294967296: # 2**32
        #if uid > 10000000: # arbitrary level : below it's normal, above it's suspicious
        #   LOG('SQLCatalog', WARNING, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,))
        #   raise RuntimeError, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,)
        # end
880 881 882 883 884 885 886 887 888
        if self._max_uid is None:
          self._max_uid = Length()
        if uid > self._max_uid():
          self._max_uid.set(uid)
        return uid
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
889

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
      if isinstance(urls, types.StringType):
        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:
      if isinstance(urls, types.StringType):
        urls=(urls,)

      for url in urls:
        self.aq_parent.uncatalog_object(url, sql_catalog_id=self.id)

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

  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1):
    """ clear the catalog, then re-index everything """
    elapse = time.time()
    c_elapse = time.clock()

    self.aq_parent.refreshCatalog(clear=1, sql_catalog_id=self.id)

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

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

933
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
934
                          URL1=None, sql_catalog_id=None):
935 936 937 938
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
939
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
940
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
941 942

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
943
    """ clears reserved uids """
944 945 946
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
947
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
948
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985

  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
986
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
987 988 989 990 991 992 993 994 995
    """
    Adds an object to the Catalog by calling
    all SQL methods and providing needed arguments.

    'object' is the object to be cataloged

    'uid' is the unique Catalog identifier for this object

    """
996
    self.catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
997

998
  def catalogObjectList(self, object_list, method_id_list=None, disable_cache=0,
999
                              check_uid=1):
1000 1001 1002 1003
    """
      Add objects to the Catalog by calling
      all SQL methods and providing needed arguments.

1004 1005 1006 1007 1008 1009 1010
      method_id_list : specify which method should be used. If not
                       set it will take the default value of portal_catalog

      disable_cache : do not use cache, so values will be computed each time,
                      only usefull in some particular cases, most of the time
                      you don't need to use it

1011 1012 1013 1014 1015 1016 1017 1018
      Each element of 'object_list' is an object to be cataloged

      'uid' is the unique Catalog identifier for this object

      WARNING: This method assumes that currently all objects are being reindexed from scratch.

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

1022 1023
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
1024
      site_root = getToolByName(self, 'portal_url').getPortalObject()
1025 1026
    else:
      zope_root = self.getPhysicalRoot()
1027
      site_root = self.aq_parent
1028

1029
    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
1030 1031
    site_indexable = int(getattr(site_root, 'isIndexable', 1))
    if not (root_indexable and site_indexable):
1032 1033
      return

1034
    for object in object_list:
1035
      path = object.getPath()
1036
      if not getattr(aq_base(object), 'uid', None):
1037
        try:
1038
          object.uid = self.newUid()
1039 1040
        except ConflictError:
          raise
1041
        except:
1042
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1043
      elif check_uid:
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
        uid = object.uid
        path = object.getPath()
        index = self.getUidForPath(path)
        try:
          index = int(index)
        except TypeError:
          pass
        if index is not None and index < 0:
          raise CatalogError, 'A negative uid %d is used for %s. Your catalog is broken. Recreate your catalog.' % (index, path)
        if index:
          if uid != index:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1055
            LOG('SQLCatalog', WARNING, 'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, index))
1056 1057 1058 1059 1060 1061
            uid = index
            object.uid = uid
        else:
          # Make sure no duplicates - ie. if an object with different path has same uid, we need a new uid
          # This can be very dangerous with relations stored in a category table (CMFCategory)
          # This is why we recommend completely reindexing subobjects after any change of id
1062
          catalog_path = self.getPathForUid(uid)
1063 1064 1065 1066 1067 1068
          #LOG('catalogObject', 0, 'uid = %r, catalog_path = %r' % (uid, catalog_path))
          if catalog_path == "reserved":
            # Reserved line in catalog table
            klass = self.__class__
            try:
              klass._reserved_uid_lock.acquire()
1069
              if getattr(self, '_v_uid_buffer', None) is not None:
1070 1071 1072 1073 1074 1075 1076 1077
                # 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.
1078 1079 1080 1081
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1082 1083 1084 1085
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1086 1087 1088 1089
            # can be due to path length
            if len(path) > 255:
              LOG('SQLCatalog', WARNING, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))

1090
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1091 1092
            LOG('SQLCatalog', WARNING,
                'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid))
1093

1094 1095
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1096
    econtext_cache = {}
1097
    argument_cache = {}
1098
    expression_cache = {}
1099

1100
    try:
1101
      if not disable_cache:
1102
        enableReadOnlyTransactionCache(self)
1103

1104
      method_kw_dict = {}
1105
      for method_name in method_id_list:
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
        kw = {}
        if self.isMethodFiltered(method_name) and self.filter_dict.has_key(method_name):
          catalogged_object_list = []
          type_list = self.filter_dict[method_name]['type']
          expression = self.filter_dict[method_name]['expression_instance']
          for object in object_list:
            # We will check if there is an filter on this
            # method, if so we may not call this zsqlMethod
            # for this object
            portal_type = object.getPortalType()
            if type_list and portal_type not in type_list:
              continue
            elif expression is not None:
              expression_key = (object.uid, self.filter_dict[method_name]['expression'])
1120
              try:
1121
                result = expression_cache[expression_key]
1122
              except KeyError:
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
                try:
                  econtext = econtext_cache[object.uid]
                except KeyError:
                  econtext = econtext_cache[object.uid] = self.getExpressionContext(object)
                result = expression_cache[expression_key] = expression(econtext)
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
1133

1134 1135
        if len(catalogged_object_list) == 0:
          continue
1136

1137
        method_kw_dict[method_name] = kw
1138

1139 1140 1141 1142 1143 1144 1145 1146 1147
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
        if method.meta_type == "Z SQL Method":
          # Build the dictionnary of values
          arguments = method.arguments_src
          for arg in split(arguments):
            value_list = []
            append = value_list.append
            for object in catalogged_object_list:
1148
              try:
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
                value = argument_cache[(object.uid, arg)]
              except KeyError:
                try:
                  value = getattr(object, arg, None)
                  if callable(value):
                    value = value()
                except ConflictError:
                  raise
                except:
                  value = None
1159 1160
                if not disable_cache:
                  argument_cache[(object.uid, arg)] = value
1161 1162
              append(value)
            kw[arg] = value_list
1163

1164
      for method_name in method_id_list:
1165 1166 1167 1168
        if method_name not in method_kw_dict:
          continue
        kw = method_kw_dict[method_name]
        method = getattr(self, method_name)
1169
        method = aq_base(method).__of__(site_root.portal_catalog) # Use method in
1170 1171 1172 1173
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1174
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
          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]))
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1185
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1186 1187 1188
              error=sys.exc_info())
          raise
    finally:
1189
      if not disable_cache:
1190
        disableReadOnlyTransactionCache(self)
1191

1192
  if psyco is not None: psyco.bind(catalogObjectList)
1193

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
  def uncatalogObject(self, path):
    """
    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

    """
1207
    #LOG('Uncatalog object:',0,str(path))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1208

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1209 1210 1211 1212 1213 1214
    uid = self.getUidForPath(path)
    methods = self.sql_uncatalog_object
    for method_name in methods:
      method = getattr(self, method_name)
      try:
        method(uid = uid)
1215 1216
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1217 1218 1219
      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
1220 1221
        LOG('SQLCatalog', WARNING,
            'could not uncatalog object %s uid %s with method %s' % (path, uid, method_name))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1222

1223 1224 1225 1226 1227
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
    return self.catalogObjectList(object_list, method_id_list = (method_name,))
1228

1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
  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())
1240

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
    return method()

  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 """
    try:
      if path is None:
        return None
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_path)
1258
      search_result = method(path = path, uid_only=1)
1259
      # If not empty, return first record
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1260 1261 1262 1263
      if len(search_result) > 0:
        return search_result[0].uid
      else:
        return None
1264 1265
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1266 1267 1268
    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
1269
      LOG('SQLCatalog', WARNING, "could not find uid from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
      return None

  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
1281 1282 1283 1284
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1285 1286 1287 1288 1289 1290 1291 1292
      # 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
1293 1294
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1295 1296 1297
    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
1298
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
      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
1327 1328
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1329 1330 1331
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1332 1333
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1334 1335 1336 1337 1338 1339
      return None

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

1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
  def getCatalogMethodIds(self):
    """Find Z SQL methods in the current folder and above
    This function return a list of ids.
    """
    ids={}
    have_id=ids.has_key

    while self is not None:
      if hasattr(self, 'objectValues'):
        for o in self.objectValues(valid_method_meta_type_list):
          if hasattr(o,'id'):
            id=o.id
1352 1353
            if not isinstance(id, str):
              id=id()
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
            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

1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
  def _quoteSQLString(self, value):
    """Return a quoted string of the value.
    """
    if hasattr(value, 'ISO'):
      value = value.ISO()
    elif hasattr(value, 'strftime'):
      value = value.strftime('%Y-%m-%d %H:%M:%S')
    else:
      value = sql_quote(str(value))
    return value

1376 1377 1378
  def getSqlCatalogRelatedKeyList(self, **kw):
    """
    Return the list of related keys.
1379
    This method can be overidden in order to implement
1380 1381
    dynamic generation of some related keys.
    """
1382 1383 1384 1385 1386 1387 1388 1389 1390
    # Do not generate dynamic related key for acceptable_keys
    dynamic_key_list = kw.keys()
    dynamic_key_list = [k for k in dynamic_key_list \
        if k not in self.getColumnMap().keys()]
    dynamic_kw = {}
    for key in dynamic_key_list:
      dynamic_kw[key] = kw[key]

    dynamic_list = self.getDynamicRelatedKeyList(**dynamic_kw)
1391 1392 1393
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1394
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
1395
                          ignore_empty_string=1, **kw):
1396
    """ Builds a complex SQL query to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1397 1398 1399 1400 1401 1402 1403
    # Get search arguments:
    if REQUEST is None and (kw is None or kw == {}):
      # We try to get the REQUEST parameter
      # since we have nothing handy
      try: REQUEST=self.REQUEST
      except AttributeError: pass

1404
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1405 1406 1407 1408
    # If kw is not set, then use REQUEST instead
    if kw is None or kw == {}:
      kw = REQUEST

1409
    acceptable_key_map = self.getColumnMap()
1410
    acceptable_keys = acceptable_key_map.keys()
1411 1412
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1413
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1414
    multivalue_keys = self.sql_catalog_multivalue_keys
1415
    
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
    
    # Compute "sort_index", which is a sort index, or none:
    if kw.has_key('sort-on'):
      sort_index=kw['sort-on']
    elif hasattr(self, 'sort-on'):
      sort_index=getattr(self, 'sort-on')
    elif kw.has_key('sort_on'):
      sort_index=kw['sort_on']
    else: sort_index=None

    # Compute the sort order
    if kw.has_key('sort-order'):
      so=kw['sort-order']
    elif hasattr(self, 'sort-order'):
      so=getattr(self, 'sort-order')
    elif kw.has_key('sort_order'):
      so=kw['sort_order']
    else: so=None

    # We must now turn sort_index into
    # a dict with keys as sort keys and values as sort order
    if isinstance(sort_index, basestring):
      sort_index = [(sort_index, so)]
    elif not isinstance(sort_index, (list, tuple)):
      sort_index = None
    
    # if we have a sort index, we must take it into account to get related
    # keys.
    if sort_index:
      related_key_kw = dict(kw)
      for sort_info in sort_index:
        related_key_kw.setdefault(sort_info[0], '')
      related_tuples = self.getSqlCatalogRelatedKeyList(**related_key_kw)
    else:
      related_tuples = self.getSqlCatalogRelatedKeyList(**kw)
    
1452
    # Define related maps
1453 1454
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
1455 1456 1457 1458
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1459
    related_table_list = {}
1460
    table_rename_index = 0
1461
    related_methods = {} # related methods which need to be used
1462 1463 1464 1465
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1466
      #LOG('related_tuples', 0, str(join_tuple))
1467
      related_keys.append(key)
1468
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1469
      method_id = join_tuple[2]
1470
      table_list = tuple(join_tuple[0].split(','))
1471
      related_method[key] = method_id
1472
      related_table_list[key] = table_list
1473 1474
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1475
      if not related_table_map.has_key((table_list,method_id)):
1476
        map_list = []
1477
        for table_id in table_list:
1478
          map_list.append((table_id,
1479 1480
             "related_%s_%s" % (table_id, table_rename_index))) # We add an index in order to alias tables in the join
          table_rename_index += 1 # and prevent name conflicts
1481
        related_table_map[(table_list,method_id)] = map_list
1482

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1483 1484
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1485
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1486 1487 1488
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1489
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1490
            kw[key] = REQUEST[key]
1491
      # Let us try first not to use this
1492 1493 1494
      #for key in related_keys:
      #  if REQUEST.has_key(key):
      #    kw[key] = REQUEST[key]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1495

1496
    # Let us start building the where_expression
1497
    # and select_expression
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1498
    if kw:
1499
      where_expression = []
1500 1501 1502
      select_expression = []
      if kw.has_key('select_expression'):
        select_expression.append(kw['select_expression'])
1503
      from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1504 1505 1506

      sort_on = None
      if sort_index is not None:
1507 1508
        new_sort_index = []
        for sort in sort_index:
1509 1510 1511
          if len(sort) == 2:
            new_sort_index.append((sort[0], sort[1], None))
          elif len(sort) == 3:
1512 1513
            new_sort_index.append(sort)
        sort_index = new_sort_index
1514 1515
        try:
          new_sort_index = []
1516
          for (key , so, as_type) in sort_index:
1517 1518 1519 1520 1521 1522
            key_is_acceptable = key in acceptable_keys # Only calculate once
            key_is_related = key in related_keys
            if key_is_acceptable or key_is_related:
              if key_is_related: # relation system has priority (ex. security_uid)
                # We must rename the key
                method_id = related_method[key]
1523 1524 1525 1526
                table_list = related_table_list[key]
                if not related_methods.has_key((table_list,method_id)):
                  related_methods[(table_list,method_id)] = 1
                # Prepend renamed table name
1527
                key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1528 1529 1530 1531
              elif key_is_acceptable:
                if key.find('.') < 0:
                  # if the key is only used by one table, just append its name
                  if len(acceptable_key_map[key]) == 1 :
1532
                    key = '%s.%s' % (acceptable_key_map[key][0], key)
1533 1534
                  # query_table specifies what table name should be used by default
                  elif query_table:
1535
                    key = '%s.%s' % (query_table, key)
1536 1537 1538 1539 1540
                  elif key == 'uid':
                    # uid is always ambiguous so we can only change it here
                    key = 'catalog.uid'
                # Add table to table dict
                from_table_dict[acceptable_key_map[key][0]] = acceptable_key_map[key][0] # We use catalog by default
1541
              if as_type == 'int':
1542
                key = 'CAST(%s AS SIGNED)' % key
1543
              if so in ('descending', 'reverse', 'DESC'):
1544
                new_sort_index.append('%s DESC' % key)
1545
              else:
1546
                new_sort_index.append('%s' % key)
1547 1548
          sort_index = join(new_sort_index,',')
          sort_on = str(sort_index)
1549 1550
        except ConflictError:
          raise
1551
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1552
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new sort index', error=sys.exc_info())
1553
          sort_on = ''
1554

1555 1556 1557 1558 1559 1560
      # Rebuild keywords to behave as new style query (_usage='toto:titi' becomes {'toto':'titi'})
      new_kw = {}
      usage_len = len('_usage')
      for k, v in kw.items():
        if k.endswith('_usage'):
          new_k = k[0:-usage_len]
1561 1562 1563 1564
          if not new_kw.has_key(new_k):
            new_kw[new_k] = {}
          if not isinstance(new_kw[new_k], dict):
            new_kw[new_k] = {'query': new_kw[new_k]}
1565
          split_v = v.split(':')
1566 1567 1568 1569
          new_kw[new_k] = {split_v[0]: split_v[1]}
        else:
          if not new_kw.has_key(k):
            new_kw[k] = v
1570
          else:
1571 1572 1573 1574
            new_kw[k]['query'] = v
      kw = new_kw
      #LOG('new kw', 0, str(kw))
      # We can now consider that old style query is changed into new style
1575 1576
      for key in kw.keys(): # Do not use kw.items() because this consumes much more memory
        value = kw[key]
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1577
        if key not in ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1578
          # Make sure key belongs to schema
1579 1580 1581 1582 1583 1584
          key_is_acceptable = key in acceptable_keys # Only calculate once
          key_is_related = key in related_keys
          if key_is_acceptable or key_is_related:
            if key_is_related: # relation system has priority (ex. security_uid)
              # We must rename the key
              method_id = related_method[key]
1585 1586 1587 1588
              table_list = related_table_list[key]
              if not related_methods.has_key((table_list,method_id)):
                related_methods[(table_list,method_id)] = 1
              # Prepend renamed table name
1589
              base_key = key
1590
              key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1591 1592 1593 1594
              if base_key in keyword_search_keys:
                keyword_search_keys.append(key)
              if base_key in full_text_search_keys:
                full_text_search_keys.append(key)
1595 1596 1597 1598 1599 1600
            elif key_is_acceptable:
              if key.find('.') < 0:
                # if the key is only used by one table, just append its name
                if len(acceptable_key_map[key]) == 1 :
                  key = acceptable_key_map[key][0] + '.' + key
                # query_table specifies what table name should be used by default
1601 1602
                elif query_table and \
                    '%s.%s' % (query_table, key) in acceptable_keys:
1603
                  key = '%s.%s' % (query_table, key)
1604 1605 1606 1607 1608
                elif key == 'uid':
                  # uid is always ambiguous so we can only change it here
                  key = 'catalog.uid'
              # Add table to table dict
              from_table_dict[acceptable_key_map[key][0]] = acceptable_key_map[key][0] # We use catalog by default
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1609
            # Default case: variable equality
1610
            if isinstance(value, basestring) or isinstance(value, DateTime):
1611
              # For security.
1612
              value = self._quoteSQLString(value)
1613
              if value != '' or not ignore_empty_string:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1614
                if '%' in value:
1615
                  where_expression.append("%s LIKE '%s'" % (key, value))
1616
                elif value.startswith('='):
1617
                  where_expression.append("%s = '%s'" % (key, value[1:]))
1618
                elif value.startswith('>='):
1619
                  where_expression.append("%s >= '%s'" % (key, value[2:]))
1620
                elif value.startswith('<='):
1621
                  where_expression.append("%s <= '%s'" % (key, value[2:]))
1622
                elif value.startswith('>'):
1623
                  where_expression.append("%s > '%s'" % (key, value[1:]))
1624
                elif value.startswith('<'):
1625
                  where_expression.append("%s < '%s'" % (key, value[1:]))
1626
                elif value.startswith('!='):
1627
                  where_expression.append("%s != '%s'" % (key, value[2:]))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1628 1629
                elif key in keyword_search_keys:
                  # We must add % in the request to simulate the catalog
1630
                  where_expression.append("%s LIKE '%%%s%%'" % (key, value))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1631 1632
                elif key in full_text_search_keys:
                  # We must add % in the request to simulate the catalog
1633 1634 1635 1636 1637 1638
                  # we first check if there is a special search_mode for this key
                  # incl. table name, or for all keys of that name,
                  # or there is a search_mode supplied for all fulltext keys
                  # or we fall back to natural mode
                  search_mode=kw.get('search_mode_%s' % key) \
                      or kw.get('search_mode_%s' % key.replace('.','_')) \
1639
                      or ('.' in key and kw.get('search_mode_%s' % key.split('.')[1])) \
1640 1641 1642
                      or kw.get('search_mode', 'natural')
                  if search_mode is not None:
                    search_mode=search_mode.lower()
Bartek Górny's avatar
Bartek Górny committed
1643
                  mode = full_text_search_modes.get(search_mode,'')
1644
                  where_expression.append("MATCH %s AGAINST ('%s' %s)" % (key, value, mode))
1645
                  # we return relevance as Table_Key_relevance
1646
                  select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.replace('.','_')))
1647 1648
                  # and for simplicity as Key_relevance
                  if '.' in key:
1649
                    select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.split('.')[1]))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1650
                else:
1651
                  where_expression.append("%s = '%s'" % (key, value))
1652
            elif isinstance(value, (list, tuple)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1653 1654 1655
              # We have to create an OR from tuple or list
              query_item = []
              for value_item in value:
1656
                if value_item != '' or not ignore_empty_string:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1657 1658
                  # we consider empty string as Non Significant
                  # also for lists
1659 1660
                  if isinstance(value_item, (int, float, long)):
                    query_item.append("%s = %s" % (key, value_item))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1661
                  else:
1662
                    # For security.
1663
                    value_item = self._quoteSQLString(value_item)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1664
                    if '%' in value_item:
1665
                      query_item.append("%s LIKE '%s'" % (key, value_item))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1666 1667
                    elif key in keyword_search_keys:
                      # We must add % in the request to simulate the catalog
1668
                      query_item.append("%s LIKE '%%%s%%'" % (key, value_item))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1669 1670
                    elif key in full_text_search_keys:
                      # We must add % in the request to simulate the catalog
1671 1672 1673 1674 1675 1676
                      # we first check if there is a special search_mode for this key
                      # incl. table name, or for all keys of that name,
                      # or there is a search_mode supplied for all fulltext keys
                      # or we fall back to natural mode
                      search_mode=kw.get('search_mode_%s' % key) \
                          or kw.get('search_mode_%s' % key.replace('.','_')) \
1677
                          or ('.' in key and kw.get('search_mode_%' % key.split('.')[1])) \
1678 1679 1680
                          or kw.get('search_mode', 'natural')
                      if search_mode is not None:
                        search_mode=search_mode.lower()
1681
                      mode = full_text_search_modes.get(search_mode, '')
1682
                      query_item.append("MATCH %s AGAINST ('%s')" % (key, value, mode))
1683
                      # we return relevance as Table_Key_relevance
1684
                      select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.replace('.','_')))
1685 1686
                      # and for simplicity as Key_relevance
                      if '.' in key:
1687
                        select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.split('.')[1]))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1688
                    else:
1689
                      query_item.append("%s = '%s'" % (key, value_item))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1690
              if len(query_item) > 0:
1691
                where_expression.append('(%s)' % join(query_item, ' OR '))
1692
            elif isinstance(value, dict):
1693
              # We are in the case of a complex query
1694
              query_item = []
1695
              query_value = value['query']
1696
              if not isinstance(query_value, (list, tuple)):
1697
                query_value = [query_value]
1698
              operator_value = sql_quote(value.get('operator', 'or'))
1699
              range_value = value.get('range')
1700

1701
              if range_value :
1702 1703
                query_min = self._quoteSQLString(min(query_value))
                query_max = self._quoteSQLString(max(query_value))
1704
                if range_value == 'min' :
1705
                  query_item.append("%s >= '%s'" % (key, query_min))
1706
                elif range_value == 'max' :
1707
                  query_item.append("%s < '%s'" % (key, query_max))
1708
                elif range_value == 'minmax' :
1709
                  query_item.append("%s >= '%s' and %s < '%s'" % (key, query_min, key, query_max))
1710
                elif range_value == 'minngt' :
1711
                  query_item.append("%s >= '%s' and %s <= '%s'" % (key, query_min, key, query_max))
1712
                elif range_value == 'ngt' :
1713
                  query_item.append("%s <= '%s'" % (key, query_max))
1714 1715
              else :
                for query_value_item in query_value :
1716
                  query_item.append("%s = '%s'" % (key, self._quoteSQLString(query_value_item)))
1717
              if len(query_item) > 0:
1718
                where_expression.append('(%s)' % join(query_item, ' %s ' % operator_value))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1719
            else:
1720
              where_expression.append("%s = %s" % (key, self._quoteSQLString(value)))
1721 1722
          elif key in topic_search_keys:
            # ERP5 CPS compatibility
1723
            topic_operator = 'or'
1724
            if isinstance(value, dict):
1725
              topic_operator = sql_quote(value.get('operator', 'or'))
1726
              value = value['query']
1727
            if isinstance(value, basestring):
1728 1729 1730 1731 1732 1733 1734 1735 1736
              topic_value = [value]
            else:
              topic_value = value # list or tuple
            query_item = []
            for topic_key in topic_value:
              if topic_key in acceptable_keys:
                if topic_key.find('.') < 0:
                  # if the key is only used by one table, just append its name
                  if len(acceptable_key_map[topic_key]) == 1 :
1737
                    topic_key = '%s.%s' % (acceptable_key_map[topic_key][0], topic_key)
1738 1739
                  # query_table specifies what table name should be used
                  elif query_table:
1740
                    topic_key = '%s.%s' % (query_table, topic_key)
1741
                # Add table to table dict
1742
                from_table_dict[acceptable_key_map[topic_key][0]] = acceptable_key_map[topic_key][0] # We use catalog by default
1743
                query_item.append("%s = 1" % topic_key)
1744
            # Join
1745
            if len(query_item) > 0:
1746
              where_expression.append('(%s)' % join(query_item, ' %s ' % topic_operator))
1747 1748
      # Calculate extra where_expression based on required joins
      for k, tid in from_table_dict.items():
1749
        if k != query_table:
1750 1751
          where_expression.append('%s.uid = %s.uid' % (query_table, tid))
      # Calculate extra where_expressions based on related definition
1752
      for (table_list, method_id) in related_methods.keys():
1753 1754 1755
        related_method = getattr(self, method_id, None)
        if related_method is not None:
          table_id = {'src__' : 1} # Return query source, do not evaluate
1756
          table_id['query_table'] = query_table
1757
          table_index = 0
1758
          for t_tuple in related_table_map[(table_list,method_id)]:
1759 1760 1761 1762
            table_id['table_%s' % table_index] = t_tuple[1] # table_X is set to mapped id
            from_table_dict[t_tuple[1]] = t_tuple[0]
            table_index += 1
          where_expression.append(related_method(**table_id))
1763
      # Concatenate expressions
1764
      if kw.get('where_expression'):
1765
        if len(where_expression) > 0:
1766
          where_expression = "(%s) AND (%s)" % (kw['where_expression'], join(where_expression, ' AND ') )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1767
      else:
1768
        where_expression = join(where_expression, ' AND ')
1769
      select_expression= join(select_expression,',')
1770

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1771
      limit_expression = kw.get('limit', None)
1772
      if isinstance(limit_expression, (list, tuple)):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1773 1774 1775
        limit_expression = '%s,%s' % (limit_expression[0], limit_expression[1])
      elif limit_expression is not None:
        limit_expression = str(limit_expression)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1776

1777
    # Use a dictionary at the moment.
1778
    return { 'from_table_list' : from_table_dict.items(),
1779
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1780
             'where_expression' : where_expression,
1781 1782
             'limit_expression' : limit_expression,
             'select_expression': select_expression}
1783

1784
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, **kw):
1785 1786 1787 1788 1789
    """ Returns a list of brains from a set of constraints on variables """
    query = self.buildSQLQuery(REQUEST=REQUEST, **kw)
    kw['where_expression'] = query['where_expression']
    kw['sort_on'] = query['order_by_expression']
    kw['from_table_list'] = query['from_table_list']
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1790
    kw['limit_expression'] = query['limit_expression']
1791
    kw['select_expression'] = query['select_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1792
    # Return the result
1793

1794 1795 1796 1797
    #LOG('acceptable_keys',0,'acceptable_keys: %s' % str(acceptable_keys))
    #LOG('acceptable_key_map',0,'acceptable_key_map: %s' % str(acceptable_key_map))
    #LOG('queryResults',0,'kw: %s' % str(kw))
    #LOG('queryResults',0,'from_table_list: %s' % str(from_table_dict.keys()))
1798
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1799

1800
  def searchResults(self, REQUEST=None, used=None, **kw):
1801
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1802
    """ Returns a list of brains from a set of constraints on variables """
1803
    # The used argument is deprecated and is ignored
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1804 1805 1806 1807 1808 1809 1810
    try:
      # Get the search method
      method = getattr(self, self.sql_search_results)
      # Return the result
      kw['used'] = used
      kw['REQUEST'] = REQUEST
      return self.queryResults(method, **kw)
1811 1812
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1813
    except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1814
      LOG('SQLCatalog', WARNING, "could not search catalog", error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1815 1816 1817 1818 1819
      return []

  __call__ = searchResults

  def countResults(self, REQUEST=None, used=None, **kw):
1820 1821
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
    """ Returns the number of items which satisfy the where_expression """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1822 1823 1824 1825 1826 1827 1828
    try:
      # Get the search method
      method = getattr(self, self.sql_count_results)
      # Return the result
      kw['used'] = used
      kw['REQUEST'] = REQUEST
      return self.queryResults(method, **kw)
1829 1830
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1831
    except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1832
      LOG('SQLCatalog', WARNING, "could not count catalog", error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1833 1834
      return [[0]]

1835
  def recordObjectList(self, path_list, catalog=1):
1836
    """
1837
      Record the path of an object being catalogged or uncatalogged.
1838
    """
1839 1840
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
1841

1842
  def deleteRecordedObjectList(self, uid_list=()):
1843 1844 1845 1846
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
1847
    method(uid_list=uid_list)
1848

1849
  def readRecordedObjectList(self, catalog=1):
1850 1851 1852 1853
    """
      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)
1854
    return method(catalog=catalog)
1855 1856 1857 1858 1859 1860 1861 1862 1863

  # 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:
1864
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
1865

1866 1867 1868 1869
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
1870

1871
      for id in method_id_list:
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
        # We will first look if the filter is activated
        if not self.filter_dict.has_key(id):
          self.filter_dict[id] = PersistentMapping()
          self.filter_dict[id]['filtered']=0
          self.filter_dict[id]['type']=[]
          self.filter_dict[id]['expression']=""
        if REQUEST.has_key('%s_box' % id):
          self.filter_dict[id]['filtered'] = 1
        else:
          self.filter_dict[id]['filtered'] = 0

        if REQUEST.has_key('%s_expression' % id):
          expression = REQUEST['%s_expression' % id]
          if expression == "":
            self.filter_dict[id]['expression'] = ""
            self.filter_dict[id]['expression_instance'] = None
          else:
            expr_instance = Expression(expression)
            self.filter_dict[id]['expression'] = expression
            self.filter_dict[id]['expression_instance'] = expr_instance
        else:
          self.filter_dict[id]['expression'] = ""
          self.filter_dict[id]['expression_instance'] = None

        if REQUEST.has_key('%s_type' % id):
          list_type = REQUEST['%s_type' % id]
1898
          if isinstance(list_type, str):
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968
            list_type = [list_type]
          self.filter_dict[id]['type'] = list_type
        else:
          self.filter_dict[id]['type'] = []

    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
      # self.filter_dict= PersistentMapping()
      if not hasattr(self,'filter_dict'):
        self.filter_dict = PersistentMapping()
        return 0
      if self.filter_dict.has_key(method_name):
        return self.filter_dict[method_name]['filtered']
    return 0

  def getExpression(self, method_name):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      if not hasattr(self,'filter_dict'):
        self.filter_dict = PersistentMapping()
        return ""
      if self.filter_dict.has_key(method_name):
        return self.filter_dict[method_name]['expression']
    return ""

  def getExpressionInstance(self, method_name):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      if not hasattr(self,'filter_dict'):
        self.filter_dict = PersistentMapping()
        return None
      if self.filter_dict.has_key(method_name):
        return self.filter_dict[method_name]['expression_instance']
    return None

  def isPortalTypeSelected(self, method_name,portal_type):
    """
    Returns 1 if the method is already filtered,
    else it returns 0
    """
    if withCMF:
      if not hasattr(self,'filter_dict'):
        self.filter_dict = PersistentMapping()
        return 0
      if self.filter_dict.has_key(method_name):
        result = portal_type in (self.filter_dict[method_name]['type'])
        return result
    return 0


  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
1969 1970 1971 1972
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
      for method_id in methods:
        method_dict[method_id] = 1
    method_list = map(lambda method_id: getattr(self, method_id, None), method_dict.keys())
    return filter(lambda method: method is not None, method_list)

  def getExpressionContext(self, ob):
      '''
      An expression context provides names for TALES expressions.
      '''
      if withCMF:
        data = {
            'here':         ob,
            'container':    aq_parent(aq_inner(ob)),
            'nothing':      None,
1987 1988 1989 1990 1991 1992 1993
            #'root':         ob.getPhysicalRoot(),
            #'request':      getattr( ob, 'REQUEST', None ),
            #'modules':      SecureModuleImporter,
            #'user':         getSecurityManager().getUser(),
            'isDelivery':   ob.isDelivery, # XXX
            'isMovement':   ob.isMovement, # XXX
            'isPredicate':  ob.isPredicate, # XXX
1994 1995 1996 1997 1998 1999
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2000
class CatalogError(Exception): pass
2001 2002 2003 2004



# vim: filetype=python syntax=python shiftwidth=2