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

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

29
from DateTime import DateTime
Jean-Paul Smets's avatar
Jean-Paul Smets committed
30 31
from Products.PluginIndexes.common.randid import randid
from Acquisition import aq_parent, aq_inner, aq_base, aq_self
32
from zLOG import LOG, WARNING, INFO
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
try:
62
  from Products.ERP5Type.Cache import enableReadOnlyTransactionCache, disableReadOnlyTransactionCache
63 64 65
except ImportError:
  def doNothing(context):
    pass
66 67
  enableReadOnlyTransactionCache = doNothing
  disableReadOnlyTransactionCache = doNothing
68
  
69
UID_BUFFER_SIZE = 300
70

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
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)

91 92 93 94
    
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
  
Yoshinori Okuji's avatar
Yoshinori Okuji committed
95
  def __init__(self):
96 97 98 99 100 101 102
    """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
103
      invalid afterwards, so they may not be used by other transactions."""
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 141 142 143 144 145 146 147 148
    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:
149
      uid = self.temporary_buffer[tid].pop()
150
    except (KeyError, IndexError):
151 152
      uid = self.finished_buffer.pop()
    return uid
153 154 155 156
      
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
157
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
158 159

class Catalog(Folder, Persistent, Acquisition.Implicit, ExtensionClass.Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
160 161 162 163
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
164
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180

  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
  """
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
  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',
238
      'getFilterableMethodList', ],
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
     ['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' },
264 265 266 267 268
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
269 270
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
271 272 273 274 275 276 277 278
      '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' },
279 280 281
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
282 283
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
284 285 286
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
287 288
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
289 290
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
291 292 293
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
294
    { 'id'      : 'sql_record_object_list',
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 389 390 391
      'description' : 'Method to record catalog information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_read_recorded_object_list',
      'description' : 'Method to get recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_delete_recorded_object_list',
      'description' : 'Method to delete recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_tables',
      'description' : 'Tables to join in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getTableIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_result_keys',
      'description' : 'Keys to display in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getResultColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_count_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_path',
      'description' : 'Get a catalog brain by path',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_uid',
      'description' : 'Get a catalog brain by uid',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_tables',
      'description' : 'Method to get the main catalog tables',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_schema',
      'description' : 'Method to get the main catalog schema',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_unique_values',
      'description' : 'Find unique disctinct values in a column',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_paths',
      'description' : 'List all object paths in catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_keyword_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_full_text_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_request_keys',
      'description' : 'Columns which should be ignore in the REQUEST in order to accelerate caching',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_multivalue_keys',
      'description' : 'Keys which hold multiple values',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_topic_search_keys',
      'description' : 'Columns which should be considered as topic index',
      'type'    : 'lines',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_related_keys',
      'title'   : 'Related keys',
      'description' : 'Additional columns obtained through joins',
      'type'    : 'lines',
      'mode'    : 'w' },
  )

  sql_catalog_produce_reserved = 'z_produce_reserved_uid_list'
  sql_catalog_clear_reserved = 'z_clear_reserved'
392
  sql_catalog_reserve_uid = 'z_reserve_uid'
393
  sql_catalog_object_list = ('z_catalog_object_list',)
394 395
  sql_uncatalog_object = ('z_uncatalog_object',)
  sql_clear_catalog = ('z_drop_catalog', 'z_create_catalog')
396 397
  sql_catalog_translation_list = 'z_catalog_translation_list'
  sql_delete_translation_list = 'z_delete_translation_list'
398
  sql_record_object_list = 'z_record_object_list'
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
  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 = ()

418 419 420 421 422 423
  # 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
424

425 426 427 428 429 430 431
  # 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
432

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

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

          setattr(self, id, value)
541

542 543 544
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
545
          id = str(filt.getAttribute("id"))
546 547 548 549 550 551 552 553 554 555 556 557
          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
558 559 560 561 562 563 564 565 566 567
      finally:
        doc.unlink()
    finally:
      f.close()

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

  security.declarePrivate('getSecurityUid')
568
  def getSecurityUid(self, wrapped_object):
569 570 571 572 573 574 575
    """
      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
576
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
577 578 579 580
    # 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)
581 582
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
583 584 585 586 587 588 589
      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
590 591 592 593 594 595
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
596
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
597 598
      try:
        method()
599 600
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
601
      except:
Romain Courteaud's avatar
Romain Courteaud committed
602 603
        LOG('SQLCatalog', WARNING, 
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
604
        pass
605

606
    # Reserved uids have been removed.
607
    self.clearReserved()
608

609 610 611 612 613
    # 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)
614
      method(uid = [self._max_uid()])
615

616
    # Remove the cache of catalog schema.
617 618
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
619

620
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
621

622 623 624 625 626 627
  def clearReserved(self):
    """
    Clears reserved uids
    """
    method_id = self.sql_catalog_clear_reserved
    method = getattr(self, method_id)
Romain Courteaud's avatar
Romain Courteaud committed
628 629 630 631 632 633 634 635 636
    try:
      method()
    except ConflictError:
      raise
    except:
      LOG('SQLCatalog', WARNING, 
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
637
    self._last_clear_reserved_time += 1
638

Jean-Paul Smets's avatar
Jean-Paul Smets committed
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
  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

670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  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

687
  security.declarePublic('getCatalogSearchResultKeys')
688 689 690 691 692
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
  
693 694
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
695

696 697 698 699 700 701 702 703 704
    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)
705 706
      except ConflictError:
        raise
707
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
708
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
709 710 711
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
712

713
    return catalog_schema_dict[table]
714

Jean-Paul Smets's avatar
Jean-Paul Smets committed
715 716
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
717 718
    Calls the show column method and returns dictionnary of
    Field Ids
719

720
    XXX This should be cached
Jean-Paul Smets's avatar
Jean-Paul Smets committed
721 722 723
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
724 725 726 727
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys[field] = 1
        keys['%s.%s' % (table, field)] = 1  # Is this inconsistent ?
728
    for related in self.getSqlCatalogRelatedKeyList():
729 730 731
      related_tuple = related.split('|')
      related_key = related_tuple[0].strip()
      keys[related_key] = 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
732 733 734 735
    keys = keys.keys()
    keys.sort()
    return keys

736 737 738 739
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
740

741 742 743 744
    XXX This should be cached
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
745 746 747 748 749 750 751 752
      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 ?
753
    return keys
754

Jean-Paul Smets's avatar
Jean-Paul Smets committed
755 756 757 758 759 760 761
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
762 763 764
      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
765 766 767 768 769 770 771
    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
772 773 774
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
775 776
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
777 778 779
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
780
        keys.append(c[0])
781 782
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
783 784
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
785 786 787
    return keys

  # the cataloging API
788 789 790
  def produceUid(self):
    """
      Produces reserved uids in advance
791
    """
792 793 794 795 796
    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
797
      self._v_uid_buffer = UidBuffer()
798
      klass._local_clear_reserved_time = self._last_clear_reserved_time
799
    elif getattr(self, '_v_uid_buffer', None) is None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
800
      self._v_uid_buffer = UidBuffer()
801
    if len(self._v_uid_buffer) == 0:
802 803
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
804 805 806 807 808 809 810 811
      # 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()
812 813
      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)
814

815 816 817
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
818 819
      with multiple ZEO clients on a single ZEO server.

820
      The main risk is the following:
821

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

824
      - one reindexing node N1 starts reindexing f
825

826
      - another reindexing node N2 starts reindexing e
827

828 829 830
      - 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

831
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
832
      with the risk of graph loops
833
    """
834 835 836 837 838 839 840 841 842 843 844 845
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
      site_root = getToolByName(self, 'portal_url').getPortalObject()
    else:
      zope_root = self.getPhysicalRoot()
      site_root = self.aq_parent

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

846 847 848 849
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
850 851
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
852 853 854 855 856 857
        # Vincent added this 2006/01/25
        #if uid > 4294967296: # 2**32
        #if uid > 10000000: # arbitrary level : below it's normal, above it's suspicious
        #   LOG('SQLCatalog', WARNING, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,))
        #   raise RuntimeError, 'Newly generated UID (%s) seems too big ! - vincent' % (uid,)
        # end
858 859 860 861 862 863 864 865 866
        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()
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
  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`)))

Romain Courteaud's avatar
Romain Courteaud committed
911 912
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None, 
                          URL1=None, sql_catalog_id=None):
913 914 915 916
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
917 918
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
                        'manage_tabs_message=Catalog%20Cleared' % URL1)
919 920 921 922 923 924

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

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
925 926
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
                        'manage_tabs_message=Catalog%20Cleared' % URL1)
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

  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
964
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
965 966 967 968 969 970 971 972 973
    """
    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

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

976
  def catalogObjectList(self, object_list, method_id_list=None, disable_cache=0,
977
                              check_uid=1):
978 979 980 981
    """
      Add objects to the Catalog by calling
      all SQL methods and providing needed arguments.

982 983 984 985 986 987 988
      method_id_list : specify which method should be used. If not
                       set it will take the default value of portal_catalog

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

989 990 991 992 993 994 995 996
      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?
    """
Yoshinori Okuji's avatar
Yoshinori Okuji committed
997
    LOG('SQLCatalog', INFO, 'catalogging %d objects' % len(object_list))
998
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
999

1000 1001
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
1002
      site_root = getToolByName(self, 'portal_url').getPortalObject()
1003 1004
    else:
      zope_root = self.getPhysicalRoot()
1005
      site_root = self.aq_parent
1006

1007
    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
1008 1009
    site_indexable = int(getattr(site_root, 'isIndexable', 1))
    if not (root_indexable and site_indexable):
1010 1011
      return

1012
    for object in object_list:
1013
      path = object.getPath()
1014
      if not getattr(aq_base(object), 'uid', None):
1015
        try:
1016
          object.uid = self.newUid()
1017 1018
        except ConflictError:
          raise
1019
        except:
1020
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1021
      elif check_uid:
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
        uid = object.uid
        path = object.getPath()
        index = self.getUidForPath(path)
        try:
          index = int(index)
        except TypeError:
          pass
        if index is not None and index < 0:
          raise CatalogError, 'A negative uid %d is used for %s. Your catalog is broken. Recreate your catalog.' % (index, path)
        if index:
          if uid != index:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1033
            LOG('SQLCatalog', WARNING, 'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, index))
1034 1035 1036 1037 1038 1039
            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
1040
          catalog_path = self.getPathForUid(uid)
1041 1042 1043 1044 1045 1046
          #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()
1047
              if getattr(self, '_v_uid_buffer', None) is not None:
1048 1049 1050 1051 1052 1053 1054 1055
                # 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.
1056 1057 1058 1059
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1060 1061 1062 1063 1064
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1065 1066
            LOG('SQLCatalog', WARNING,
                'uid of %r changed from %r to %r !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid))
1067

1068 1069
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1070
    econtext_cache = {}
1071
    argument_cache = {}
1072
    expression_cache = {}
1073

1074
    try:
1075
      if not disable_cache:
1076
        enableReadOnlyTransactionCache(self)
1077 1078
      
      method_kw_dict = {}
1079
      for method_name in method_id_list:
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
        kw = {}
        if self.isMethodFiltered(method_name) and self.filter_dict.has_key(method_name):
          catalogged_object_list = []
          type_list = self.filter_dict[method_name]['type']
          expression = self.filter_dict[method_name]['expression_instance']
          for object in object_list:
            # We will check if there is an filter on this
            # method, if so we may not call this zsqlMethod
            # for this object
            portal_type = object.getPortalType()
            if type_list and portal_type not in type_list:
              continue
            elif expression is not None:
              expression_key = (object.uid, self.filter_dict[method_name]['expression'])
1094
              try:
1095
                result = expression_cache[expression_key]
1096
              except KeyError:
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
                try:
                  econtext = econtext_cache[object.uid]
                except KeyError:
                  econtext = econtext_cache[object.uid] = self.getExpressionContext(object)
                result = expression_cache[expression_key] = expression(econtext)
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
  
        if len(catalogged_object_list) == 0:
          continue
  
        method_kw_dict[method_name] = kw
        
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
        if method.meta_type == "Z SQL Method":
          # Build the dictionnary of values
          arguments = method.arguments_src
          for arg in split(arguments):
            value_list = []
            append = value_list.append
            for object in catalogged_object_list:
1122
              try:
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
                value = argument_cache[(object.uid, arg)]
              except KeyError:
                try:
                  value = getattr(object, arg, None)
                  if callable(value):
                    value = value()
                except ConflictError:
                  raise
                except:
                  value = None
1133 1134
                if not disable_cache:
                  argument_cache[(object.uid, arg)] = value
1135 1136 1137
              append(value)
            kw[arg] = value_list
            
1138
      for method_name in method_id_list:
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
        if method_name not in method_kw_dict:
          continue
        kw = method_kw_dict[method_name]
        method = getattr(self, method_name)
        method = aq_base(method).__of__(site_root.portal_catalog) # Use method in 
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
          #LOG('catalogObjectList', 0, 'kw = %r, method_name = %r' % (kw, method_name))
          method(**kw)
          #end_time = DateTime()
          #if method_name not in profile_dict:
          #  profile_dict[method_name] = end_time.timeTime() - start_time.timeTime()
          #else:
          #  profile_dict[method_name] += end_time.timeTime() - start_time.timeTime()
          #LOG('catalogObjectList', 0, '%s: %f seconds' % (method_name, profile_dict[method_name]))
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1159
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1160 1161 1162
              error=sys.exc_info())
          raise
    finally:
1163
      if not disable_cache:
1164
        disableReadOnlyTransactionCache(self)
1165

1166
  if psyco is not None: psyco.bind(catalogObjectList)
1167

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
  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

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

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1183 1184 1185 1186 1187
    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
1188
        #if 1:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1189
        method(uid = uid)
1190 1191
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1192 1193 1194
      except:
        # This is a real LOG message
        # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1195 1196
        LOG('SQLCatalog', WARNING,
            'could not uncatalog object %s uid %s with method %s' % (path, uid, method_name))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1197

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
    return self.catalogObjectList(object_list, method_id_list = (method_name,))
    
  def deleteTranslationList(self):
    """Delete translations.
    """
    method_name = self.sql_delete_translation_list
    method = getattr(self, method_name)
    try:
      method()
    except ConflictError:
      raise
    except:
      LOG('SQLCatalog', WARNING, 'could not delete translations', error=sys.exc_info())
    
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
  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)
1233
      search_result = method(path = path, uid_only=1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1234 1235 1236 1237 1238
      # If not emptyn return first record
      if len(search_result) > 0:
        return search_result[0].uid
      else:
        return None
1239 1240
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1241 1242 1243
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1244
      LOG('SQLCatalog', WARNING, "could not find uid from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
      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
1256 1257 1258 1259
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1260 1261 1262 1263 1264 1265 1266 1267
      # 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
1268 1269
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1270 1271 1272
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1273
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
      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
1304 1305
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1306 1307 1308
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1309
      LOG('SQLCatalog', WARNING, "could not find uid from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1310 1311 1312 1313 1314 1315
      return None

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

1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
  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

1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
  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

1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
  def getSqlCatalogRelatedKeyList(self, **kw):
    """
    Return the list of related keys.
    This method can be overidden in order to implement 
    dynamic generation of some related keys.
    """
    dynamic_list = self.getDynamicRelatedKeyList(**kw)
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1362 1363
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
                          ignore_empty_string=1,**kw):
1364
    """ Builds a complex SQL query to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1365 1366 1367 1368 1369 1370 1371
    # 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

1372
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1373 1374 1375 1376
    # If kw is not set, then use REQUEST instead
    if kw is None or kw == {}:
      kw = REQUEST

1377
    acceptable_key_map = self.getColumnMap()
1378
    acceptable_keys = acceptable_key_map.keys()
1379 1380
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1381
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1382
    multivalue_keys = self.sql_catalog_multivalue_keys
1383

1384 1385
    # Define related maps
    # each tuple has the form (key, 'table1,table2,table3/column/where_expression')
1386
    related_tuples = self.getSqlCatalogRelatedKeyList(**kw)
1387
    #LOG('related_tuples', 0, str(related_tuples))
1388 1389 1390 1391
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1392
    related_table_list = {}
1393
    table_rename_index = 0
1394
    related_methods = {} # related methods which need to be used
1395 1396 1397 1398
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1399
      #LOG('related_tuples', 0, str(join_tuple))
1400
      related_keys.append(key)
1401
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1402
      method_id = join_tuple[2]
1403
      table_list = tuple(join_tuple[0].split(','))
1404
      related_method[key] = method_id
1405
      related_table_list[key] = table_list
1406 1407
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1408
      if not related_table_map.has_key((table_list,method_id)):
1409
        map_list = []
1410
        for table_id in table_list:
1411
          map_list.append((table_id,
1412 1413
             "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
1414
        related_table_map[(table_list,method_id)] = map_list
1415

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1416 1417
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1418
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1419 1420 1421
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1422
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1423
            kw[key] = REQUEST[key]
1424
      # Let us try first not to use this
1425 1426 1427
      #for key in related_keys:
      #  if REQUEST.has_key(key):
      #    kw[key] = REQUEST[key]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1428

1429
    # Let us start building the where_expression
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1430
    if kw:
1431
      where_expression = []
1432
      from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452


      # 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

1453 1454 1455 1456 1457 1458
      # 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
1459

1460

1461 1462 1463
      # If sort_index is a dictionnary
      # then parse it and change it
      sort_on = None
1464
      #LOG('sorting', 0, str(sort_index))
1465
      if sort_index is not None:
1466 1467 1468 1469 1470 1471 1472
        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
1473 1474
        try:
          new_sort_index = []
1475
          for (key , so, as_type) in sort_index:
1476 1477 1478 1479 1480 1481
            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]
1482 1483 1484 1485
                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
1486
                key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1487 1488 1489 1490
              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 :
1491
                    key = '%s.%s' % (acceptable_key_map[key][0], key)
1492 1493
                  # query_table specifies what table name should be used by default
                  elif query_table:
1494
                    key = '%s.%s' % (query_table, key)
1495 1496 1497 1498 1499
                  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
1500 1501
              if as_type == 'int':
                key = 'CAST(' + key + ' AS SIGNED)'
1502
              if so in ('descending', 'reverse', 'DESC'):
1503 1504 1505
                new_sort_index += ['%s DESC' % key]
              else:
                new_sort_index += ['%s' % key]
1506 1507
          sort_index = join(new_sort_index,',')
          sort_on = str(sort_index)
1508 1509
        except ConflictError:
          raise
1510
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1511
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new sort index', error=sys.exc_info())
1512 1513
          pass

1514 1515 1516 1517 1518 1519
      # 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]
1520
          if not new_kw.has_key(new_k): new_kw[new_k] = {}
1521
          if type(new_kw[new_k]) is not type({}): new_kw[new_k] = {'query': new_kw[new_k]}
1522
          split_v = v.split(':')
1523 1524 1525 1526
          new_kw[new_k] = {split_v[0]: split_v[1]}
        else:
          if not new_kw.has_key(k):
            new_kw[k] = v
1527
          else:
1528 1529 1530 1531
            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
1532 1533
      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
1534
        if key not in ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit'):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1535
          # Make sure key belongs to schema
1536 1537 1538 1539 1540 1541
          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]
1542 1543 1544 1545
              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
1546
              base_key = key
1547
              key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], related_column[key])
1548 1549 1550 1551
              if base_key in keyword_search_keys:
                keyword_search_keys.append(key)
              if base_key in full_text_search_keys:
                full_text_search_keys.append(key)
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
            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
1565
            # Default case: variable equality
1566
            if type(value) is type('') or isinstance(value, DateTime):
1567
              # For security.
1568
              value = self._quoteSQLString(value)
1569
              if value != '' or not ignore_empty_string:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1570 1571 1572 1573 1574
                # we consider empty string as Non Significant
                if value == '=':
                  # But we consider the sign = as empty string
                  value=''
                if '%' in value:
1575
                  where_expression += ["%s LIKE '%s'" % (key, value)]
1576
                elif value.startswith('>='):
1577
                  where_expression += ["%s >= '%s'" % (key, value[2:])]
1578
                elif value.startswith('<='):
1579
                  where_expression += ["%s <= '%s'" % (key, value[2:])]
1580
                elif value.startswith('>'):
1581
                  where_expression += ["%s > '%s'" % (key, value[1:])]
1582
                elif value.startswith('<'):
1583
                  where_expression += ["%s < '%s'" % (key, value[1:])]
1584
                elif value.startswith('!='):
Sebastien Robin's avatar
Sebastien Robin committed
1585
                  where_expression += ["%s != '%s'" % (key, value[2:])]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1586 1587
                elif key in keyword_search_keys:
                  # We must add % in the request to simulate the catalog
1588
                  where_expression += ["%s LIKE '%%%s%%'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1589 1590
                elif key in full_text_search_keys:
                  # We must add % in the request to simulate the catalog
1591
                  where_expression += ["MATCH %s AGAINST ('%s')" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1592
                else:
1593
                  where_expression += ["%s = '%s'" % (key, value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1594 1595 1596 1597
            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:
1598
                if value_item != '' or not ignore_empty_string:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1599 1600
                  # we consider empty string as Non Significant
                  # also for lists
1601 1602
                  if type(value_item) in (type(1), type(1.0),
                                          type(1991643034L)):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1603 1604
                    query_item += ["%s = %s" % (key, value_item)]
                  else:
1605
                    # For security.
1606
                    value_item = self._quoteSQLString(value_item)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1607
                    if '%' in value_item:
1608
                      query_item += ["%s LIKE '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1609 1610
                    elif key in keyword_search_keys:
                      # We must add % in the request to simulate the catalog
1611
                      query_item += ["%s LIKE '%%%s%%'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1612 1613 1614 1615
                    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:
1616
                      query_item += ["%s = '%s'" % (key, value_item)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1617
              if len(query_item) > 0:
1618
                where_expression += ['(%s)' % join(query_item, ' OR ')]
1619 1620
            elif type(value) is type({}):
              # We are in the case of a complex query
1621
              query_item = []
1622
              query_value = value['query']
1623 1624
              if type(query_value) != type([]) and type(query_value) != type(()) :
                query_value = [query_value]
1625
              operator_value = sql_quote(value.get('operator', 'or'))
1626
              range_value = value.get('range')
1627

1628
              if range_value :
1629 1630
                query_min = self._quoteSQLString(min(query_value))
                query_max = self._quoteSQLString(max(query_value))
1631
                if range_value == 'min' :
1632
                  query_item += ["%s >= '%s'" % (key, query_min) ]
1633
                elif range_value == 'max' :
1634
                  query_item += ["%s < '%s'" % (key, query_max) ]
1635
                elif range_value == 'minmax' :
1636
                  query_item += ["%s >= '%s' and %s < '%s'" % (key, query_min, key, query_max) ]
1637 1638
                elif range_value == 'minngt' :
                  query_item += ["%s >= '%s' and %s <= '%s'" % (key, query_min, key, query_max) ]
1639
                elif range_value == 'ngt' :
1640
                  query_item += ["%s <= '%s'" % (key, query_max) ]
1641 1642
              else :
                for query_value_item in query_value :
1643
                  query_item += ['%s = %s' % (key, self._quoteSQLString(query_value_item))]
1644 1645
              if len(query_item) > 0:
                where_expression += ['(%s)' % join(query_item, ' %s ' % operator_value)]
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1646
            else:
1647
              where_expression += ["%s = %s" % (key, self._quoteSQLString(value))]
1648 1649
          elif key in topic_search_keys:
            # ERP5 CPS compatibility
1650
            topic_operator = 'or'
1651
            if type(value) is type({}):
1652
              topic_operator = sql_quote(value.get('operator', 'or'))
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
              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 :
1664
                    topic_key = '%s.%s' % (acceptable_key_map[topic_key][0], topic_key)
1665 1666
                  # query_table specifies what table name should be used
                  elif query_table:
1667
                    topic_key = '%s.%s' % (query_table, topic_key)
1668
                # Add table to table dict
1669
                from_table_dict[acceptable_key_map[topic_key][0]] = acceptable_key_map[topic_key][0] # We use catalog by default
1670
                query_item += ["%s = 1" % topic_key]
1671
            # Join
1672 1673
            if len(query_item) > 0:
              where_expression += ['(%s)' % join(query_item, ' %s ' % topic_operator)]
1674 1675
      # Calculate extra where_expression based on required joins
      for k, tid in from_table_dict.items():
1676
        if k != query_table:
1677 1678
          where_expression.append('%s.uid = %s.uid' % (query_table, tid))
      # Calculate extra where_expressions based on related definition
1679
      for (table_list,method_id) in related_methods.keys():
1680 1681 1682
        related_method = getattr(self, method_id, None)
        if related_method is not None:
          table_id = {'src__' : 1} # Return query source, do not evaluate
1683
          table_id['query_table'] = query_table
1684
          table_index = 0
1685
          for t_tuple in related_table_map[(table_list,method_id)]:
1686 1687 1688 1689
            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))
1690
      # Concatenate where_expressions
1691
      if kw.get('where_expression'):
1692
        if len(where_expression) > 0:
1693
          where_expression = "(%s) AND (%s)" % (kw['where_expression'], join(where_expression, ' AND ') )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1694
      else:
1695
        where_expression = join(where_expression, ' AND ')
1696

Yoshinori Okuji's avatar
Yoshinori Okuji committed
1697 1698 1699 1700 1701
      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
1702

1703
    # Use a dictionary at the moment.
1704
    return { 'from_table_list' : from_table_dict.items(),
1705
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1706 1707
             'where_expression' : where_expression,
             'limit_expression' : limit_expression }
1708

1709
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, **kw):
1710 1711 1712 1713 1714
    """ 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
1715
    kw['limit_expression'] = query['limit_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1716
    # Return the result
1717

1718 1719 1720 1721
    #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()))
1722
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1723

1724
  def searchResults(self, REQUEST=None, used=None, **kw):
1725
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1726
    """ Returns a list of brains from a set of constraints on variables """
1727
    # The used argument is deprecated and is ignored
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1728 1729 1730 1731 1732 1733 1734
    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)
1735 1736
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1737
    except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1738
      LOG('SQLCatalog', WARNING, "could not search catalog", error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1739 1740 1741 1742 1743
      return []

  __call__ = searchResults

  def countResults(self, REQUEST=None, used=None, **kw):
1744 1745
    """ 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
1746 1747 1748 1749 1750 1751 1752
    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)
1753 1754
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1755
    except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1756
      LOG('SQLCatalog', WARNING, "could not count catalog", error=sys.exc_info())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1757 1758
      return [[0]]

1759
  def recordObjectList(self, path_list, catalog=1):
1760
    """
1761
      Record the path of an object being catalogged or uncatalogged.
1762
    """
1763 1764
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
1765

1766
  def deleteRecordedObjectList(self, uid_list=()):
1767 1768 1769 1770
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
1771
    method(uid_list=uid_list)
1772

1773
  def readRecordedObjectList(self, catalog=1):
1774 1775 1776 1777
    """
      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)
1778
    return method(catalog=catalog)
1779 1780 1781 1782 1783 1784 1785 1786 1787

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

1790 1791 1792 1793
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
1794

1795
      for id in method_id_list:
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 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
        # 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:
1893 1894 1895 1896
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
      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,
1911 1912 1913 1914 1915 1916 1917
            #'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
1918 1919 1920 1921 1922 1923
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

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