SQLCatalog.py 67.8 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
    
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
87
  def __init__(self):
88 89 90 91 92 93 94
    """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
Yoshinori Okuji's avatar
Yoshinori Okuji committed
95
      invalid afterwards, so they may not be used by other transactions."""
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
    self.temporary_buffer = {}
    self.finished_buffer = []
    
  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
    
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
      
  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
    try:
      self.finished_buffer.remove(value)
    except ValueError:
      pass
      
  def pop(self):
    self._register()
    tid = get_ident()
    try:
141
      uid = self.temporary_buffer[tid].pop()
142
    except (KeyError, IndexError):
143 144
      uid = self.finished_buffer.pop()
    return uid
145 146 147 148
      
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
149
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
150 151

class Catalog(Folder, Persistent, Acquisition.Implicit, ExtensionClass.Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
152 153 154 155
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
156
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172

  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
  """
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 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
  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' },
256 257 258 259 260
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
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
    { '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' },
286
    { 'id'      : 'sql_record_catalog_object_list',
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 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 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
      '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'
389
  sql_catalog_reserve_uid = 'z_reserve_uid'
390 391 392 393 394
  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',)
395
  sql_record_catalog_object_list = 'z_record_catalog_object_list'
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
  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 = ()

416 417 418 419 420 421
  # 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
422

423 424 425 426 427 428 429
  # 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
430

431 432 433 434 435 436 437 438 439 440
  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
441 442 443 444
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping

445 446 447 448 449 450
  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')
451 452 453 454 455 456 457 458 459 460 461 462
    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]
463
      if type(value) in (type(''), type(u'')):
464
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
465
      elif type(value) in (type(()), type([])):
466 467 468
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
469
        for item in value:
470
          if type(item) in (type(""), type(u"")):
471 472 473 474
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
475
        f.write('  </property>\n')
476 477 478
    # 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'):
479 480
      filter_list = []
      for filter_id in self.filter_dict.keys():
481
        filter_definition = self.filter_dict[filter_id]
482 483 484 485 486 487 488
        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']:
489 490
          # If a filter is not activated, no need to output it.
          continue
491
        if not filter_def['expression']:
492 493
          # If the expression is not specified, meaningless to specify it.
          continue
494
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
495
        # For now, portal types are not exported, because portal types are too specific to each site.
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
    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):
517
            raise CatalogError, 'unknown property id %r' % (id,)
518
          if type not in ('str', 'tuple'):
519
            raise CatalogError, 'unknown property type %r' % (type,)
520 521 522 523 524 525 526 527 528 529 530
          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':
531
                raise CatalogError, 'unknown item type %r' % (item_type,)
532 533 534 535 536 537 538
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
                  value.append(text.data)
                  break
            value = tuple(value)

          setattr(self, id, value)
539

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
        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
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
      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
588 589 590 591 592 593
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
594
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
595 596
      try:
        method()
597 598
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
599
      except:
600
        LOG('SQLCatalog Warning: could not clear catalog', 0, method_name, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
601
        pass
602

603
    # Reserved uids have been removed.
604
    self.clearReserved()
605

606 607 608 609 610
    # 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)
611
      method(uid = [self._max_uid()])
612

613
    # Remove the cache of catalog schema.
614 615
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
616

617
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
618

619 620 621 622 623 624 625
  def clearReserved(self):
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
    method()
626
    self._last_clear_reserved_time += 1
627

Jean-Paul Smets's avatar
Jean-Paul Smets committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
  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

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
  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

676 677
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
678

679 680 681 682 683 684 685 686 687
    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)
688 689
      except ConflictError:
        raise
690 691 692 693 694
      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
695

696
    return catalog_schema_dict[table]
697

Jean-Paul Smets's avatar
Jean-Paul Smets committed
698 699
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
700 701
    Calls the show column method and returns dictionnary of
    Field Ids
702

703
    XXX This should be cached
Jean-Paul Smets's avatar
Jean-Paul Smets committed
704 705 706
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
707 708 709 710
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys[field] = 1
        keys['%s.%s' % (table, field)] = 1  # Is this inconsistent ?
711 712 713 714
    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
715 716 717 718
    keys = keys.keys()
    keys.sort()
    return keys

719 720 721 722
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
723

724 725 726 727
    XXX This should be cached
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
728 729 730 731 732 733 734 735
      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 ?
736
    return keys
737

Jean-Paul Smets's avatar
Jean-Paul Smets committed
738 739 740 741 742 743 744
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
745 746 747
      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
748 749 750 751 752 753 754
    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
755 756 757
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
758 759
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
760 761 762
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
763
        keys.append(c[0])
764 765
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
766 767
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
768 769 770
    return keys

  # the cataloging API
771 772 773
  def produceUid(self):
    """
      Produces reserved uids in advance
774
    """
775 776 777 778 779
    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
780
      self._v_uid_buffer = UidBuffer()
781
      klass._local_clear_reserved_time = self._last_clear_reserved_time
782
    elif not hasattr(self, '_v_uid_buffer'):
Yoshinori Okuji's avatar
Yoshinori Okuji committed
783
      self._v_uid_buffer = UidBuffer()
784
    if len(self._v_uid_buffer) == 0:
785 786
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
787 788 789 790 791 792 793 794
      # 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()
795 796
      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)
797

798 799 800
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
801 802
      with multiple ZEO clients on a single ZEO server.

803
      The main risk is the following:
804

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

807
      - one reindexing node N1 starts reindexing f
808

809
      - another reindexing node N2 starts reindexing e
810

811 812 813
      - 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

814
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
815
      with the risk of graph loops
816
    """
817 818 819 820
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
821 822
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
823 824 825 826 827 828 829 830 831
        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()
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 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
  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
926
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
927 928 929 930 931 932 933 934 935
    """
    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

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

938 939 940 941 942 943 944 945 946 947 948 949 950
  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?
    """
951
    LOG('catalogObjectList', 0, 'called with %d objects' % len(object_list))
952
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
953

954 955
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
956
      site_root = getToolByName(self, 'portal_url').getPortalObject()
957 958
    else:
      zope_root = self.getPhysicalRoot()
959
      site_root = self.aq_parent
960

961
    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
962 963 964
    if not root_indexable:
      return

965
    for object in object_list:
966
      if not getattr(aq_base(object), 'uid', None):
967
        try:
968
          object.uid = self.newUid()
969 970
        except ConflictError:
          raise
971
        except:
972
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
      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()
999
              if hasattr(self, '_v_uid_buffer'):
1000 1001 1002 1003 1004 1005 1006 1007
                # 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.
1008 1009 1010 1011
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1012 1013 1014 1015 1016
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
            object.uid = self.newUid()
1017
            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))
1018 1019

    methods = self.sql_catalog_object_list
1020
    econtext_cache = {}
1021
    argument_cache = {}
1022
    expression_cache = {}
1023

1024
    method_kw_dict = {}
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
    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()
1036
          if type_list and portal_type not in type_list:
1037 1038
            continue
          elif expression is not None:
1039 1040 1041 1042
            expression_key = (object.uid, self.filter_dict[method_name]['expression'])
            try:
              result = expression_cache[expression_key]
            except KeyError:
1043 1044 1045
              try:
                econtext = econtext_cache[object.uid]
              except KeyError:
1046 1047 1048 1049
                econtext = econtext_cache[object.uid] = self.getExpressionContext(object)
              result = expression_cache[expression_key] = expression(econtext)
            if not result:
              continue
1050 1051 1052 1053 1054 1055 1056
          catalogged_object_list.append(object)
      else:
        catalogged_object_list = object_list

      if len(catalogged_object_list) == 0:
        continue

1057 1058
      method_kw_dict[method_name] = kw
      
1059
      #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
1060
      method = getattr(self, method_name)
1061 1062 1063 1064 1065
      if method.meta_type == "Z SQL Method":
        # Build the dictionnary of values
        arguments = method.arguments_src
        for arg in split(arguments):
          value_list = []
1066
          append = value_list.append
1067 1068
          for object in catalogged_object_list:
            try:
1069 1070 1071 1072 1073 1074
              value = argument_cache[(object.uid, arg)]
            except KeyError:
              try:
                value = getattr(object, arg, None)
                if callable(value):
                  value = value()
1075 1076
              except ConflictError:
                raise
1077 1078 1079 1080
              except:
                value = None
              argument_cache[(object.uid, arg)] = value
            append(value)
1081
          kw[arg] = value_list
1082 1083 1084 1085 1086 1087
          
    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)
1088 1089
      method = aq_base(method).__of__(site_root.portal_catalog) # Use method in 
              # the context of portal_catalog
1090 1091 1092
      # Alter/Create row
      try:
        #start_time = DateTime()
1093
        #LOG('catalogObjectList', 0, 'kw = %r, method_name = %r' % (kw, method_name))
1094 1095 1096 1097 1098 1099 1100
        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]))
1101 1102
      except ConflictError:
        raise
1103
      except:
1104 1105
        LOG("SQLCatalog Warning: could not catalog objects with method %s" % method_name,100, str(object_list),
            error=sys.exc_info())
1106
        raise
1107

1108
  if psyco is not None: psyco.bind(catalogObjectList)
1109

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
  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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1125 1126 1127 1128 1129
    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
1130
        #if 1:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1131
        method(uid = uid)
1132 1133
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
      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)
1157
      search_result = method(path = path, uid_only=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1158 1159 1160 1161 1162
      # If not emptyn return first record
      if len(search_result) > 0:
        return search_result[0].uid
      else:
        return None
1163 1164
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
    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
1188 1189
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    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
1224 1225
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
    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)

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
  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

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
  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

1272 1273
  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
1274 1275 1276 1277 1278 1279 1280
    # 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

1281
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1282 1283 1284 1285
    # If kw is not set, then use REQUEST instead
    if kw is None or kw == {}:
      kw = REQUEST

1286
    acceptable_key_map = self.getColumnMap()
1287 1288 1289
    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
1290
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1291
    multivalue_keys = self.sql_catalog_multivalue_keys
1292

1293 1294 1295
    # Define related maps
    # each tuple has the form (key, 'table1,table2,table3/column/where_expression')
    related_tuples = self.sql_catalog_related_keys
1296
    #LOG('related_tuples', 0, str(related_tuples))
1297 1298 1299 1300
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1301
    related_table_list = {}
1302
    table_rename_index = 0
1303
    related_methods = {} # related methods which need to be used
1304 1305 1306 1307
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1308
      #LOG('related_tuples', 0, str(join_tuple))
1309
      related_keys.append(key)
1310
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1311
      method_id = join_tuple[2]
1312
      table_list = tuple(join_tuple[0].split(','))
1313
      related_method[key] = method_id
1314
      related_table_list[key] = table_list
1315 1316
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1317
      if not related_table_map.has_key((table_list,method_id)):
1318
        map_list = []
1319
        for table_id in table_list:
1320
          map_list.append((table_id,
1321 1322
             "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
1323
        related_table_map[(table_list,method_id)] = map_list
1324

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1325 1326
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1327
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1328 1329 1330
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1331
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1332
            kw[key] = REQUEST[key]
1333
      # Let us try first not to use this
1334 1335 1336
      #for key in related_keys:
      #  if REQUEST.has_key(key):
      #    kw[key] = REQUEST[key]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1337

1338
    # Let us start building the where_expression
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1339
    if kw:
1340
      where_expression = []
1341
      from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361


      # 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

1362 1363 1364 1365 1366 1367
      # 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
1368

1369

1370 1371 1372
      # If sort_index is a dictionnary
      # then parse it and change it
      sort_on = None
1373
      #LOG('sorting', 0, str(sort_index))
1374
      if sort_index is not None:
1375 1376 1377 1378 1379 1380 1381
        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
1382 1383
        try:
          new_sort_index = []
1384
          for (key , so, as_type) in sort_index:
1385 1386 1387 1388 1389 1390
            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]
1391 1392 1393 1394
                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
1395
                key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1396 1397 1398 1399
              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 :
1400
                    key = '%s.%s' % (acceptable_key_map[key][0], key)
1401 1402
                  # query_table specifies what table name should be used by default
                  elif query_table:
1403
                    key = '%s.%s' % (query_table, key)
1404 1405 1406 1407 1408
                  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
1409 1410
              if as_type == 'int':
                key = 'CAST(' + key + ' AS SIGNED)'
1411
              if so in ('descending', 'reverse', 'DESC'):
1412 1413 1414
                new_sort_index += ['%s DESC' % key]
              else:
                new_sort_index += ['%s' % key]
1415 1416
          sort_index = join(new_sort_index,',')
          sort_on = str(sort_index)
1417 1418
        except ConflictError:
          raise
1419
        except:
1420
          LOG('SQLCatalog.buildSQLQuery',0,'WARNING, Unable to build the new sort index', error=sys.exc_info())
1421 1422
          pass

1423 1424 1425 1426 1427 1428
      # 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]
1429
          if not new_kw.has_key(new_k): new_kw[new_k] = {}
1430
          if type(new_kw[new_k]) is not type({}): new_kw[new_k] = {'query': new_kw[new_k]}
1431
          split_v = v.split(':')
1432 1433 1434 1435
          new_kw[new_k] = {split_v[0]: split_v[1]}
        else:
          if not new_kw.has_key(k):
            new_kw[k] = v
1436
          else:
1437 1438 1439 1440
            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
1441 1442
      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
1443
        if key not in ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1444
          # Make sure key belongs to schema
1445 1446 1447 1448 1449 1450
          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]
1451 1452 1453 1454
              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
1455
              key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
            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
1469
            # Default case: variable equality
1470
            if type(value) is type('') or isinstance(value, DateTime):
1471
              # For security.
1472
              value = self._quoteSQLString(value)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1473 1474 1475 1476 1477 1478
              if value != '':
                # we consider empty string as Non Significant
                if value == '=':
                  # But we consider the sign = as empty string
                  value=''
                if '%' in value:
1479
                  where_expression += ["%s LIKE '%s'" % (key, value)]
1480
                elif value.startswith('>='):
1481
                  where_expression += ["%s >= '%s'" % (key, value[2:])]
1482
                elif value.startswith('<='):
1483
                  where_expression += ["%s <= '%s'" % (key, value[2:])]
1484
                elif value.startswith('>'):
1485
                  where_expression += ["%s > '%s'" % (key, value[1:])]
1486
                elif value.startswith('<'):
1487
                  where_expression += ["%s < '%s'" % (key, value[1:])]
1488
                elif value.startswith('!='):
Sebastien Robin's avatar
Sebastien Robin committed
1489
                  where_expression += ["%s != '%s'" % (key, value[2:])]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1490 1491
                elif key in keyword_search_keys:
                  # We must add % in the request to simulate the catalog
1492
                  where_expression += ["%s LIKE '%%%s%%'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1493 1494
                elif key in full_text_search_keys:
                  # We must add % in the request to simulate the catalog
1495
                  where_expression += ["MATCH %s AGAINST ('%s')" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1496
                else:
1497
                  where_expression += ["%s = '%s'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1498 1499 1500 1501 1502 1503 1504
            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
1505 1506
                  if type(value_item) in (type(1), type(1.0),
                                          type(1991643034L)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1507 1508
                    query_item += ["%s = %s" % (key, value_item)]
                  else:
1509
                    # For security.
1510
                    value_item = self._quoteSQLString(value_item)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1511
                    if '%' in value_item:
1512
                      query_item += ["%s LIKE '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1513 1514
                    elif key in keyword_search_keys:
                      # We must add % in the request to simulate the catalog
1515
                      query_item += ["%s LIKE '%%%s%%'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1516 1517 1518 1519
                    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:
1520
                      query_item += ["%s = '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1521
              if len(query_item) > 0:
1522
                where_expression += ['(%s)' % join(query_item, ' OR ')]
1523 1524
            elif type(value) is type({}):
              # We are in the case of a complex query
1525
              query_item = []
1526
              query_value = value['query']
1527 1528
              if type(query_value) != type([]) and type(query_value) != type(()) :
                query_value = [query_value]
1529
              operator_value = sql_quote(value.get('operator', 'or'))
1530
              range_value = value.get('range')
1531

1532
              if range_value :
1533 1534
                query_min = self._quoteSQLString(min(query_value))
                query_max = self._quoteSQLString(max(query_value))
1535
                if range_value == 'min' :
1536
                  query_item += ["%s >= '%s'" % (key, query_min) ]
1537
                elif range_value == 'max' :
1538
                  query_item += ["%s < '%s'" % (key, query_max) ]
1539
                elif range_value == 'minmax' :
1540
                  query_item += ["%s >= '%s' and %s < '%s'" % (key, query_min, key, query_max) ]
1541 1542
                elif range_value == 'minngt' :
                  query_item += ["%s >= '%s' and %s <= '%s'" % (key, query_min, key, query_max) ]
1543
                elif range_value == 'ngt' :
1544
                  query_item += ["%s <= '%s'" % (key, query_max) ]
1545 1546
              else :
                for query_value_item in query_value :
1547
                  query_item += ['%s = %s' % (key, self._quoteSQLString(query_value_item))]
1548 1549
              if len(query_item) > 0:
                where_expression += ['(%s)' % join(query_item, ' %s ' % operator_value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1550
            else:
1551
              where_expression += ["%s = %s" % (key, self._quoteSQLString(value))]
1552 1553
          elif key in topic_search_keys:
            # ERP5 CPS compatibility
1554
            topic_operator = 'or'
1555
            if type(value) is type({}):
1556
              topic_operator = sql_quote(value.get('operator', 'or'))
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
              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 :
1568
                    topic_key = '%s.%s' % (acceptable_key_map[topic_key][0], topic_key)
1569 1570
                  # query_table specifies what table name should be used
                  elif query_table:
1571
                    topic_key = '%s.%s' % (query_table, topic_key)
1572
                # Add table to table dict
1573
                from_table_dict[acceptable_key_map[topic_key][0]] = acceptable_key_map[topic_key][0] # We use catalog by default
1574
                query_item += ["%s = 1" % topic_key]
1575
            # Join
1576 1577
            if len(query_item) > 0:
              where_expression += ['(%s)' % join(query_item, ' %s ' % topic_operator)]
1578 1579
      # Calculate extra where_expression based on required joins
      for k, tid in from_table_dict.items():
1580
        if k != query_table:
1581 1582
          where_expression.append('%s.uid = %s.uid' % (query_table, tid))
      # Calculate extra where_expressions based on related definition
1583
      for (table_list,method_id) in related_methods.keys():
1584 1585 1586 1587
        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
1588
          for t_tuple in related_table_map[(table_list,method_id)]:
1589 1590 1591 1592
            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))
1593
      # Concatenate where_expressions
1594
      if kw.get('where_expression'):
1595
        if len(where_expression) > 0:
1596
          where_expression = "(%s) AND (%s)" % (kw['where_expression'], join(where_expression, ' AND ') )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1597
      else:
1598
        where_expression = join(where_expression, ' AND ')
1599

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1600 1601 1602 1603 1604
      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
1605

1606
    # Use a dictionary at the moment.
1607
    return { 'from_table_list' : from_table_dict.items(),
1608
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1609 1610
             'where_expression' : where_expression,
             'limit_expression' : limit_expression }
1611

1612
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, **kw):
1613 1614 1615 1616 1617
    """ 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
1618
    kw['limit_expression'] = query['limit_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1619
    # Return the result
1620

1621 1622 1623 1624
    #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()))
1625
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1626

1627
  def searchResults(self, REQUEST=None, used=None, **kw):
1628
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1629
    """ Returns a list of brains from a set of constraints on variables """
1630
    # The used argument is deprecated and is ignored
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1631 1632 1633 1634 1635 1636 1637
    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)
1638 1639
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1640
    except:
1641
      LOG("Warning: could not search catalog",0,self.sql_search_results, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1642 1643 1644 1645 1646
      return []

  __call__ = searchResults

  def countResults(self, REQUEST=None, used=None, **kw):
1647 1648
    """ 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
1649 1650 1651 1652 1653 1654 1655
    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)
1656 1657
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1658
    except:
1659
      LOG("Warning: could not count catalog",0,self.sql_count_results, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1660 1661
      return [[0]]

1662
  def recordCatalogObjectList(self, path_list):
1663 1664 1665
    """
      Record the path of an object being catalogged.
    """
1666 1667
    method = getattr(self, self.sql_record_catalog_object_list)
    method(path_list=path_list)
1668 1669 1670 1671 1672 1673 1674 1675

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

1676
  def deleteRecordedObjectList(self, path):
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
    """
      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:
1700
      method_id_list = [zsql_method.id for zsql_method in self.getFilterableMethodList()]
1701

1702 1703 1704 1705
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
1706

1707
      for id in method_id_list:
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 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
        # 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,
1821 1822 1823 1824 1825 1826 1827
            #'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
1828 1829 1830 1831 1832 1833
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

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