SQLCatalog.py 68.9 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 32
from Products.PluginIndexes.common.randid import randid
from Acquisition import aq_parent, aq_inner, aq_base, aq_self
from zLOG import LOG
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 47 48 49 50 51 52 53 54 55

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

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

61
UID_BUFFER_SIZE = 300
62

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
valid_method_meta_type_list = ('Z SQL Method', 'Script (Python)')

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)

83 84 85 86 87 88 89 90 91 92 93 94
    
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
  
  def __init__(self):
    """Initialize some variables.
    
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
      
      finished_buffer is used to hold reserved uids created by committed-transactions.
      
      This distinction is important, because uids by non-committed transactions might become
95 96 97 98 99 100
      invalid afterwards, so they may not be used by other transactions.
      
      allocated_buffer is used to hold reserved uids consumed by non-committed transactions.
      
      This buffer is used to mark uids as already consumed to prevent the same uids from being
      selected by produceUid again."""
101 102
    self.temporary_buffer = {}
    self.finished_buffer = []
103 104
    self.allocated_buffer = {}
    
105 106 107 108 109 110 111 112 113
  def _begin(self, *ignored):
    # In Zope 2.8 (ZODB 3.4), use beforeCommitHook instead of
    # patching Trasaction.
    transaction = get_transaction()
    try:
      transaction.beforeCommitHook(self.tpc_prepare, transaction)
    except AttributeError:
      pass
    
114 115 116 117 118 119 120 121 122 123 124
  def tpc_prepare(self, transaction, sub=None):
    """Mark used uids."""
    tid = get_ident()
    try:
      uid_list = self.allocated_buffer[tid]
      method_id = self.sql_catalog_reserve_uid
      method = getattr(self, method_id)
      method(uid = uid_list)
      del self.allocated_buffer[tid]
    except KeyError:
      pass
125 126 127 128 129 130 131 132 133
    
  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
134 135 136 137
    try:
      del self.allocated_buffer[tid]
    except KeyError:
      pass
138 139 140 141 142 143 144 145
    
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
146 147 148 149
    try:
      del self.allocated_buffer[tid]
    except KeyError:
      pass
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
      
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
    
  def remove(self, value):
    self._register()
    for uid_list in self.temporary_buffer.values():
      try:
        uid_list.remove(value)
      except ValueError:
        pass
167 168 169 170 171
    for uid_list in self.allocated_buffer.values():
      try:
        uid_list.remove(value)
      except ValueError:
        pass
172 173 174 175 176 177 178 179 180
    try:
      self.finished_buffer.remove(value)
    except ValueError:
      pass
      
  def pop(self):
    self._register()
    tid = get_ident()
    try:
181
      uid = self.temporary_buffer[tid].pop()
182
    except (KeyError, IndexError):
183 184 185
      uid = self.finished_buffer.pop()
    self.allocated_buffer.setdefault(tid, []).append(uid)
    return uid
186 187 188 189
      
  def extend(self, iterable):
    self._register()
    tid = get_ident()
190 191 192 193 194 195 196 197 198
    try:
      allocated_buffer = self.allocated_buffer[tid]
      uid_list = []
      for uid in iterable:
        if uid not in allocated_buffer:
          uid_list.append(uid)
    except KeyError:
      uid_list = iterable
    self.temporary_buffer.setdefault(tid, []).extend(uid_list)
199 200

class Catalog(Folder, Persistent, Acquisition.Implicit, ExtensionClass.Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
201 202 203 204
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
205
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

  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


  bgrain defined in meyhods...

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
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 260 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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  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',
      'getCatalogSearchResultKeys', 'getFilterableMethodList', ],
     ['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' },
305 306 307 308 309
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    { 'id'      : 'sql_catalog_object',
      'description' : 'Methods to be called to catalog an object',
      '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' },
    { 'id'      : 'sql_update_object',
      'description' : 'Methods will be called to updat a catalogued object',
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
335
    { 'id'      : 'sql_record_catalog_object_list',
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 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
      'description' : 'Method to record catalog information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_record_uncatalog_object',
      'description' : 'Method to record uncatalog 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'
438
  sql_catalog_reserve_uid = 'z_reserve_uid'
439 440 441 442 443
  sql_catalog_object = ('z_catalog_object',)
  sql_uncatalog_object = ('z_uncatalog_object',)
  sql_update_object = ('z_update_object',)
  sql_clear_catalog = ('z_drop_catalog', 'z_create_catalog')
  sql_catalog_object_list = ('z_catalog_object_list',)
444
  sql_record_catalog_object_list = 'z_record_catalog_object_list'
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
  sql_record_uncatalog_object = 'z_record_uncatalog_object'
  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 = ()

465 466 467 468 469 470
  # 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
471

472 473 474 475 476 477 478
  # 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
479

480 481 482 483 484 485 486 487 488 489
  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
490 491 492 493
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping

494 495 496 497 498 499
  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')
500 501 502 503 504 505 506 507 508 509 510 511
    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]
512
      if type(value) in (type(''), type(u'')):
513
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
514
      elif type(value) in (type(()), type([])):
515 516 517
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
518
        for item in value:
519
          if type(item) in (type(""), type(u"")):
520 521 522 523
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
524
        f.write('  </property>\n')
525 526 527
    # 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'):
528 529
      filter_list = []
      for filter_id in self.filter_dict.keys():
530
        filter_definition = self.filter_dict[filter_id]
531 532 533 534 535 536 537
        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']:
538 539
          # If a filter is not activated, no need to output it.
          continue
540
        if not filter_def['expression']:
541 542
          # If the expression is not specified, meaningless to specify it.
          continue
543
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
544
        # For now, portal types are not exported, because portal types are too specific to each site.
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    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):
566
            raise CatalogError, 'unknown property id %r' % (id,)
567
          if type not in ('str', 'tuple'):
568
            raise CatalogError, 'unknown property type %r' % (type,)
569 570 571 572 573 574 575 576 577 578 579
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
                value = text.data
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
580
                raise CatalogError, 'unknown item type %r' % (item_type,)
581 582 583 584 585 586 587
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
                  value.append(text.data)
                  break
            value = tuple(value)

          setattr(self, id, value)
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
          id = filt.getAttribute("id")
          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
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
      finally:
        doc.unlink()
    finally:
      f.close()

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

  security.declarePrivate('getSecurityUid')
  def getSecurityUid(self, object):
    """
      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
    allowed_roles_and_users = object.allowedRolesAndUsers()
    # 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)
    # Make sure no diplicates
    if not hasattr(aq_base(self), 'security_uid_dict'):
      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
637 638 639 640 641 642
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
643
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
644 645
      try:
        method()
646 647
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
648
      except:
649
        LOG('SQLCatalog Warning: could not clear catalog', 0, method_name, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
650
        pass
651

652
    # Reserved uids have been removed.
653
    self.clearReserved()
654

655 656 657 658 659
    # 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)
660
      method(uid = [self._max_uid()])
661

662
    # Remove the cache of catalog schema.
663 664
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
665

666
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
667

668 669 670 671 672 673 674
  def clearReserved(self):
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
    method()
675
    self._last_clear_reserved_time += 1
676

Jean-Paul Smets's avatar
Jean-Paul Smets committed
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
  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

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  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

725 726
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
727

728 729 730 731 732 733 734 735 736
    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)
737 738
      except ConflictError:
        raise
739 740 741 742 743
      except:
        LOG('WARNING SQLCatalog._getCatalogSchema failed with the method', 0, method_name, error=sys.exc_info())
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
744

745
    return catalog_schema_dict[table]
746

Jean-Paul Smets's avatar
Jean-Paul Smets committed
747 748
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
749 750
    Calls the show column method and returns dictionnary of
    Field Ids
751

752
    XXX This should be cached
Jean-Paul Smets's avatar
Jean-Paul Smets committed
753 754 755
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
756 757 758 759
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys[field] = 1
        keys['%s.%s' % (table, field)] = 1  # Is this inconsistent ?
760 761 762 763
    for related in self.sql_catalog_related_keys:
      related_tuple = related.split('|')
      related_key = related_tuple[0].strip()
      keys[related_key] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
764 765 766 767
    keys = keys.keys()
    keys.sort()
    return keys

768 769 770 771
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
772

773 774 775 776
    XXX This should be cached
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
777 778 779 780 781 782 783 784
      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 ?
785
    return keys
786

Jean-Paul Smets's avatar
Jean-Paul Smets committed
787 788 789 790 791 792 793
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
794 795 796
      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
797 798 799 800 801 802 803
    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
804 805 806
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
807 808
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
809 810 811
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
812
        keys.append(c[0])
813 814
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
815 816
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
817 818 819
    return keys

  # the cataloging API
820 821 822
  def produceUid(self):
    """
      Produces reserved uids in advance
823
    """
824 825 826 827 828
    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:
829
      self._v_uid_buffer = UidBuffer()
830
      klass._local_clear_reserved_time = self._last_clear_reserved_time
831 832 833
    elif not hasattr(self, '_v_uid_buffer'):
      self._v_uid_buffer = UidBuffer()
    if len(self._v_uid_buffer) == 0:
834 835
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
836 837 838 839 840 841 842 843 844 845 846
      instance_id = klass._instance_id
      if instance_id is None:
        # 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()[:30]
        klass._instance_id = instance_id
847 848
      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)
849

850 851 852
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
853 854
      with multiple ZEO clients on a single ZEO server.

855
      The main risk is the following:
856

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

859
      - one reindexing node N1 starts reindexing f
860

861
      - another reindexing node N2 starts reindexing e
862

863 864 865
      - 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

866
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
867
      with the risk of graph loops
868
    """
869 870 871 872
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
873 874
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
875 876 877 878 879 880 881 882 883
        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()
884

885 886 887 888 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 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
  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`)))

  def manage_catalogClear(self, REQUEST=None, RESPONSE=None, URL1=None, sql_catalog_id=None):
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
      RESPONSE.redirect(URL1 + '/manage_catalogAdvanced?manage_tabs_message=Catalog%20Cleared')

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
    """ clears the whole enchilada """
    self.clearReserved()

    if RESPONSE and URL1:
      RESPONSE.redirect(URL1 + '/manage_catalogAdvanced?manage_tabs_message=Catalog%20Cleared')

  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
978
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
979 980 981 982 983 984 985 986 987
    """
    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

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

990 991 992 993 994 995 996 997 998 999 1000 1001 1002
  def catalogObjectList(self, object_list):
    """
      Add objects to the Catalog by calling
      all SQL methods and providing needed arguments.

      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?
    """
1003
    LOG('catalogObjectList', 0, 'called with %d objects' % len(object_list))
1004
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1005

1006 1007
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
1008
      site_root = getToolByName(self, 'portal_url').getPortalObject()
1009 1010
    else:
      zope_root = self.getPhysicalRoot()
1011
      site_root = self.aq_parent
1012

1013
    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
1014 1015 1016
    if not root_indexable:
      return

1017
    for object in object_list:
1018
      if not getattr(aq_base(object), 'uid', None):
1019
        try:
1020
          object.uid = self.newUid()
1021 1022
        except ConflictError:
          raise
1023
        except:
1024
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
      else:
        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:
            LOG('SQLCatalog Warning:', 0, 'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, index))
            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
          catalog_path = self.getPathForUid(uid)
          #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()
1051
              if hasattr(self, '_v_uid_buffer'):
1052 1053 1054 1055 1056 1057 1058 1059
                # 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.
1060 1061 1062 1063
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1064 1065 1066 1067 1068
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
            object.uid = self.newUid()
1069
            LOG('SQLCatalog Warning:', 0, 'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid))
1070 1071

    methods = self.sql_catalog_object_list
1072
    econtext_cache = {}
1073
    argument_cache = {}
1074
    expression_cache = {}
1075

1076
    method_kw_dict = {}
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
    for method_name in methods:
      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()
1088
          if type_list and portal_type not in type_list:
1089 1090
            continue
          elif expression is not None:
1091 1092 1093 1094
            expression_key = (object.uid, self.filter_dict[method_name]['expression'])
            try:
              result = expression_cache[expression_key]
            except KeyError:
1095 1096 1097
              try:
                econtext = econtext_cache[object.uid]
              except KeyError:
1098 1099 1100 1101
                econtext = econtext_cache[object.uid] = self.getExpressionContext(object)
              result = expression_cache[expression_key] = expression(econtext)
            if not result:
              continue
1102 1103 1104 1105 1106 1107 1108
          catalogged_object_list.append(object)
      else:
        catalogged_object_list = object_list

      if len(catalogged_object_list) == 0:
        continue

1109 1110
      method_kw_dict[method_name] = kw
      
1111
      #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
1112
      method = getattr(self, method_name)
1113 1114 1115 1116 1117
      if method.meta_type == "Z SQL Method":
        # Build the dictionnary of values
        arguments = method.arguments_src
        for arg in split(arguments):
          value_list = []
1118
          append = value_list.append
1119 1120
          for object in catalogged_object_list:
            try:
1121 1122 1123 1124 1125 1126
              value = argument_cache[(object.uid, arg)]
            except KeyError:
              try:
                value = getattr(object, arg, None)
                if callable(value):
                  value = value()
1127 1128
              except ConflictError:
                raise
1129 1130 1131 1132
              except:
                value = None
              argument_cache[(object.uid, arg)] = value
            append(value)
1133
          kw[arg] = value_list
1134 1135 1136 1137 1138 1139
          
    for method_name in methods:
      if method_name not in method_kw_dict:
        continue
      kw = method_kw_dict[method_name]
      method = getattr(self, method_name)
1140 1141
      method = aq_base(method).__of__(site_root.portal_catalog) # Use method in 
              # the context of portal_catalog
1142 1143 1144
      # Alter/Create row
      try:
        #start_time = DateTime()
1145
        #LOG('catalogObjectList', 0, 'kw = %r, method_name = %r' % (kw, method_name))
1146 1147 1148 1149 1150 1151 1152
        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]))
1153 1154
      except ConflictError:
        raise
1155
      except:
1156 1157
        LOG("SQLCatalog Warning: could not catalog objects with method %s" % method_name,100, str(object_list),
            error=sys.exc_info())
1158
        raise
1159

1160
  if psyco is not None: psyco.bind(catalogObjectList)
1161

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
  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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1177 1178 1179 1180 1181
    uid = self.getUidForPath(path)
    methods = self.sql_uncatalog_object
    for method_name in methods:
      method = getattr(self, method_name)
      try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1182
        #if 1:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1183
        method(uid = uid)
1184 1185
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
      except:
        # This is a real LOG message
        # which is required in order to be able to import .zexp files
        LOG("SQLCatalog Warning: could not uncatalog object uid %s with method %s" %
                                               (uid, method_name),0,str(path))

  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)
1209
      search_result = method(path = path, uid_only=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1210 1211 1212 1213 1214
      # If not emptyn return first record
      if len(search_result) > 0:
        return search_result[0].uid
      else:
        return None
1215 1216
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
      LOG("Warning: could not find uid from path",0,str(path))
      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
      # 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
1240 1241
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
      LOG("Warning: could not find path from uid",0,str(uid))
      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:
      if uid is None:
        return None
      # 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
1276 1277
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
      LOG("Warning: could not find uid from path",0,str(path))
      return None

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

1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
  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
    StringType=type('')

    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
            if type(id) is not StringType: id=id()
            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

1313 1314
  def buildSQLQuery(self, query_table='catalog', REQUEST=None, **kw):
    """ Builds a complex SQL query to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1315 1316 1317 1318 1319 1320 1321
    # 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

1322
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1323 1324 1325 1326
    # If kw is not set, then use REQUEST instead
    if kw is None or kw == {}:
      kw = REQUEST

1327
    acceptable_key_map = self.getColumnMap()
1328 1329 1330
    acceptable_keys = acceptable_key_map.keys()
    full_text_search_keys = self.sql_catalog_full_text_search_keys
    keyword_search_keys = self.sql_catalog_keyword_search_keys
1331
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1332
    multivalue_keys = self.sql_catalog_multivalue_keys
1333

1334 1335 1336
    # Define related maps
    # each tuple has the form (key, 'table1,table2,table3/column/where_expression')
    related_tuples = self.sql_catalog_related_keys
1337
    #LOG('related_tuples', 0, str(related_tuples))
1338 1339 1340 1341
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1342
    related_table_list = {}
1343
    table_rename_index = 0
1344
    related_methods = {} # related methods which need to be used
1345 1346 1347 1348
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1349
      #LOG('related_tuples', 0, str(join_tuple))
1350
      related_keys.append(key)
1351
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1352
      method_id = join_tuple[2]
1353
      table_list = tuple(join_tuple[0].split(','))
1354
      related_method[key] = method_id
1355
      related_table_list[key] = table_list
1356 1357
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1358
      if not related_table_map.has_key((table_list,method_id)):
1359
        map_list = []
1360
        for table_id in table_list:
1361
          map_list.append((table_id,
1362 1363
             "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
1364
        related_table_map[(table_list,method_id)] = map_list
1365

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1366 1367
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1368
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1369 1370 1371
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1372
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1373
            kw[key] = REQUEST[key]
1374
      # Let us try first not to use this
1375 1376 1377
      #for key in related_keys:
      #  if REQUEST.has_key(key):
      #    kw[key] = REQUEST[key]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1378

1379
    # Let us start building the where_expression
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1380
    if kw:
1381
      where_expression = []
1382
      from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402


      # 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

1403 1404 1405 1406 1407 1408
      # We must now turn sort_index into
      # a dict with keys as sort keys and values as sort order
      if type(sort_index) is type('a'):
        sort_index = [(sort_index, so)]
      elif type(sort_index) is not type(()) and type(sort_index) is not type([]):
        sort_index = None
1409

1410

1411 1412 1413
      # If sort_index is a dictionnary
      # then parse it and change it
      sort_on = None
1414
      #LOG('sorting', 0, str(sort_index))
1415
      if sort_index is not None:
1416 1417 1418 1419 1420 1421 1422
        new_sort_index = []
        for sort in sort_index:
          if len(sort)==2:
            new_sort_index.append((sort[0],sort[1],None))
          elif len(sort)==3:
            new_sort_index.append(sort)
        sort_index = new_sort_index
1423 1424
        try:
          new_sort_index = []
1425
          for (key , so, as_type) in sort_index:
1426 1427 1428 1429 1430 1431
            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]
1432 1433 1434 1435
                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
1436
                key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1437 1438 1439 1440
              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 :
1441
                    key = '%s.%s' % (acceptable_key_map[key][0], key)
1442 1443
                  # query_table specifies what table name should be used by default
                  elif query_table:
1444
                    key = '%s.%s' % (query_table, key)
1445 1446 1447 1448 1449
                  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
1450 1451
              if as_type == 'int':
                key = 'CAST(' + key + ' AS SIGNED)'
1452
              if so in ('descending', 'reverse', 'DESC'):
1453 1454 1455
                new_sort_index += ['%s DESC' % key]
              else:
                new_sort_index += ['%s' % key]
1456 1457
          sort_index = join(new_sort_index,',')
          sort_on = str(sort_index)
1458 1459
        except ConflictError:
          raise
1460
        except:
1461
          LOG('SQLCatalog.buildSQLQuery',0,'WARNING, Unable to build the new sort index', error=sys.exc_info())
1462 1463
          pass

1464 1465 1466 1467 1468 1469
      # 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]
1470
          if not new_kw.has_key(new_k): new_kw[new_k] = {}
1471
          if type(new_kw[new_k]) is not type({}): new_kw[new_k] = {'query': new_kw[new_k]}
1472
          split_v = v.split(':')
1473 1474 1475 1476
          new_kw[new_k] = {split_v[0]: split_v[1]}
        else:
          if not new_kw.has_key(k):
            new_kw[k] = v
1477
          else:
1478 1479 1480 1481
            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
1482 1483
      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
1484
        if key not in ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1485
          # Make sure key belongs to schema
1486 1487 1488 1489 1490 1491
          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]
1492 1493 1494 1495
              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
1496
              key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
            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
                elif query_table:
                  key = query_table + '.' + key
                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
1510 1511
            # Default case: variable equality
            if type(value) is type(''):
1512 1513
              # For security.
              value = sql_quote(value)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1514 1515 1516 1517 1518 1519
              if value != '':
                # we consider empty string as Non Significant
                if value == '=':
                  # But we consider the sign = as empty string
                  value=''
                if '%' in value:
1520
                  where_expression += ["%s LIKE '%s'" % (key, value)]
1521
                elif value.startswith('>='):
1522
                  where_expression += ["%s >= '%s'" % (key, value[2:])]
1523
                elif value.startswith('<='):
1524
                  where_expression += ["%s <= '%s'" % (key, value[2:])]
1525
                elif value.startswith('>'):
1526
                  where_expression += ["%s > '%s'" % (key, value[1:])]
1527
                elif value.startswith('<'):
1528
                  where_expression += ["%s < '%s'" % (key, value[1:])]
1529
                elif value.startswith('!='):
Sebastien Robin's avatar
Sebastien Robin committed
1530
                  where_expression += ["%s != '%s'" % (key, value[2:])]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1531 1532
                elif key in keyword_search_keys:
                  # We must add % in the request to simulate the catalog
1533
                  where_expression += ["%s LIKE '%%%s%%'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1534 1535
                elif key in full_text_search_keys:
                  # We must add % in the request to simulate the catalog
1536
                  where_expression += ["MATCH %s AGAINST ('%s')" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1537
                else:
1538
                  where_expression += ["%s = '%s'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1539 1540 1541 1542 1543 1544 1545
            elif type(value) is type([]) or type(value) is type(()):
              # We have to create an OR from tuple or list
              query_item = []
              for value_item in value:
                if value_item != '':
                  # we consider empty string as Non Significant
                  # also for lists
1546 1547
                  if type(value_item) in (type(1), type(1.0),
                                          type(1991643034L)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1548 1549
                    query_item += ["%s = %s" % (key, value_item)]
                  else:
1550
                    # For security.
1551
                    value_item = sql_quote(str(value_item))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1552
                    if '%' in value_item:
1553
                      query_item += ["%s LIKE '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1554 1555
                    elif key in keyword_search_keys:
                      # We must add % in the request to simulate the catalog
1556
                      query_item += ["%s LIKE '%%%s%%'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1557 1558 1559 1560
                    elif key in full_text_search_keys:
                      # We must add % in the request to simulate the catalog
                      query_item +=  ["MATCH %s AGAINST ('%s')" % (key, value)]
                    else:
1561
                      query_item += ["%s = '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1562
              if len(query_item) > 0:
1563
                where_expression += ['(%s)' % join(query_item, ' OR ')]
1564 1565
            elif type(value) is type({}):
              # We are in the case of a complex query
1566
              query_item = []
1567
              query_value = value['query']
1568 1569
              if type(query_value) != type([]) and type(query_value) != type(()) :
                query_value = [query_value]
1570
              operator_value = sql_quote(value.get('operator', 'or'))
1571
              range_value = value.get('range')
1572

1573
              if range_value :
1574 1575
                query_min = sql_quote(str(min(query_value)))
                query_max = sql_quote(str(max(query_value)))
1576
                if range_value == 'min' :
1577
                  query_item += ["%s >= '%s'" % (key, query_min) ]
1578
                elif range_value == 'max' :
1579
                  query_item += ["%s < '%s'" % (key, query_max) ]
1580
                elif range_value == 'minmax' :
1581
                  query_item += ["%s >= '%s' and %s < '%s'" % (key, query_min, key, query_max) ]
1582
                elif range_value == 'ngt' :
1583
                  query_item += ["%s <= '%s'" % (key, query_max) ]
1584 1585
              else :
                for query_value_item in query_value :
1586
                  query_item += ['%s = %s' % (key, sql_quote(str(query_value_item)))]
1587 1588
              if len(query_item) > 0:
                where_expression += ['(%s)' % join(query_item, ' %s ' % operator_value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1589
            else:
1590
              where_expression += ["%s = %s" % (key, sql_quote(str(value)))]
1591 1592
          elif key in topic_search_keys:
            # ERP5 CPS compatibility
1593
            topic_operator = 'or'
1594
            if type(value) is type({}):
1595
              topic_operator = sql_quote(value.get('operator', 'or'))
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
              value = value['query']
            if type(value) is type(''):
              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 :
1607
                    topic_key = '%s.%s' % (acceptable_key_map[topic_key][0], topic_key)
1608 1609
                  # query_table specifies what table name should be used
                  elif query_table:
1610
                    topic_key = '%s.%s' % (query_table, topic_key)
1611
                # Add table to table dict
1612
                from_table_dict[acceptable_key_map[topic_key][0]] = acceptable_key_map[topic_key][0] # We use catalog by default
1613
                query_item += ["%s = 1" % topic_key]
1614
            # Join
1615 1616
            if len(query_item) > 0:
              where_expression += ['(%s)' % join(query_item, ' %s ' % topic_operator)]
1617 1618
      # Calculate extra where_expression based on required joins
      for k, tid in from_table_dict.items():
1619
        if k != query_table:
1620 1621
          where_expression.append('%s.uid = %s.uid' % (query_table, tid))
      # Calculate extra where_expressions based on related definition
1622
      for (table_list,method_id) in related_methods.keys():
1623 1624 1625 1626
        related_method = getattr(self, method_id, None)
        if related_method is not None:
          table_id = {'src__' : 1} # Return query source, do not evaluate
          table_index = 0
1627
          for t_tuple in related_table_map[(table_list,method_id)]:
1628 1629 1630 1631
            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))
1632
      # Concatenate where_expressions
1633
      if kw.get('where_expression'):
1634
        if len(where_expression) > 0:
1635
          where_expression = "(%s) AND (%s)" % (kw['where_expression'], join(where_expression, ' AND ') )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1636
      else:
1637
        where_expression = join(where_expression, ' AND ')
1638

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1639 1640 1641 1642 1643
      limit_expression = kw.get('limit', None)
      if type(limit_expression) in (type(()), type([])):
        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
1644

1645
    # Use a dictionary at the moment.
1646
    return { 'from_table_list' : from_table_dict.items(),
1647
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1648 1649
             'where_expression' : where_expression,
             'limit_expression' : limit_expression }
1650

1651
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, **kw):
1652 1653 1654 1655 1656
    """ 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
1657
    kw['limit_expression'] = query['limit_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1658
    # Return the result
1659

1660 1661 1662 1663
    #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()))
1664
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1665

1666
  def searchResults(self, REQUEST=None, used=None, **kw):
1667
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1668
    """ Returns a list of brains from a set of constraints on variables """
1669
    # The used argument is deprecated and is ignored
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1670 1671 1672 1673 1674 1675 1676
    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)
1677 1678
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1679
    except:
1680
      LOG("Warning: could not search catalog",0,self.sql_search_results, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1681 1682 1683 1684 1685
      return []

  __call__ = searchResults

  def countResults(self, REQUEST=None, used=None, **kw):
1686 1687
    """ 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
1688 1689 1690 1691 1692 1693 1694
    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)
1695 1696
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1697
    except:
1698
      LOG("Warning: could not count catalog",0,self.sql_count_results, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1699 1700
      return [[0]]

1701
  def recordCatalogObjectList(self, path_list):
1702 1703 1704
    """
      Record the path of an object being catalogged.
    """
1705 1706
    method = getattr(self, self.sql_record_catalog_object_list)
    method(path_list=path_list)
1707 1708 1709 1710 1711 1712 1713 1714

  def recordUncatalogObject(self, path):
    """
      Record the path of an object being uncatalogged.
    """
    method = getattr(self, self.sql_record_uncatalog_object)
    method(path=path)

1715
  def deleteRecordedObjectList(self, path):
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
    """
      Delete all objects which contain any path.
    """
    if type(path) == type(''):
      path = [path]
    method = getattr(self, self.sql_delete_recorded_object_list)
    method(path=path)

  def readRecordedObjectList(self):
    """
      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)
    return method()

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

1741 1742 1743 1744
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
1745

1746
      for id in method_id_list:
1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
        # 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]
          if type(list_type) is type('a'):
            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:
      methods = self.sql_catalog_object + self.sql_uncatalog_object \
                + self.sql_update_object + self.sql_catalog_object_list
      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,
1860 1861 1862 1863 1864 1865 1866
            #'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
1867 1868 1869 1870 1871 1872
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1873
class CatalogError(Exception): pass