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

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

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

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

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

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

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

79
UID_BUFFER_SIZE = 300
80

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

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

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
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)

105

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

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

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

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

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

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

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

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

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

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

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

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
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
  """
  def __init__(self,format=None,operator=None,range=None,
                    search_mode=None,**kw):
    self.format = format
    if operator is None:
      operator = 'OR'
    self.operator = operator
    self.range = range
    self.search_mode = search_mode
    key_list = kw.keys()
    if len(key_list)!=1:
      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

  def asSQLExpression(self,key_alias_dict=None,keyword_search_keys=None,
                           full_text_search_keys=None,
                           ignore_empty_string=1,stat__=0):
    """
    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))
    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)
    else: where_expression = ''
    return {'where_expression':where_expression,
            'select_expression_list':select_expression}
  
  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
  """
  def __init__(self,*args,**kw):
    self.query_list = args
    operator = None
    if kw.has_key('operator'):
      operator = kw['operator']
      del kw['operator']
    if operator is None:
      operator = 'AND'
    self.operator=operator
    self.__dict__.update(kw)

  def __call__(self):
    self.asSQLExpression()

  def getQueryList(self):
    return self.query_list

  def asSQLExpression(self,key_alias_dict=None,
                           ignore_empty_string=1,
                           keyword_search_keys=None,
                           full_text_search_keys=None,
                           stat__=0):
    """
    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)

390
class Catalog(Folder, Persistent, Acquisition.Implicit, ExtensionClass.Base):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
391 392 393 394
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
395
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
396 397 398 399 400 401 402 403

  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

404 405
  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.
406 407 408
  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).
409 410 411
  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
412

Jean-Paul Smets's avatar
Jean-Paul Smets committed
413 414 415 416 417 418 419 420

  bgrain defined in meyhods...

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
421 422 423 424 425 426 427 428 429 430 431 432 433 434 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 466 467 468 469 470 471 472 473 474 475 476 477
  meta_type = "SQLCatalog"
  icon='misc_/ZCatalog/ZCatalog.gif' # FIXME: use a different icon
  security = ClassSecurityInfo()

  manage_options = (
    {'label': 'Contents',       # TAB: Contents
     'action': 'manage_main',
     'help': ('OFSP','ObjectManager_Contents.stx')},
    {'label': 'Catalog',      # TAB: Catalogged Objects
     'action': 'manage_catalogView',
     'target': 'manage_main',
     'help':('ZCatalog','ZCatalog_Cataloged-Objects.stx')},
    {'label': 'Properties',     # TAB: Properties
     'action': 'manage_propertiesForm',
     'help': ('OFSP','Properties.stx')},
    {'label': 'Filter',     # TAB: Filter
     'action': 'manage_catalogFilter',},
    {'label': 'Find Objects',     # TAB: Find Objects
     'action': 'manage_catalogFind',
     'target':'manage_main',
     'help':('ZCatalog','ZCatalog_Find-Items-to-ZCatalog.stx')},
    {'label': 'Advanced',       # TAB: Advanced
     'action': 'manage_catalogAdvanced',
     'target':'manage_main',
     'help':('ZCatalog','ZCatalog_Advanced.stx')},
    {'label': 'Undo',         # TAB: Undo
     'action': 'manage_UndoForm',
     'help': ('OFSP','Undo.stx')},
    {'label': 'Security',       # TAB: Security
     'action': 'manage_access',
     'help': ('OFSP','Security.stx')},
    {'label': 'Ownership',      # TAB: Ownership
     'action': 'manage_owner',
     'help': ('OFSP','Ownership.stx'),}
    )

  __ac_permissions__=(

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

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

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

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
      'getpath', 'schema', 'names', 'columns', 'indexes', 'index_objects',
      'all_meta_types', 'valid_roles', 'resolve_url',
      'getobject', 'getObject', 'getObjectList', 'getCatalogSearchTableIds',
478
      'getFilterableMethodList', ],
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
     ['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' },
504 505 506 507 508
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
509 510 511 512 513
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
514 515
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
516 517 518 519 520 521 522 523
      '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' },
524 525 526
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
527 528
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
529 530 531
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
532 533
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
534 535
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
536 537 538
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
539
    { 'id'      : 'sql_record_object_list',
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
      'description' : 'Method to record catalog information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_read_recorded_object_list',
      'description' : 'Method to get recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_delete_recorded_object_list',
      'description' : 'Method to delete recorded information',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_tables',
      'description' : 'Tables to join in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getTableIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_search_result_keys',
      'description' : 'Keys to display in the result',
      'type'    : 'multiple selection',
      'select_variable' : 'getResultColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_count_results',
      'description' : 'Main method to search the catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_path',
      'description' : 'Get a catalog brain by path',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_getitem_by_uid',
      'description' : 'Get a catalog brain by uid',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_tables',
      'description' : 'Method to get the main catalog tables',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_schema',
      'description' : 'Method to get the main catalog schema',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_unique_values',
      'description' : 'Find unique disctinct values in a column',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_paths',
      'description' : 'List all object paths in catalog',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_keyword_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_full_text_search_keys',
      'description' : 'Columns which should be considered as full text search',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_request_keys',
      'description' : 'Columns which should be ignore in the REQUEST in order to accelerate caching',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_multivalue_keys',
      'description' : 'Keys which hold multiple values',
      'type'    : 'multiple selection',
      'select_variable' : 'getColumnIds',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_topic_search_keys',
      'description' : 'Columns which should be considered as topic index',
      'type'    : 'lines',
      'mode'    : 'w' },
    { 'id'      : 'sql_catalog_related_keys',
      'title'   : 'Related keys',
      'description' : 'Additional columns obtained through joins',
      'type'    : 'lines',
      'mode'    : 'w' },
  )

635
  sql_catalog_produce_reserved = ''
636
  sql_catalog_delete_uid = ''
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  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 = ''
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
657 658 659 660 661 662 663
  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 = ()

664 665 666 667 668 669
  # 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
670

671 672 673 674 675 676 677
  # 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
678

679 680 681 682 683 684 685 686 687 688
  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
689 690 691
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
692
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
693

694 695 696 697 698 699
  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')
700 701 702 703 704 705 706 707 708 709 710 711
    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]
712
      if isinstance(value, basestring):
713
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
714
      elif isinstance(value, (tuple, list)):
715 716 717
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
718
        for item in value:
719
          if isinstance(item, basestring):
720 721 722 723
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
724
        f.write('  </property>\n')
725 726 727
    # 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'):
728 729
      filter_list = []
      for filter_id in self.filter_dict.keys():
730
        filter_definition = self.filter_dict[filter_id]
731 732 733 734 735 736 737
        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']:
738 739
          # If a filter is not activated, no need to output it.
          continue
740
        if not filter_def['expression']:
741 742
          # If the expression is not specified, meaningless to specify it.
          continue
743
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
744
        # For now, portal types are not exported, because portal types are too specific to each site.
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
    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):
766
            raise CatalogError, 'unknown property id %r' % (id,)
767
          if type not in ('str', 'tuple'):
768
            raise CatalogError, 'unknown property type %r' % (type,)
769 770 771 772
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
773
                value = str(text.data)
774 775 776 777 778 779
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
780
                raise CatalogError, 'unknown item type %r' % (item_type,)
781 782
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
783
                  value.append(str(text.data))
784 785 786 787
                  break
            value = tuple(value)

          setattr(self, id, value)
788

789 790 791
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
792
          id = str(filt.getAttribute("id"))
793 794 795 796 797 798 799 800 801 802 803 804
          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
805 806 807 808 809 810 811 812 813 814
      finally:
        doc.unlink()
    finally:
      f.close()

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

  security.declarePrivate('getSecurityUid')
815
  def getSecurityUid(self, wrapped_object):
816 817 818 819 820 821 822
    """
      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
823
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
824 825 826 827
    # 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)
828 829
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
830 831 832 833 834 835 836
      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
837 838 839 840 841 842
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
843
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
844 845
      try:
        method()
846 847
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
848
      except:
849
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
850
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
851

852
    # Reserved uids have been removed.
853
    self.clearReserved()
854

855 856 857 858 859
    # 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)
860
      method(uid = [self._max_uid()])
861

862
    # Remove the cache of catalog schema.
863 864
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
865

866
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
867

868 869 870 871 872 873
  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
874 875 876 877 878
    try:
      method()
    except ConflictError:
      raise
    except:
879
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
880 881 882
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
883
    self._last_clear_reserved_time += 1
884

Jean-Paul Smets's avatar
Jean-Paul Smets committed
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  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

916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
  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

933
  security.declarePublic('getCatalogSearchResultKeys')
934 935 936 937
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
938

939 940
  def _getCatalogSchema(self, table=None):
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
941

942 943 944 945 946 947 948 949 950
    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)
951 952
      except ConflictError:
        raise
953
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
954
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
955 956 957
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
958

959
    return catalog_schema_dict[table]
960

Jean-Paul Smets's avatar
Jean-Paul Smets committed
961 962
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
963 964 965
    Calls the show column method and returns dictionnary of
    Field Ids
    """
966
    def _getColumnIds():
967 968 969 970 971 972
      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 ?
973
      for related in self.getSQLCatalogRelatedKeyList():
974 975 976 977 978 979
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
        keys[related_key] = 1
      keys = keys.keys()
      keys.sort()
      return keys
980
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_duration=None)()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
981

982 983 984 985 986
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
987
    def _getColumnMap():
988 989 990 991 992 993 994 995 996 997 998
      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
999
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_duration=None)()
1000

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1001 1002 1003 1004 1005 1006 1007
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
1008 1009 1010
      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
1011 1012 1013 1014 1015 1016 1017
    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
1018 1019 1020
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1021 1022
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1023 1024 1025
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1026
        keys.append(c[0])
1027 1028
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1029 1030
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1031 1032 1033
    return keys

  # the cataloging API
1034 1035 1036
  def produceUid(self):
    """
      Produces reserved uids in advance
1037
    """
1038 1039 1040 1041 1042
    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
1043
      self._v_uid_buffer = UidBuffer()
1044
      klass._local_clear_reserved_time = self._last_clear_reserved_time
1045
    elif getattr(self, '_v_uid_buffer', None) is None:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1046
      self._v_uid_buffer = UidBuffer()
1047
    if len(self._v_uid_buffer) == 0:
1048 1049
      method_id = self.sql_catalog_produce_reserved
      method = getattr(self, method_id)
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1050 1051 1052 1053 1054 1055 1056 1057
      # 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()
1058 1059
      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)
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
  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
 
  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

1095 1096 1097
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1098 1099
      with multiple ZEO clients on a single ZEO server.

1100
      The main risk is the following:
1101

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

1104
      - one reindexing node N1 starts reindexing f
1105

1106
      - another reindexing node N2 starts reindexing e
1107

1108 1109 1110
      - 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

1111
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1112
      with the risk of graph loops
1113
    """
1114
    if not self.isIndexable():
1115 1116
      return None

1117 1118 1119 1120
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1121 1122
      if len(self._v_uid_buffer) > 0:
        uid = self._v_uid_buffer.pop()
1123 1124 1125 1126 1127 1128
        # 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
1129 1130 1131 1132 1133 1134 1135 1136 1137
        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()
1138

1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
  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`)))

1182
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1183
                          URL1=None, sql_catalog_id=None):
1184 1185 1186 1187
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1188
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1189
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1190 1191

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1192
    """ clears reserved uids """
1193 1194 1195
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1196
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1197
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
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 1229 1230 1231 1232 1233 1234

  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
1235
  def catalogObject(self, object, path, is_object_moved=0):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1236 1237 1238 1239 1240 1241 1242 1243 1244
    """
    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

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

1247
  def catalogObjectList(self, object_list, method_id_list=None, disable_cache=0,
1248
                              check_uid=1):
1249 1250 1251 1252
    """
      Add objects to the Catalog by calling
      all SQL methods and providing needed arguments.

1253 1254 1255 1256 1257 1258 1259
      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

1260 1261 1262 1263 1264 1265 1266 1267
      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?
    """
1268
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1269
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1270

1271 1272
    if not self.isIndexable():
      return None
1273

1274
    site_root = self.getSiteRoot()
1275

1276
    for object in object_list:
1277
      path = object.getPath()
1278
      if not getattr(aq_base(object), 'uid', None):
1279
        try:
1280
          object.uid = self.newUid()
1281 1282
        except ConflictError:
          raise
1283
        except:
1284
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1285
      elif check_uid:
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
        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:
1297
            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))
1298 1299 1300 1301 1302 1303
            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
1304
          catalog_path = self.getPathForUid(uid)
1305 1306 1307 1308 1309 1310
          #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()
1311
              if getattr(self, '_v_uid_buffer', None) is not None:
1312 1313 1314 1315 1316 1317 1318 1319
                # 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.
1320 1321 1322 1323
                try:
                  self._v_uid_buffer.remove(uid)
                except ValueError:
                  pass
1324 1325 1326 1327
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1328 1329 1330 1331
            # 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,))

1332
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1333
            LOG('SQLCatalog', WARNING,
1334
                '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))
1335

1336 1337
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1338
    econtext_cache = {}
1339
    argument_cache = {}
1340
    expression_cache = {}
1341

1342
    try:
1343
      if not disable_cache:
1344
        enableReadOnlyTransactionCache(self)
1345

1346
      method_kw_dict = {}
1347
      for method_name in method_id_list:
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
        kw = {}
        if self.isMethodFiltered(method_name) and self.filter_dict.has_key(method_name):
          catalogged_object_list = []
          type_list = self.filter_dict[method_name]['type']
          expression = self.filter_dict[method_name]['expression_instance']
          for object in object_list:
            # We will check if there is an filter on this
            # method, if so we may not call this zsqlMethod
            # for this object
            portal_type = object.getPortalType()
            if type_list and portal_type not in type_list:
              continue
            elif expression is not None:
              expression_key = (object.uid, self.filter_dict[method_name]['expression'])
1362
              try:
1363
                result = expression_cache[expression_key]
1364
              except KeyError:
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
                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
1375

1376 1377
        if len(catalogged_object_list) == 0:
          continue
1378

1379
        method_kw_dict[method_name] = kw
1380

1381 1382 1383 1384 1385 1386 1387 1388 1389
        #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:
1390
              try:
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
                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
1401 1402
                if not disable_cache:
                  argument_cache[(object.uid, arg)] = value
1403 1404
              append(value)
            kw[arg] = value_list
1405

1406
      for method_name in method_id_list:
1407 1408 1409 1410
        if method_name not in method_kw_dict:
          continue
        kw = method_kw_dict[method_name]
        method = getattr(self, method_name)
1411
        method = aq_base(method).__of__(site_root.portal_catalog) # Use method in
1412 1413 1414 1415
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1416
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
          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
1427
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1428 1429 1430
              error=sys.exc_info())
          raise
    finally:
1431
      if not disable_cache:
1432
        disableReadOnlyTransactionCache(self)
1433

1434
  if psyco is not None: psyco.bind(catalogObjectList)
1435

1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
  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
1448 1449 1450 1451
    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
1452
      return self.uncatalogObject(path=path,uid=uid)
1453 1454 1455
    method = getattr(self, method_name)
    method(uid = uid)

1456
  def uncatalogObject(self, path=None,uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
    """
    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

    """
1469
    if not self.isIndexable():
1470 1471
      return None

1472 1473
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1474 1475
    methods = self.sql_uncatalog_object
    if uid is None:
1476
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1477
    for method_name in methods:
1478 1479
      # 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
1480
      method = getattr(self, method_name)
1481
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1482

1483 1484 1485 1486 1487
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
    return self.catalogObjectList(object_list, method_id_list = (method_name,))
1488

1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
  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())
1500

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
  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 """
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
    #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
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
      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
1534 1535 1536 1537
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1538 1539 1540 1541 1542 1543 1544 1545
      # 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
1546 1547
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1548 1549 1550
    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
1551
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
      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
1580 1581
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1582 1583 1584
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1585 1586
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1587 1588 1589 1590 1591 1592
      return None

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

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
  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
1605 1606
            if not isinstance(id, str):
              id=id()
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
            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

1618
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1619 1620
    """
    Return the list of related keys.
1621
    This method can be overidden in order to implement
1622 1623
    dynamic generation of some related keys.
    """
1624 1625
    if key_list is None:
      key_list = []
1626
    # Do not generate dynamic related key for acceptable_keys
1627
    dynamic_key_list = [k for k in key_list \
1628 1629 1630
        if k not in self.getColumnMap().keys()]
    dynamic_kw = {}

1631
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1632 1633 1634
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1635
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
1636
                          ignore_empty_string=1, query=None,stat__=0,**kw):
1637
    """ Builds a complex SQL query to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1638 1639 1640 1641 1642 1643 1644
    # 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

1645
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1646 1647 1648 1649
    # If kw is not set, then use REQUEST instead
    if kw is None or kw == {}:
      kw = REQUEST

1650
    acceptable_key_map = self.getColumnMap()
1651
    acceptable_keys = acceptable_key_map.keys()
1652 1653
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
1654
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1655
    multivalue_keys = self.sql_catalog_multivalue_keys
1656
    
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
    
    # 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
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729

    # 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

    # Build the list of Queries and ComplexQueries
    query_dict = {}
    key_list = [] # the list of column keys
    key_alias_dict = {}
    for key in kw.keys():
      if key not in ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit'):
        value = kw[key]
        current_query = None
        new_query_dict = {}
        if isinstance(value,(Query,ComplexQuery)):
          current_query=value
        else:
          if isinstance(value,dict):
            for value_key in value.keys():
              if value_key=='query':
                new_query_dict[key]=value['query']
              else:
                new_query_dict[value_key]=value[value_key]
          else:
            new_query_dict[key]=value
          current_query = Query(**new_query_dict)
        query_dict[key]=current_query
        key_list.extend(current_query.getSQLKeyList())

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

1730 1731 1732 1733 1734
    # 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:
1735 1736 1737 1738
        sort_key = sort_info[0]
        if sort_key not in key_list:
          key_list.append(sort_key)
    related_tuples = self.getSQLCatalogRelatedKeyList(key_list=key_list)
1739
    
1740
    # Define related maps
1741 1742
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
1743 1744 1745 1746
    related_keys = []
    related_method = {}
    related_table_map = {}
    related_column = {}
1747
    related_table_list = {}
1748
    table_rename_index = 0
1749
    related_methods = {} # related methods which need to be used
1750 1751 1752 1753
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
      join_tuple = t_tuple[1].strip().split('/')
1754
      #LOG('related_tuples', 0, str(join_tuple))
1755
      related_keys.append(key)
1756
#       LOG('buildSqlQuery, join_tuple',0,join_tuple)
1757
      method_id = join_tuple[2]
1758
      table_list = tuple(join_tuple[0].split(','))
1759
      related_method[key] = method_id
1760
      related_table_list[key] = table_list
1761 1762
      related_column[key] = join_tuple[1]
      # Rename tables to prevent conflicts
1763
      if not related_table_map.has_key((table_list,method_id)):
1764
        map_list = []
1765
        for table_id in table_list:
1766
          map_list.append((table_id,
1767 1768
             "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
1769
        related_table_map[(table_list,method_id)] = map_list
1770

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1771 1772
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
1773
    if REQUEST is not None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1774 1775 1776
      for key in acceptable_keys:
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
1777
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1778
            kw[key] = REQUEST[key]
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822

    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
          new_key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1], 
                               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
            from_table_dict[acceptable_key_map[new_key][0]] = acceptable_key_map[new_key][0] 
      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):
1823
      if kw.has_key('select_expression'):
Jérome Perrin's avatar
Jérome Perrin committed
1824
        select_expression_list.append(kw['select_expression'])
1825
      if kw.has_key('group_by_expression'):
1826
        group_by_expression_list.append(kw['group_by_expression'])
1827 1828 1829 1830 1831 1832
      # Grouping
      group_by_list = kw.get('group_by', None)
      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:
1833 1834
            new_key = getNewKeyAndUpdateVariables(key)
            group_by_expression_list.append(new_key)
1835 1836 1837 1838
        except ConflictError:
          raise
        except:
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new group by expression', error=sys.exc_info())
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
          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)
    sort_on = None
    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
1856
          else:
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874
            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 = []
        for (key , so, as_type) in sort_index:
          key = getNewKeyAndUpdateVariables(key)
          if key is not None:
            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)
1875
            else:
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
              new_sort_index.append('%s' % key)
          else:
            LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new sort index', error=sys.exc_info())
        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 = ''

    for key in key_list:
      if not key_alias_dict.has_key(key):
        getNewKeyAndUpdateVariables(key)
    if len(query_dict):
      for key,query in query_dict.items():
        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'])

    # 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
    if kw.get('where_expression',None) is not None:
      if len(where_expression) > 0:
        where_expression_list.append(kw['where_expression'])
    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
1929

1930
    # Use a dictionary at the moment.
1931
    return { 'from_table_list' : from_table_dict.items(),
1932
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1933
             'where_expression' : where_expression,
1934
             'limit_expression' : limit_expression,
1935 1936
             'select_expression': select_expression,
             'group_by_expression' : group_by_expression}
1937

1938
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, build_sql_query_method=None, **kw):
1939
    """ Returns a list of brains from a set of constraints on variables """
1940 1941 1942
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
1943 1944 1945
    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
1946
    kw['limit_expression'] = query['limit_expression']
1947
    kw['select_expression'] = query['select_expression']
1948
    kw['group_by_expression'] = query['group_by_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1949
    # Return the result
1950

1951 1952 1953 1954
    #LOG('acceptable_keys',0,'acceptable_keys: %s' % str(acceptable_keys))
    #LOG('acceptable_key_map',0,'acceptable_key_map: %s' % str(acceptable_key_map))
    #LOG('queryResults',0,'kw: %s' % str(kw))
    #LOG('queryResults',0,'from_table_list: %s' % str(from_table_dict.keys()))
1955
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1956

1957
  def searchResults(self, REQUEST=None, used=None, **kw):
1958
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1959
    """ Returns a list of brains from a set of constraints on variables """
1960
    # The used argument is deprecated and is ignored
1961 1962 1963 1964 1965
    method = getattr(self, self.sql_search_results)
    # Return the result
    kw['used'] = used
    kw['REQUEST'] = REQUEST
    return self.queryResults(method, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1966 1967 1968 1969

  __call__ = searchResults

  def countResults(self, REQUEST=None, used=None, **kw):
1970 1971
    """ Builds a complex SQL where_expression to simulate ZCalatog behaviour """
    """ Returns the number of items which satisfy the where_expression """
1972 1973 1974 1975 1976
    # Get the search method
    method = getattr(self, self.sql_count_results)
    # Return the result
    kw['used'] = used
    kw['REQUEST'] = REQUEST
1977
    kw['stat__'] = 1
1978
    return self.queryResults(method, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1979

1980
  def recordObjectList(self, path_list, catalog=1):
1981
    """
1982
      Record the path of an object being catalogged or uncatalogged.
1983
    """
1984 1985
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
1986

1987
  def deleteRecordedObjectList(self, uid_list=()):
1988 1989 1990 1991
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
1992
    method(uid_list=uid_list)
1993

1994
  def readRecordedObjectList(self, catalog=1):
1995 1996 1997 1998
    """
      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)
1999
    return method(catalog=catalog)
2000 2001 2002 2003 2004 2005 2006 2007 2008

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

2011 2012 2013 2014
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2015

2016
      for id in method_id_list:
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042
        # 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]
2043
          if isinstance(list_type, str):
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
            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:
2114 2115 2116 2117
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131
      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,
2132 2133 2134 2135 2136 2137 2138
            #'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
2139 2140 2141 2142 2143 2144
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2145
class CatalogError(Exception): pass
2146 2147 2148 2149



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