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

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

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

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

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

60 61 62 63
try:
  import psyco
except ImportError:
  psyco = None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
64

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

81
UID_BUFFER_SIZE = 300
82 83
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
                     'format', 'search_mode', 'operator')
84

85 86
valid_method_meta_type_list = ('Z SQL Method', 'Script (Python)')

87 88 89 90
full_text_search_modes = { 'natural': '',
                           'in_boolean_mode': 'IN BOOLEAN MODE',
                           'with_query_expansion': 'WITH QUERY EXPANSION' }

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
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)

109

110 111
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
112

Yoshinori Okuji's avatar
Yoshinori Okuji committed
113
  def __init__(self):
114
    """Initialize some variables.
115

116
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
117

118
      finished_buffer is used to hold reserved uids created by committed-transactions.
119

120
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
121
      invalid afterwards, so they may not be used by other transactions."""
122 123
    self.temporary_buffer = {}
    self.finished_buffer = []
124

125 126 127 128 129 130 131 132
  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
133

134 135 136 137 138 139 140
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
141

142 143 144 145 146 147 148 149
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
150

151 152 153 154 155 156 157 158 159 160 161
  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
162

163 164 165 166
  def pop(self):
    self._register()
    tid = get_ident()
    try:
167
      uid = self.temporary_buffer[tid].pop()
168
    except (KeyError, IndexError):
169 170
      uid = self.finished_buffer.pop()
    return uid
171

172 173 174
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
175
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
176

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
class QueryMixin:

  def getOperator(self):
    return self.operator

  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

class Query(QueryMixin):
  """
  This allow to define constraints on a sql column
196 197

  format - %d/%m/%Y
198
  """
199 200
  def __init__(self, format=None, operator=None, range=None,
                     search_mode=None, **kw):
201 202 203 204 205 206 207
    self.format = format
    if operator is None:
      operator = 'OR'
    self.operator = operator
    self.range = range
    self.search_mode = search_mode
    key_list = kw.keys()
208
    if len(key_list) != 1:
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
      raise KeyError, 'Query must have only one key'
    self.key = key_list[0]
    self.value = kw[self.key]

  def __call__(self):
    self.asSQLExpression()

  def getRange(self):
    return self.range

  def getFormat(self):
    return self.format

  def getSearchMode(self):
    return self.search_mode

225 226 227
  def asSQLExpression(self, key_alias_dict=None,
                            keyword_search_keys=None,
                            full_text_search_keys=None,
228
                            ignore_empty_string=1, stat__=0):
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
    """
    Build the sql string
    """
    sql_expression = ''
    value = self.getValue()
    key = self.getKey()
    ignore_key=0
    if key_alias_dict is not None:
      # Try to find the alias
      if key not in key_alias_dict:
        ignore_key=1
      else:
        key = key_alias_dict.get(key)
        if key is None:
          ignore_key=1
    where_expression = []
    select_expression = []
    # Default case: variable equality
    range_value = self.getRange()
    if ignore_key:
      pass
    elif range_value is not None:
      if isinstance(value, (list, tuple)):
        query_min = self._quoteSQLString(min(value))
        query_max = self._quoteSQLString(max(value))
      else:
        query_min=query_max=value
      if range_value == 'min' :
        where_expression.append("%s >= '%s'" % (key, query_min))
      elif range_value == 'max' :
        where_expression.append("%s < '%s'" % (key, query_max))
      elif range_value == 'minmax' :
        where_expression.append("%s >= '%s' and %s < '%s'" % (key, query_min, key, query_max))
      elif range_value == 'minngt' :
        where_expression.append("%s >= '%s' and %s <= '%s'" % (key, query_min, key, query_max))
      elif range_value == 'ngt' :
        where_expression.append("%s <= '%s'" % (key, query_max))
    elif isinstance(value, basestring) or isinstance(value, DateTime) \
        or isinstance(value, (list, tuple)):
      value_list = value
      if isinstance(value, basestring) or isinstance(value, DateTime):
        value_list = [value]
      # For security.
      for value in value_list:
        value = self._quoteSQLString(value)
        if value != '' or not ignore_empty_string:
          if '%' in value:
            where_expression.append("%s LIKE '%s'" % (key, value))
          elif value.startswith('='):
            where_expression.append("%s = '%s'" % (key, value[1:]))
          elif value.startswith('>='):
            where_expression.append("%s >= '%s'" % (key, value[2:]))
          elif value.startswith('<='):
            where_expression.append("%s <= '%s'" % (key, value[2:]))
          elif value.startswith('>'):
            where_expression.append("%s > '%s'" % (key, value[1:]))
          elif value.startswith('<'):
            where_expression.append("%s < '%s'" % (key, value[1:]))
          elif value.startswith('!='):
            where_expression.append("%s != '%s'" % (key, value[2:]))
          elif key in keyword_search_keys:
            # We must add % in the request to simulate the catalog
            where_expression.append("%s LIKE '%%%s%%'" % (key, value))
          elif key in full_text_search_keys:
            # We must add % in the request to simulate the catalog
            # we first check if there is a special search_mode for this key
            # incl. table name, or for all keys of that name,
            # or there is a search_mode supplied for all fulltext keys
            # or we fall back to natural mode
            search_mode=self.getSearchMode()
            if search_mode is None:
              search_mode = 'natural'
            search_mode=search_mode.lower()
            mode = full_text_search_modes.get(search_mode,'')
            where_expression.append("MATCH %s AGAINST ('%s' %s)" % (key, value, mode))
            if not stat__:
              # we return relevance as Table_Key_relevance
              select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.replace('.','_')))
              # and for simplicity as Key_relevance
              if '.' in key:
                select_expression.append("MATCH %s AGAINST ('%s' %s) AS %s_relevance" % (key, value, mode,key.split('.')[1]))
          else:
            where_expression.append("%s = '%s'" % (key, value))
Aurel's avatar
Aurel committed
312

Nicolas Delaby's avatar
Nicolas Delaby committed
313 314
    elif value is None:
      where_expression.append("%s is NULL" % (key))
315 316 317 318 319 320 321 322
    else:
      where_expression.append("%s = %s" % (key, self._quoteSQLString(value)))

    if len(where_expression)>0:
      if len(where_expression)==1:
        where_expression = where_expression[0]
      else:
        where_expression = '(%s)' % (' %s ' % self.getOperator()).join(where_expression)
323 324
    else:
      where_expression = 'True' # It is better to have a valid default
325 326
    return {'where_expression':where_expression,
            'select_expression_list':select_expression}
Aurel's avatar
Aurel committed
327

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
  def getKey(self):
    return self.key

  def getValue(self):
    return self.value

  def getSQLKeyList(self):
    """
    Returns the list of keys used by this
    instance
    """
    return [self.getKey()]

allow_class(Query)

class ComplexQuery(QueryMixin):
  """
  Used in order to concatenate many queries
  """
347
  def __init__(self, *args, **kw):
348 349 350 351 352 353 354
    self.query_list = args
    operator = None
    if kw.has_key('operator'):
      operator = kw['operator']
      del kw['operator']
    if operator is None:
      operator = 'AND'
355
    self.operator = operator
356 357 358 359 360 361 362 363
    self.__dict__.update(kw)

  def __call__(self):
    self.asSQLExpression()

  def getQueryList(self):
    return self.query_list

364 365 366 367 368
  def asSQLExpression(self, key_alias_dict=None,
                            ignore_empty_string=1,
                            keyword_search_keys=None,
                            full_text_search_keys=None,
                            stat__=0):
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    """
    Build the sql string
    """
    sql_expression_list = []
    select_expression_list = []
    for query in self.getQueryList():
      query_result = query.asSQLExpression( key_alias_dict=key_alias_dict,
                             ignore_empty_string=ignore_empty_string,
                             keyword_search_keys=keyword_search_keys,
                             full_text_search_keys=full_text_search_keys,
                             stat__=stat__)
      sql_expression_list.append(query_result['where_expression'])
      select_expression_list.extend(query_result['select_expression_list'])
    operator = self.getOperator()
    result = {'where_expression':('(%s)' %  \
                         (' %s ' % operator).join(sql_expression_list)),
              'select_expression_list':select_expression_list}
    return result

  def getSQLKeyList(self):
    """
    Returns the list of keys used by this
    instance
    """
    key_list=[]
    for query in self.getQueryList():
      key_list.extend(query.getSQLKeyList())
    return key_list

allow_class(ComplexQuery)

400 401 402 403 404
class Catalog( Folder,
               Persistent,
               Acquisition.Implicit,
               ExtensionClass.Base,
               OFS.History.Historical ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
405 406 407 408
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
409
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
410 411 412 413 414 415 416 417

  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

418 419
  If you pass it a keyword argument which is present in sql_catalog_full_text_search_keys
  (in catalog properties), it does a MySQL full-text search.
420 421 422
  Additionally you can pass it a search_mode argument ('natural', 'in_boolean_mode'
  or 'with_query_expansion') to use an advanced search mode ('natural'
  is the default).
423 424 425
  search_mode arg can be given for all full_text keys, or for a specific key by naming
  the argument search_mode_KeyName, or even more specifically, search_mode_Table.Key
  or search_mode_Table_Key
426

Jean-Paul Smets's avatar
Jean-Paul Smets committed
427 428 429 430 431 432 433 434

  bgrain defined in meyhods...

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  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',
     'help':('ZCatalog','ZCatalog_Cataloged-Objects.stx')},
    {'label': 'Properties',     # TAB: Properties
     'action': 'manage_propertiesForm',
     'help': ('OFSP','Properties.stx')},
    {'label': 'Filter',     # TAB: Filter
     'action': 'manage_catalogFilter',},
    {'label': 'Find Objects',     # TAB: Find Objects
     'action': 'manage_catalogFind',
     'help':('ZCatalog','ZCatalog_Find-Items-to-ZCatalog.stx')},
    {'label': 'Advanced',       # TAB: Advanced
     'action': 'manage_catalogAdvanced',
     'help':('ZCatalog','ZCatalog_Advanced.stx')},
    {'label': 'Undo',         # TAB: Undo
     'action': 'manage_UndoForm',
     'help': ('OFSP','Undo.stx')},
    {'label': 'Security',       # TAB: Security
     'action': 'manage_access',
     'help': ('OFSP','Security.stx')},
    {'label': 'Ownership',      # TAB: Ownership
     'action': 'manage_owner',
     'help': ('OFSP','Ownership.stx'),}
466
    ) + OFS.History.Historical.manage_options
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

  __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',
489
      'getFilterableMethodList', ],
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
     ['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' },
515 516 517 518 519
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
520 521 522 523 524
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
525 526
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
527 528 529 530 531 532 533 534
      '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' },
535 536 537
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
538 539
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
540 541 542
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
543 544
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
545 546
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
547 548 549
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
550
    { 'id'      : 'sql_record_object_list',
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
      'description' : 'Method to record catalog information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_read_recorded_object_list',
      'description' : 'Method to get recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_delete_recorded_object_list',
      'description' : 'Method to delete recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
Aurel's avatar
Aurel committed
570 571 572 573 574
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
    { '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' },
610 611 612 613 614
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
615 616 617 618 619 620 621 622 623 624 625 626 627 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
    { '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' },
654 655 656 657 658
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
659 660
  )

661
  sql_catalog_produce_reserved = ''
662
  sql_catalog_delete_uid = ''
663 664 665 666 667 668 669 670 671 672 673
  sql_catalog_clear_reserved = ''
  sql_catalog_reserve_uid = ''
  sql_catalog_object_list = ()
  sql_uncatalog_object = ()
  sql_clear_catalog = ()
  sql_catalog_translation_list = ''
  sql_delete_translation_list = ''
  sql_record_object_list = ''
  sql_read_recorded_object_list = ''
  sql_delete_recorded_object_list = ''
  sql_search_results = ''
Aurel's avatar
Aurel committed
674
  sql_search_security = ''
675 676 677 678 679 680
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
681
  sql_catalog_index = ''
682 683 684
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
685 686 687 688 689 690
  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 = ()
691
  sql_catalog_scriptable_keys = ()
692

693 694 695 696 697 698
  # 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
699

700 701 702 703 704 705 706
  # 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
707

708 709 710 711 712 713 714 715 716 717
  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
718 719 720
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
721
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
722

723 724 725 726 727 728
  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')
729 730 731 732 733 734 735 736 737 738 739 740
    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]
741
      if isinstance(value, basestring):
742
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
743
      elif isinstance(value, (tuple, list)):
744 745 746
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
747
        for item in value:
748
          if isinstance(item, basestring):
749 750 751 752
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
753
        f.write('  </property>\n')
754 755 756
    # 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'):
757 758
      filter_list = []
      for filter_id in self.filter_dict.keys():
759
        filter_definition = self.filter_dict[filter_id]
760 761 762 763 764 765 766
        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']:
767 768
          # If a filter is not activated, no need to output it.
          continue
769
        if not filter_def['expression']:
770 771
          # If the expression is not specified, meaningless to specify it.
          continue
772
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
773
        # For now, portal types are not exported, because portal types are too specific to each site.
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
    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):
795
            raise CatalogError, 'unknown property id %r' % (id,)
796
          if type not in ('str', 'tuple'):
797
            raise CatalogError, 'unknown property type %r' % (type,)
798 799 800 801
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
802
                value = str(text.data)
803 804 805 806 807 808
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
809
                raise CatalogError, 'unknown item type %r' % (item_type,)
810 811
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
812
                  value.append(str(text.data))
813 814 815 816
                  break
            value = tuple(value)

          setattr(self, id, value)
817

818 819 820
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
821
          id = str(filt.getAttribute("id"))
822 823 824 825 826 827 828 829 830 831 832 833
          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
834 835 836 837
      finally:
        doc.unlink()
    finally:
      f.close()
Aurel's avatar
Aurel committed
838

839 840 841 842 843 844 845
  def manage_historyCompare(self, rev1, rev2, REQUEST,
                            historyComparisonResults=''):
    return Catalog.inheritedAttribute('manage_historyCompare')(
          self, rev1, rev2, REQUEST,
          historyComparisonResults=OFS.History.html_diff(
              pprint.pformat(rev1.__dict__),
              pprint.pformat(rev2.__dict__)))
846 847 848 849 850 851

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

  security.declarePrivate('getSecurityUid')
852
  def getSecurityUid(self, wrapped_object):
853 854 855 856 857 858 859
    """
      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
860
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
861 862 863 864
    # 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)
865 866
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
867 868 869 870 871 872 873
      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
874 875 876 877 878 879
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
880
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
881 882
      try:
        method()
883 884
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
885
      except:
886
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
887
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
888

889
    # Reserved uids have been removed.
890
    self.clearReserved()
891

892
    # Add a dummy item so that SQLCatalog will not use existing uids again.
893
    self.insertMaxUid()
894

895
    # Remove the cache of catalog schema.
896 897
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
898

899
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
900

901 902 903 904 905 906 907 908 909 910
  def insertMaxUid(self):
    """
      Add a dummy item so that SQLCatalog will not use existing uids again.
    """
    if self._max_uid is not None and self._max_uid() != 0:
      method_id = self.sql_catalog_reserve_uid
      method = getattr(self, method_id)
      self._max_uid.change(1)
      method(uid = [self._max_uid()])

911 912 913 914 915 916
  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
917 918 919 920 921
    try:
      method()
    except ConflictError:
      raise
    except:
922
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
923 924 925
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
926
    self._last_clear_reserved_time += 1
927

Jean-Paul Smets's avatar
Jean-Paul Smets committed
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
  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

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
  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

976
  security.declarePublic('getCatalogSearchResultKeys')
977 978 979 980
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
981

982 983
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
984

985 986 987 988 989 990 991 992 993
    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)
994 995
      except ConflictError:
        raise
996
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
997
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
998 999 1000
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
1001

1002
    return catalog_schema_dict[table]
1003

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1004 1005
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1006 1007 1008
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1009
    def _getColumnIds():
1010 1011 1012 1013 1014 1015
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
          keys[field] = 1
          keys['%s.%s' % (table, field)] = 1  # Is this inconsistent ?
1016
      for related in self.getSQLCatalogRelatedKeyList():
1017 1018 1019
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
        keys[related_key] = 1
1020 1021 1022 1023
      for scriptable in self.getSQLCatalogScriptableKeyList():
        scriptable_tuple = scriptable.split('|')
        scriptable = scriptable_tuple[0].strip()
        keys[scriptable] = 1
1024 1025 1026
      keys = keys.keys()
      keys.sort()
      return keys
Aurel's avatar
Aurel committed
1027
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_factory='erp5_core_long')()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1028

1029 1030 1031 1032 1033
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1034
    def _getColumnMap():
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
      keys = {}
      for table in self.getCatalogSearchTableIds():
        field_list = self._getCatalogSchema(table=table)
        for field in field_list:
          key = field
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table)
          key = '%s.%s' % (table, key)
          if not keys.has_key(key): keys[key] = []
          keys[key].append(table) # Is this inconsistent ?
      return keys
Aurel's avatar
Aurel committed
1046
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_factory='erp5_core_long')()
1047

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1048 1049 1050 1051 1052 1053 1054
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
1055 1056 1057
      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
1058 1059 1060 1061 1062 1063 1064
    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
1065 1066 1067
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1068 1069
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1070 1071 1072
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073
        keys.append(c[0])
1074 1075
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1076 1077
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1078 1079 1080
    return keys

  # the cataloging API
1081 1082 1083
  def produceUid(self):
    """
      Produces reserved uids in advance
1084
    """
1085 1086 1087 1088 1089
    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
1090
      self._v_uid_buffer = UidBuffer()
1091
      klass._local_clear_reserved_time = self._last_clear_reserved_time
1092
    elif getattr(self, '_v_uid_buffer', None) is None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1093
      self._v_uid_buffer = UidBuffer()
1094
    if len(self._v_uid_buffer) == 0:
1095 1096
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1097 1098 1099 1100 1101 1102 1103 1104
      # 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()
1105 1106
      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)
1107

1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
  def isIndexable(self):
    """
    This is required to check in many methods that
    the site root and zope root are indexable
    """
    zope_root = self.getZopeRoot()
    site_root = self.getSiteRoot()

    root_indexable = int(getattr(zope_root, 'isIndexable', 1))
    site_indexable = int(getattr(site_root, 'isIndexable', 1))
    if not (root_indexable and site_indexable):
      return False
    return True
Aurel's avatar
Aurel committed
1121

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
  def getSiteRoot(self):
    """
    Returns the root of the site
    """
    if withCMF:
      site_root = getToolByName(self, 'portal_url').getPortalObject()
    else:
      site_root = self.aq_parent
    return site_root

  def getZopeRoot(self):
    """
    Returns the root of the zope
    """
    if withCMF:
      zope_root = getToolByName(self, 'portal_url').getPortalObject().aq_parent
    else:
      zope_root = self.getPhysicalRoot()
    return zope_root

1142 1143 1144
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1145 1146
      with multiple ZEO clients on a single ZEO server.

1147
      The main risk is the following:
1148

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

1151
      - one reindexing node N1 starts reindexing f
1152

1153
      - another reindexing node N2 starts reindexing e
1154

1155 1156 1157
      - 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

1158
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1159
      with the risk of graph loops
1160
    """
1161
    if not self.isIndexable():
1162 1163
      return None

1164 1165 1166 1167
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1168 1169
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
1170 1171 1172 1173 1174 1175
        # 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
1176 1177 1178 1179 1180 1181 1182 1183 1184
        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()
1185

1186 1187 1188 1189 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 1224 1225 1226 1227 1228
  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`)))

1229
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1230
                          URL1=None, sql_catalog_id=None):
1231 1232 1233 1234
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1235
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1236
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1237 1238

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1239
    """ clears reserved uids """
1240 1241 1242
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1243
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1244
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281

  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
1282
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1283 1284 1285 1286 1287 1288 1289 1290 1291
    """
    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

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

1294
  def catalogObjectList(self, object_list, method_id_list=None, disable_cache=0,
1295
                              check_uid=1, idxs=None):
1296 1297 1298 1299
    """
      Add objects to the Catalog by calling
      all SQL methods and providing needed arguments.

1300 1301 1302 1303 1304 1305 1306
      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

1307 1308 1309 1310 1311 1312 1313 1314
      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?
    """
1315
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1316
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1317

1318 1319 1320
    if idxs not in (None, []):
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', 0, 'Warning: idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')

1321 1322
    if not self.isIndexable():
      return None
1323

1324
    site_root = self.getSiteRoot()
1325

1326
    for object in object_list:
1327
      path = object.getPath()
1328
      if not getattr(aq_base(object), 'uid', None):
1329
        try:
1330
          object.uid = self.newUid()
1331 1332
        except ConflictError:
          raise
1333
        except:
1334
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1335
      elif check_uid:
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
        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:
1347
            LOG('SQLCatalog', WARNING, 'uid of %r changed from %r (property) to %r (catalog, by path) !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, index))
1348 1349 1350 1351 1352 1353
            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
1354
          catalog_path = self.getPathForUid(uid)
1355 1356 1357 1358 1359 1360
          #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()
1361
              if getattr(self, '_v_uid_buffer', None) is not None:
1362 1363 1364 1365 1366 1367 1368 1369
                # 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.
1370 1371 1372 1373
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1374 1375 1376 1377
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1378 1379 1380 1381
            # can be due to path length
            if len(path) > 255:
              LOG('SQLCatalog', WARNING, 'path of object %r is too long for catalog. You should use a shorter path.' %(object,))

1382
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1383
            LOG('SQLCatalog', WARNING,
1384
                'uid of %r changed from %r to %r as old one is assigned to %s in catalog !!! This can be fatal. You should reindex the whole site immediately.' % (object, uid, object.uid, catalog_path))
1385

1386 1387
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1388
    econtext_cache = {}
1389
    argument_cache = {}
1390
    expression_cache = {}
1391

1392
    try:
1393
      if not disable_cache:
1394
        enableReadOnlyTransactionCache(self)
1395

1396
      method_kw_dict = {}
1397
      for method_name in method_id_list:
1398 1399 1400 1401 1402 1403 1404 1405 1406
        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
1407
            portal_type = object.getPortalType()
1408 1409 1410 1411
            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'])
1412
              try:
1413
                result = expression_cache[expression_key]
1414
              except KeyError:
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
                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
1425

1426 1427
        if len(catalogged_object_list) == 0:
          continue
1428

1429
        method_kw_dict[method_name] = kw
1430

1431 1432 1433 1434 1435 1436 1437 1438 1439
        #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:
1440
              try:
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
                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
1451 1452
                if not disable_cache:
                  argument_cache[(object.uid, arg)] = value
1453 1454
              append(value)
            kw[arg] = value_list
1455

1456
      for method_name in method_id_list:
1457 1458 1459 1460
        if method_name not in method_kw_dict:
          continue
        kw = method_kw_dict[method_name]
        method = getattr(self, method_name)
1461
        method = aq_base(method).__of__(site_root.portal_catalog) # Use method in
1462 1463 1464 1465
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1466
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
          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
1477
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1478 1479 1480
              error=sys.exc_info())
          raise
    finally:
1481
      if not disable_cache:
1482
        disableReadOnlyTransactionCache(self)
1483

1484
  if psyco is not None: psyco.bind(catalogObjectList)
1485

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
  def beforeUncatalogObject(self, path=None,uid=None):
    """
    Set the path as deleted
    """
    if not self.isIndexable():
      return None

    if uid is None and path is not None:
      uid = self.getUidForPath(path)
    method_name = self.sql_catalog_delete_uid
    if uid is None:
      return None
1498 1499 1500 1501
    if method_name in (None,''):
      # This should exist only if the site is not up to date.
      LOG('ZSQLCatalog.beforeUncatalogObject',0,'The sql_catalog_delete_uid'\
                                                + ' method is not defined')
Sebastien Robin's avatar
Sebastien Robin committed
1502
      return self.uncatalogObject(path=path,uid=uid)
1503 1504 1505
    method = getattr(self, method_name)
    method(uid = uid)

1506
  def uncatalogObject(self, path=None,uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
    """
    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

    """
1519
    if not self.isIndexable():
1520 1521
      return None

1522 1523
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1524 1525
    methods = self.sql_uncatalog_object
    if uid is None:
1526
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1527
    for method_name in methods:
1528 1529
      # Do not put try/except here, it is required to raise error
      # if uncatalog does not work.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1530
      method = getattr(self, method_name)
1531
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1532

1533 1534 1535 1536 1537
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
    return self.catalogObjectList(object_list, method_id_list = (method_name,))
1538

1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
  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())
1550

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
  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 """
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
    #try:
    if path is None:
      return None
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    search_result = method(path = path, uid_only=1)
    # If not empty, return first record
    if len(search_result) > 0:
      return long(search_result[0].uid)
    else:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
      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
1584 1585 1586 1587
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1588 1589 1590 1591 1592 1593 1594 1595
      # 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
1596 1597
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1598 1599 1600
    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
1601
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
      return None

  def getMetadataForUid(self, uid):
    """ Accesses a single record for a given uid """
    if uid is None:
      return None
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_uid)
    brain = method(uid = uid)[0]
    result = {}
    for k in brain.__record_schema__.keys():
      result[k] = getattr(brain,k)
    return result

  def getIndexDataForUid(self, uid):
    """ Accesses a single record for a given uid """
    return self.getMetadataForUid(uid)

  def getMetadataForPath(self, path):
    """ Accesses a single record for a given path """
    try:
      # Get the appropriate SQL Method
      method = getattr(self, self.sql_getitem_by_path)
      brain = method(path = path)[0]
      result = {}
      for k in brain.__record_schema__.keys():
        result[k] = getattr(brain,k)
      return result
1630 1631
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1632 1633 1634
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1635 1636
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1637 1638 1639 1640 1641 1642
      return None

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

1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
  def getCatalogMethodIds(self):
    """Find Z SQL methods in the current folder and above
    This function return a list of ids.
    """
    ids={}
    have_id=ids.has_key

    while self is not None:
      if hasattr(self, 'objectValues'):
        for o in self.objectValues(valid_method_meta_type_list):
          if hasattr(o,'id'):
            id=o.id
1655 1656
            if not isinstance(id, str):
              id=id()
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
            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

1668
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1669 1670
    """
    Return the list of related keys.
1671
    This method can be overidden in order to implement
1672 1673
    dynamic generation of some related keys.
    """
1674 1675
    if key_list is None:
      key_list = []
1676
    # Do not generate dynamic related key for acceptable_keys
1677
    dynamic_key_list = [k for k in key_list \
1678 1679 1680
        if k not in self.getColumnMap().keys()]
    dynamic_kw = {}

1681
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1682 1683 1684
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1685 1686 1687
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1688 1689 1690 1691 1692
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1693

1694 1695
  def getTableIndex(self, table):
    """
1696
    Return a map between index and column for a given table
1697 1698 1699 1700 1701 1702 1703 1704
    """
    def _getTableIndex(table):
      table_index = {}
      method = getattr(self, self.sql_catalog_index, '')
      if method in ('', None):
        return {}
      index = list(method(table=table))
      for line in index:
1705 1706
        if table_index.has_key(line.KEY_NAME):
          table_index[line.KEY_NAME].append(line.COLUMN_NAME)
1707
        else:
1708 1709
          table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
      LOG("SQLCatalog.getTableIndex", INFO, "index = %s for table = %s" \
1710 1711 1712
          %(table_index, table))
      return table_index
    return CachingMethod(_getTableIndex, id='SQLCatalog.getTableIndex', \
Aurel's avatar
Aurel committed
1713
                         cache_factory='erp5_core_long')(table=table)
1714 1715


1716
  def getIndex(self, table, column_list, all_column_list):
1717 1718 1719
    """
    Return possible index for a column list in a given table
    """
1720
    def _getIndex(table, column_list, all_column_list):
1721 1722 1723
      index_dict = self.getTableIndex(table)
      if isinstance(column_list, str):
        column_list = [column_list,]
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
      # Get possible that can be used
      possible_index = []
      for index in index_dict.keys():
        index_columns = index_dict[index]
        for column in index_columns:
          if column in column_list:
            if index not in possible_index:
              possible_index.append(index)
      if len(possible_index) == 0:
        return []
      # Get the most suitable index
      for index in possible_index:
        # Make sure all column in index are used by the query
        index_column = index_dict[index]
        for column in index_column:
          if column in column_list or column in all_column_list:
            continue
          else:
            possible_index.remove(index)
      LOG("SQLCatalog.getIndex", INFO, "index = %s for table %s and columns %s" \
          %(possible_index, table, column_list))
      return possible_index
Aurel's avatar
Aurel committed
1746
    return CachingMethod(_getIndex, id='SQLCatalog.getIndex', cache_factory='erp5_core_long')\
1747 1748
          (table=table, column_list=column_list, all_column_list=all_column_list)

1749

1750
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
1751
                          ignore_empty_string=1, query=None, stat__=0, **kw):
1752
    """ Builds a complex SQL query to simulate ZCatalog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1753 1754 1755 1756 1757 1758 1759
    # 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

1760
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
1761 1762
    # If kw and query are not set, then use REQUEST instead
    if query is None and (kw is None or kw == {}):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1763 1764
      kw = REQUEST

1765
    acceptable_key_map = self.getColumnMap()
1766
    acceptable_keys = acceptable_key_map.keys()
1767 1768
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1769
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1770
    multivalue_keys = self.sql_catalog_multivalue_keys
Aurel's avatar
Aurel committed
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
    # Compute "sort_index", which is a sort index, or none:
    if kw.has_key('sort-on'):
      sort_index=kw['sort-on']
    elif hasattr(self, 'sort-on'):
      sort_index=getattr(self, 'sort-on')
    elif kw.has_key('sort_on'):
      sort_index=kw['sort_on']
    else: sort_index=None

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

    # We must now turn sort_index into
    # a dict with keys as sort keys and values as sort order
    if isinstance(sort_index, basestring):
      sort_index = [(sort_index, so)]
    elif not isinstance(sort_index, (list, tuple)):
      sort_index = None
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816

    # 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]
        if not new_kw.has_key(new_k):
          new_kw[new_k] = {}
        if not isinstance(new_kw[new_k], dict):
          new_kw[new_k] = {'query': new_kw[new_k]}
        split_v = v.split(':')
        new_kw[new_k] = {split_v[0]: split_v[1]}
      else:
        if not new_kw.has_key(k):
          new_kw[k] = v
        else:
          new_kw[k]['query'] = v
    kw = new_kw

1817 1818 1819 1820 1821 1822 1823 1824
    # Initialise Scriptable Dict
    scriptable_key_dict = {}
    for t in self.sql_catalog_scriptable_keys:
      t = t.split('|')
      key = t[0].strip()
      method_id = t[1].strip()
      scriptable_key_dict[key] = method_id

1825 1826 1827 1828
    # Build the list of Queries and ComplexQueries
    query_dict = {}
    key_list = [] # the list of column keys
    key_alias_dict = {}
1829
    query_group_by_list = None # Useful to keep a default group_by passed by scriptable keys
1830
    for key in kw.keys():
1831
      if key not in RESERVED_KEY_LIST:
1832 1833 1834
        value = kw[key]
        current_query = None
        new_query_dict = {}
1835 1836 1837 1838 1839
        if isinstance(value, (Query, ComplexQuery)):
          current_query = value
        elif scriptable_key_dict.has_key(key):
          # Turn this key into a query by invoking a script
          method = getattr(self, scriptable_key_dict[key])
1840 1841
          current_query = method(value) # May return None
          if hasattr(current_query, 'order_by'): query_group_by_list = current_query.order_by
1842
        else:
1843
          if isinstance(value, dict):
1844
            for value_key in value.keys():
1845 1846
              if value_key == 'query':
                new_query_dict[key] = value['query']
1847
              else:
1848
                new_query_dict[value_key] = value[value_key]
1849
          else:
1850
            new_query_dict[key] = value
1851
          current_query = Query(**new_query_dict)
1852 1853 1854
        if current_query is not None:
          query_dict[key] = current_query
          key_list.extend(current_query.getSQLKeyList())
1855 1856 1857 1858 1859

    if query is not None:
      query_dict['query'] = query
      key_list.extend(query.getSQLKeyList())

1860 1861 1862 1863 1864
    # if we have a sort index, we must take it into account to get related
    # keys.
    if sort_index:
      related_key_kw = dict(kw)
      for sort_info in sort_index:
1865 1866 1867
        sort_key = sort_info[0]
        if sort_key not in key_list:
          key_list.append(sort_key)
1868

1869
    related_tuples = self.getSQLCatalogRelatedKeyList(key_list=key_list)
Aurel's avatar
Aurel committed
1870

1871
    # Define related maps
1872 1873
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
1874 1875 1876 1877
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1878
    related_table_list = {}
1879
    table_rename_index = 0
1880
    related_methods = {} # related methods which need to be used
1881 1882 1883 1884
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1885
      #LOG('related_tuples', 0, str(join_tuple))
1886
      related_keys.append(key)
1887
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1888
      method_id = join_tuple[2]
1889
      table_list = tuple(join_tuple[0].split(','))
1890
      related_method[key] = method_id
1891
      related_table_list[key] = table_list
1892 1893
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1894
      if not related_table_map.has_key((table_list,method_id)):
1895
        map_list = []
1896
        for table_id in table_list:
1897
          map_list.append((table_id,
1898 1899
             "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
1900
        related_table_map[(table_list,method_id)] = map_list
1901

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1902 1903
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1904
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1905 1906 1907
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1908
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1909
            kw[key] = REQUEST[key]
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922

    def getNewKeyAndUpdateVariables(key):
      key_is_acceptable = key in acceptable_keys # Only calculate once
      key_is_related = key in related_keys
      new_key = None
      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]
          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
Aurel's avatar
Aurel committed
1923
          new_key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1],
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
                               related_column[key])
        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 :
              new_key = '%s.%s' % (acceptable_key_map[key][0], key)
            # query_table specifies what table name should be used by default
            elif query_table and \
                '%s.%s' % (query_table, key) in acceptable_keys:
              new_key = '%s.%s' % (query_table, key)
            elif key == 'uid':
              # uid is always ambiguous so we can only change it here
              new_key = 'catalog.uid'
          else:
            new_key = key
          if new_key is not None:
            # Add table to table dict, we use catalog by default
Aurel's avatar
Aurel committed
1941
            from_table_dict[acceptable_key_map[new_key][0]] = acceptable_key_map[new_key][0]
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
      key_alias_dict[key] = new_key
      return new_key

    where_expression_list = []
    select_expression_list = []
    group_by_expression_list = []
    where_expression = ''
    select_expression = ''
    group_by_expression = ''

    from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
    if len(kw):
1954
      if kw.has_key('select_expression'):
Jérome Perrin's avatar
Jérome Perrin committed
1955
        select_expression_list.append(kw['select_expression'])
1956
      if kw.has_key('group_by_expression'):
1957
        group_by_expression_list.append(kw['group_by_expression'])
1958
      # Grouping
1959
      group_by_list = kw.get('group_by', query_group_by_list)
1960 1961 1962 1963
      if type(group_by_list) is type('a'): group_by_list = [group_by_list]
      if group_by_list is not None:
        try:
          for key in group_by_list:
1964 1965
            new_key = getNewKeyAndUpdateVariables(key)
            group_by_expression_list.append(new_key)
1966 1967 1968 1969
        except ConflictError:
          raise
        except:
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new group by expression', error=sys.exc_info())
1970 1971 1972 1973
          group_by_expression = ''
      if len(group_by_expression_list)>0:
        group_by_expression = ','.join(group_by_expression_list)
        group_by_expression = str(group_by_expression)
1974

1975
    sort_on = None
1976
    sort_key_list = []
1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
    if sort_index is not None:
      new_sort_index = []
      for sort in sort_index:
        if len(sort) == 2:
          # Try to analyse expressions of the form "title AS unsigned"
          sort_key_list = sort[0].split()
          if len(sort_key_list) == 3:
            sort_key = sort_key_list[0]
            sort_type = sort_key_list[2]
          elif len(sort_key_list):
            sort_key = sort_key_list[0]
            sort_type = None
1989
          else:
1990 1991 1992 1993 1994 1995 1996 1997
            sort_key = sort[0]
            sort_type = None
          new_sort_index.append((sort_key, sort[1], sort_type))
        elif len(sort) == 3:
          new_sort_index.append(sort)
      sort_index = new_sort_index
      try:
        new_sort_index = []
Jérome Perrin's avatar
Jérome Perrin committed
1998
        for (original_key, so, as_type) in sort_index:
1999
          key = getNewKeyAndUpdateVariables(original_key)
2000
          if key is not None:
2001
            sort_key_list.append(key)
2002 2003 2004 2005 2006 2007
            if as_type == 'int':
              key = 'CAST(%s AS SIGNED)' % key
            elif as_type:
              key = 'CAST(%s AS %s)' % (key, as_type) # Different casts are possible
            if so in ('descending', 'reverse', 'DESC'):
              new_sort_index.append('%s DESC' % key)
2008
            else:
2009 2010
              new_sort_index.append('%s' % key)
          else:
2011 2012
            LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build sort '
                'index (%s -> %s)' % (original_key, key))
2013 2014 2015 2016 2017 2018 2019
        sort_index = join(new_sort_index,',')
        sort_on = str(sort_index)
      except ConflictError:
        raise
      except:
        LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new sort index', error=sys.exc_info())
        sort_on = ''
2020
        sort_key_list = []
2021 2022 2023 2024 2025

    for key in key_list:
      if not key_alias_dict.has_key(key):
        getNewKeyAndUpdateVariables(key)
    if len(query_dict):
2026
      for key, query in query_dict.items():
2027 2028 2029 2030 2031 2032 2033 2034
        query_result = query.asSQLExpression(key_alias_dict=key_alias_dict,
                                    full_text_search_keys=full_text_search_keys,
                                    keyword_search_keys=keyword_search_keys,
                                    ignore_empty_string=ignore_empty_string,
                                    stat__=stat__)
        if query_result['where_expression'] not in ('',None):
          where_expression_list.append(query_result['where_expression'])
        select_expression_list.extend(query_result['select_expression_list'])
Aurel's avatar
Aurel committed
2035

2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
    # Calculate extra where_expression based on required joins
    for k, tid in from_table_dict.items():
      if k != query_table:
        where_expression_list.append('%s.uid = %s.uid' % (query_table, tid))
    # Calculate extra where_expressions based on related definition
    for (table_list, method_id) in related_methods.keys():
      related_method = getattr(self, method_id, None)
      if related_method is not None:
        table_id = {'src__' : 1} # Return query source, do not evaluate
        table_id['query_table'] = query_table
        table_index = 0
        for t_tuple in related_table_map[(table_list,method_id)]:
          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_list.append(related_method(**table_id))
    # Concatenate expressions
2053 2054
    if kw.get('where_expression',None) not in (None,''):
      where_expression_list.append(kw['where_expression'])
2055 2056
    if len(where_expression_list)>1:
      where_expression_list = ['(%s)' % x for x in where_expression_list]
2057 2058 2059 2060 2061 2062 2063 2064
    where_expression = join(where_expression_list, ' AND ')
    select_expression= join(select_expression_list,',')

    limit_expression = kw.get('limit', None)
    if isinstance(limit_expression, (list, tuple)):
      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
2065

2066
    # force index if exists when doing sort as mysql doesn't manage them efficiently
2067
    if len(sort_key_list) > 0:
2068 2069
      index_from_table = {}
      # first group columns from a same table
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
      for key in sort_key_list:
        try:
          related_table, column = key.split('.')
        except ValueError:
          # key is not of the form table.column
          # so get table from dict
          if len(from_table_dict) != 1:
            continue
          column = key
          related_table = from_table_dict.keys()[0]

2081 2082 2083 2084 2085 2086 2087
        table = from_table_dict[related_table]
        if not index_from_table.has_key(table):
          index_from_table[table] = [column,]
        else:
          index_from_table[table].append(column)
      # second ask index
      for table in index_from_table.keys():
2088
        available_index_list = self.getIndex(table, index_from_table[table], key_list)
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
        if len(available_index_list) > 0:
          # tell mysql to use these index
          table = from_table_dict.pop(related_table)
          index_list_string = ""
          for index in available_index_list:
            if len(index_list_string) == 0:
              index_list_string += "%s" %index
            else:
              index_list_string += ", %s" %index
          table_with_index =  "%s use index(%s)"  %(related_table, index_list_string)
          from_table_dict[table_with_index] = table

2101
    # Use a dictionary at the moment.
2102
    return { 'from_table_list' : from_table_dict.items(),
2103
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2104
             'where_expression' : where_expression,
2105
             'limit_expression' : limit_expression,
2106 2107
             'select_expression': select_expression,
             'group_by_expression' : group_by_expression}
2108

2109 2110 2111
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2112
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, build_sql_query_method=None, **kw):
2113
    """ Returns a list of brains from a set of constraints on variables """
2114 2115 2116
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2117 2118 2119
    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
2120
    kw['limit_expression'] = query['limit_expression']
2121
    kw['select_expression'] = query['select_expression']
2122
    kw['group_by_expression'] = query['group_by_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2123
    # Return the result
2124

2125 2126 2127
    #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))
2128
    #LOG('queryResults',0,'from_table_list: %s' % str(query['from_table_list']))
2129
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2130

2131
  def searchResults(self, REQUEST=None, used=None, **kw):
2132
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2133
    """ Returns a list of brains from a set of constraints on variables """
2134
    # The used argument is deprecated and is ignored
2135
    method = getattr(self, self.sql_search_results)
2136
    return self.queryResults(method, REQUEST=REQUEST, used=used, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2137 2138 2139

  __call__ = searchResults

2140
  def countResults(self, REQUEST=None, used=None, stat__=1, **kw):
2141 2142
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
    """ Returns the number of items which satisfy the where_expression """
2143 2144
    # Get the search method
    method = getattr(self, self.sql_count_results)
2145
    return self.queryResults(method, REQUEST=REQUEST, used=used, stat__=stat__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2146

2147
  def recordObjectList(self, path_list, catalog=1):
2148
    """
2149
      Record the path of an object being catalogged or uncatalogged.
2150
    """
2151 2152
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2153

2154
  def deleteRecordedObjectList(self, uid_list=()):
2155 2156 2157 2158
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2159
    method(uid_list=uid_list)
2160

2161
  def readRecordedObjectList(self, catalog=1):
2162 2163 2164 2165
    """
      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)
2166
    return method(catalog=catalog)
2167 2168 2169 2170 2171 2172 2173 2174 2175

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

2178 2179 2180 2181
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2182

2183
      for id in method_id_list:
2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209
        # 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]
2210
          if isinstance(list_type, str):
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
            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:
2281 2282 2283 2284
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
      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,
2299 2300 2301 2302 2303 2304 2305
            #'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
2306 2307 2308 2309 2310 2311
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2312
class CatalogError(Exception): pass
2313 2314 2315



Aurel's avatar
Aurel committed
2316
# vim: filetype=python syntax=python shiftwidth=2