SQLCatalog.py 94 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
21
from string import split, join
22
from thread import allocate_lock, get_ident
23
from OFS.Folder import Folder
24
from AccessControl import ClassSecurityInfo
25
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
31 32
from Acquisition import aq_parent, aq_inner, aq_base
from zLOG import LOG, WARNING, INFO, TRACE
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
import urllib
import string
41
import pprint
42
from cStringIO import StringIO
43
from xml.dom.minidom import parse
44
from xml.sax.saxutils import escape, quoteattr
45 46
import os
import md5
47 48 49 50 51 52 53 54 55

try:
  from Products.CMFCore.Expression import Expression
  from Products.PageTemplates.Expressions import getEngine
  from Products.CMFCore.utils import getToolByName
  withCMF = 1
except ImportError:
  withCMF = 0

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

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

77
UID_BUFFER_SIZE = 300
78
RESERVED_KEY_LIST = ('where_expression', 'sort-on', 'sort_on', 'sort-order', 'sort_order', 'limit',
79
                     'format', 'search_mode', 'operator', 'selection_domain', 'selection_report')
80

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

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

87 88
manage_addSQLCatalogForm=DTMLFile('dtml/addSQLCatalog',globals())

89 90 91 92 93
# Here go uid buffers
# Structure:
#  global_uid_buffer_dict[catalog_path][thread_id] = UidBuffer
global_uid_buffer_dict = {}

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

110 111 112 113 114 115
def isSimpleType(value):
  return isinstance(value, basestring) or \
         isinstance(value, int) or \
         isinstance(value, long) or \
         isinstance(value, float)

116

117 118
class UidBuffer(TM):
  """Uid Buffer class caches a list of reserved uids in a transaction-safe way."""
119

Yoshinori Okuji's avatar
Yoshinori Okuji committed
120
  def __init__(self):
121
    """Initialize some variables.
122

123
      temporary_buffer is used to hold reserved uids created by non-committed transactions.
124

125
      finished_buffer is used to hold reserved uids created by committed-transactions.
126

127
      This distinction is important, because uids by non-committed transactions might become
Yoshinori Okuji's avatar
Yoshinori Okuji committed
128
      invalid afterwards, so they may not be used by other transactions."""
129 130
    self.temporary_buffer = {}
    self.finished_buffer = []
131

132 133 134 135 136 137 138 139
  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
140

141 142 143 144 145 146 147
  def _abort(self):
    """Erase the uids in the temporary buffer."""
    tid = get_ident()
    try:
      del self.temporary_buffer[tid]
    except KeyError:
      pass
148

149 150 151 152 153 154 155 156
  def __len__(self):
    tid = get_ident()
    l = len(self.finished_buffer)
    try:
      l += len(self.temporary_buffer[tid])
    except KeyError:
      pass
    return l
157

158 159 160 161 162 163 164 165 166 167 168
  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
169

170 171 172 173
  def pop(self):
    self._register()
    tid = get_ident()
    try:
174
      uid = self.temporary_buffer[tid].pop()
175
    except (KeyError, IndexError):
176 177
      uid = self.finished_buffer.pop()
    return uid
178

179 180 181
  def extend(self, iterable):
    self._register()
    tid = get_ident()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
182
    self.temporary_buffer.setdefault(tid, []).extend(iterable)
183

184
class QueryMixin:
185 186 187 188
  
  operator = None
  format = None
  type = None
189 190 191 192

  def getOperator(self):
    return self.operator

193 194 195 196 197 198
  def getFormat(self):
    return self.format

  def getType(self):
    return self.type

Sebastien Robin's avatar
Sebastien Robin committed
199 200 201
  def getLogicalOperator(self):
    return self.logical_operator

202 203 204
  def _quoteSQLString(self, value):
    """Return a quoted string of the value.
    """
Sebastien Robin's avatar
Sebastien Robin committed
205 206 207 208 209 210 211 212
    format = self.getFormat()
    type = self.getType()
    if format is not None and type is not None:
      if type == 'date':
        if hasattr(value, 'strftime'):
          value = value.strftime(format)
        if isinstance(value, basestring):
          value = "STR_TO_DATE('%s','%s')" % (value, format)
213 214 215
      if type == 'float':
        # Make sure there is no space in float values
        value = value.replace(' ','')
216
        value = "'%s'" % value
217
    else:
Sebastien Robin's avatar
Sebastien Robin committed
218 219 220 221 222 223
      if hasattr(value, 'ISO'):
        value = "'%s'" % value.ISO()
      elif hasattr(value, 'strftime'):
        value = "'%s'" % value.strftime('%Y-%m-%d %H:%M:%S')
      else:
        value = "'%s'" % sql_quote(str(value))
224 225
    return value

Sebastien Robin's avatar
Sebastien Robin committed
226 227 228 229 230 231 232 233
  def _quoteSQLKey(self, key):
    """Return a quoted string of the value.
    """
    format = self.getFormat()
    type = self.getType()
    if format is not None and type is not None:
      if type == 'date':
        key = "STR_TO_DATE(DATE_FORMAT(%s,'%s'),'%s')" % (key, format, format)
234 235 236 237 238
      if type == 'float':
        float_format = format.replace(' ','')
        if float_format.find('.') >= 0:
          precision = len(float_format.split('.')[1])
          key = "TRUNCATE(%s,%s)" % (key, precision)
Sebastien Robin's avatar
Sebastien Robin committed
239 240
    return key

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  def asSQLExpression(self, key_alias_dict=None,
                      keyword_search_keys=None,
                      full_text_search_keys=None,
                      ignore_empty_string=1, stat__=0):
    """
      Return a dictionnary containing the keys and value types:
        'where_expression': string
        'select_expression_list': string
    """
    raise NotImplementedError

  def getSQLKeyList(self):
    """
      Return a list of keys used by this query and its subqueries.
    """
    raise NotImplementedError
  
  def getRelatedTableMapDict(self):
    """
      Return for each key used by this query (plus ones used by its
      subqueries) the table alias mapping.
    """
    raise NotImplementedError

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
class NegatedQuery(QueryMixin):
  """
    Do a boolean negation of given query.
  """

  def __init__(self, query):
    self._query = query

  def asSQLExpression(self, *args, **kw):
    sql_expression_dict = self._query.asSQLExpression(*args, **kw)
    sql_expression_dict['where_expression'] = '(NOT (%s))' % \
      (sql_expression_dict['where_expression'], )
    return sql_expression_dict

  def getSQLKeyList(self, *args, **kw):
    return self._query.getSQLKeyList(*args, **kw)

  def getRelatedTableMapDict(self, *args, **kw):
    return self._query.getRelatedTableMapDict(*args, **kw)

285 286 287
class Query(QueryMixin):
  """
  This allow to define constraints on a sql column
288

289 290
  format - type date : %d/%m/%Y
           type float : 1 234.12
291
  """
292
  def __init__(self, format=None, operator=None, range=None,
Sebastien Robin's avatar
Sebastien Robin committed
293
                     search_mode=None, table_alias_list=None, type=None, **kw):
294 295 296 297 298 299
    self.format = format
    if operator is None:
      operator = 'OR'
    self.operator = operator
    self.range = range
    self.search_mode = search_mode
300
    self.table_alias_list = table_alias_list
301
    key_list = kw.keys()
302
    if len(key_list) != 1:
303 304 305
      raise KeyError, 'Query must have only one key'
    self.key = key_list[0]
    self.value = kw[self.key]
Sebastien Robin's avatar
Sebastien Robin committed
306
    self.type = type
307 308 309 310 311 312 313

  def __call__(self):
    self.asSQLExpression()

  def getRange(self):
    return self.range

314 315 316 317 318 319 320 321 322 323
  def getTableAliasList(self):
    return self.table_alias_list

  def getRelatedTableMapDict(self):
    result = {}
    table_alias_list = self.getTableAliasList()
    if table_alias_list is not None:
      result[self.getKey()] = table_alias_list
    return result

324 325 326
  def getSearchMode(self):
    return self.search_mode

327 328 329 330 331 332 333 334 335 336 337
  def asSearchTextExpression(self):
    # This will be the standard way to represent
    # complex values in listbox. Some fixed
    # point must be garanteed
    value = self.value
    if isSimpleType(value) or isinstance(value, DateTime):
      return str(value)
    elif isinstance(value, (list, tuple)):
      value = map(lambda x:str(x), value)
      return (' %s ' % self.operator).join(value)

338 339 340
  def asSQLExpression(self, key_alias_dict=None,
                            keyword_search_keys=None,
                            full_text_search_keys=None,
341
                            ignore_empty_string=1, stat__=0):
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
    """
    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()
Sebastien Robin's avatar
Sebastien Robin committed
361
    format = self.getFormat()
362 363 364 365
    if ignore_key:
      pass
    elif range_value is not None:
      if isinstance(value, (list, tuple)):
Sebastien Robin's avatar
Sebastien Robin committed
366 367 368 369 370 371
        if format is None:
          query_min = min(value)
          query_max = max(value)
        else:
          query_min = value[0]
          query_max = value[1]
372 373
      else:
        query_min=query_max=value
Sebastien Robin's avatar
Sebastien Robin committed
374 375
      query_min = self._quoteSQLString(query_min)
      query_max = self._quoteSQLString(query_max)
376
      if range_value == 'min' :
Sebastien Robin's avatar
Sebastien Robin committed
377
        where_expression.append("%s >= %s" % (key, query_min))
378
      elif range_value == 'max' :
Sebastien Robin's avatar
Sebastien Robin committed
379
        where_expression.append("%s < %s" % (key, query_max))
380
      elif range_value == 'minmax' :
Sebastien Robin's avatar
Sebastien Robin committed
381
        where_expression.append("%s >= %s and %s < %s" % (key, query_min, key, query_max))
382
      elif range_value == 'minngt' :
Sebastien Robin's avatar
Sebastien Robin committed
383
        where_expression.append("%s >= %s and %s <= %s" % (key, query_min, key, query_max))
384
      elif range_value == 'ngt' :
Sebastien Robin's avatar
Sebastien Robin committed
385
        where_expression.append("%s <= %s" % (key, query_max))
386 387
      elif range_value == 'nlt' :
        where_expression.append("%s > %s" % (key, query_max))
388
    elif isSimpleType(value) or isinstance(value, DateTime) \
389
        or (isinstance(value, (list, tuple)) and self.operator.upper() != 'IN'):
390 391 392 393
      # Convert into lists any value which contain a ;
      # Refer to _listGlobalActions DCWorkflow patch
      # for example of use
      if isinstance(value, basestring):
394
        value = value.split(' OR ')
395
        value = map(lambda x:x.strip(), value)
396
      value_list = value
397
      if isSimpleType(value) or isinstance(value, DateTime):
398 399 400
        value_list = [value]
      # For security.
      for value in value_list:
Sebastien Robin's avatar
Sebastien Robin committed
401 402 403
        comparison_operator = None
        if (value != '' or not ignore_empty_string) \
                        and isinstance(value, basestring):
404
          if '%' in value:
Sebastien Robin's avatar
Sebastien Robin committed
405 406 407 408 409 410 411
            comparison_operator = 'LIKE'
          elif len(value) >= 1 and value[0:2] in ('<=','!=','>='):
            comparison_operator = value[0:2]
            value = value[2:]
          elif len(value) >= 1 and value[0] in ('=','>','<'):
            comparison_operator = value[0]
            value = value[1:]
412 413
          elif key in keyword_search_keys:
            # We must add % in the request to simulate the catalog
Sebastien Robin's avatar
Sebastien Robin committed
414 415
            comparison_operator = 'LIKE'
            value = '%%%s%%' % value
416 417 418 419 420 421 422 423 424 425 426
          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,'')
Sebastien Robin's avatar
Sebastien Robin committed
427 428
            where_expression.append(
                        "MATCH %s AGAINST ('%s' %s)" % (key, value, mode))
429 430
            if not stat__:
              # we return relevance as Table_Key_relevance
Sebastien Robin's avatar
Sebastien Robin committed
431 432 433
              select_expression.append(
                     "MATCH %s AGAINST ('%s' %s) AS %s_relevance" 
                     % (key, value, mode,key.replace('.','_')))
434 435
              # and for simplicity as Key_relevance
              if '.' in key:
Sebastien Robin's avatar
Sebastien Robin committed
436 437 438
                select_expression.append(
                     "MATCH %s AGAINST ('%s' %s) AS %s_relevance" % 
                     (key, value, mode,key.split('.')[1]))
439
          else:
Sebastien Robin's avatar
Sebastien Robin committed
440
            comparison_operator = '='
441
        elif not isinstance(value, basestring):
Sebastien Robin's avatar
Sebastien Robin committed
442 443 444 445 446 447
          comparison_operator = '='
        if comparison_operator is not None:
          key = self._quoteSQLKey(key)
          value = self._quoteSQLString(value)
          where_expression.append("%s %s %s" % 
                                  (key, comparison_operator, value))
Aurel's avatar
Aurel committed
448

Nicolas Delaby's avatar
Nicolas Delaby committed
449 450
    elif value is None:
      where_expression.append("%s is NULL" % (key))
451
    elif isinstance(value, (tuple, list)) and self.operator.upper() == 'IN':
452
      if len(value) > 1:
453 454 455
        escaped_value_list = [self._quoteSQLString(x) for x in value]
        escaped_value_string = ', '.join(escaped_value_list)
        where_expression.append("%s IN (%s)" % (key, escaped_value_string))
456
      elif len(value) == 1:
457
        where_expression.append("%s = %s" % (key, self._quoteSQLString(value[0])))
458
      else:
Vincent Pelletier's avatar
Vincent Pelletier committed
459
        where_expression.append('0') # "foo IN ()" is invalid SQL syntax, so use a "false" value.
460
    else:
Sebastien Robin's avatar
Sebastien Robin committed
461 462
      where_expression.append("%s = %s" % 
           (self._quoteSQLKey(key), self._quoteSQLString(value)))
463 464 465 466 467 468

    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)
469
    else:
470
      where_expression = '1' # It is better to have a valid default
471 472
    return {'where_expression':where_expression,
            'select_expression_list':select_expression}
Aurel's avatar
Aurel committed
473

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
  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
  """
493
  def __init__(self, *args, **kw):
494 495 496 497 498 499
    # XXX: python weirdness
    # >>> def foo(a='a', *args):
    # ...   pass
    # ...
    # >>> foo('something', a='test')
    # TypeError: foo() got multiple values for keyword argument 'a'
500
    self.query_list = args
501 502
    self.operator = kw.pop('operator', 'AND')
    # XXX: What is that used for ?! It's utterly dangerous.
503 504 505 506 507 508 509 510
    self.__dict__.update(kw)

  def __call__(self):
    self.asSQLExpression()

  def getQueryList(self):
    return self.query_list

511 512 513
  def getRelatedTableMapDict(self):
    result = {}
    for query in self.getQueryList():
514 515
      if not(isinstance(query, basestring)):
        result.update(query.getRelatedTableMapDict())
516 517
    return result

518 519 520 521 522
  def asSQLExpression(self, key_alias_dict=None,
                            ignore_empty_string=1,
                            keyword_search_keys=None,
                            full_text_search_keys=None,
                            stat__=0):
523 524 525 526 527 528
    """
    Build the sql string
    """
    sql_expression_list = []
    select_expression_list = []
    for query in self.getQueryList():
529 530 531 532 533 534 535 536 537 538
      if isinstance(query, basestring):
        sql_expression_list.append(query)
      else:
        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'])
539 540
    operator = self.getOperator()
    result = {'where_expression':('(%s)' %  \
541
                         (' %s ' % operator).join(['(%s)' % x for x in sql_expression_list])),
542 543 544 545 546 547 548 549 550 551
              '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():
552 553
      if not(isinstance(query, basestring)):
        key_list.extend(query.getSQLKeyList())
554 555 556 557
    return key_list

allow_class(ComplexQuery)

558 559 560 561 562
class Catalog( Folder,
               Persistent,
               Acquisition.Implicit,
               ExtensionClass.Base,
               OFS.History.Historical ):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
563 564 565 566
  """ An Object Catalog

  An Object Catalog maintains a table of object metadata, and a
  series of manageable indexes to quickly search for objects
567
  (references in the metadata) that satisfy a search where_expression.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
568 569 570 571 572 573 574 575

  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

576 577
  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.
578 579 580
  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).
581 582 583
  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
584

Jean-Paul Smets's avatar
Jean-Paul Smets committed
585 586 587 588 589 590 591 592

  bgrain defined in meyhods...

  TODO:

    - optmization: indexing objects should be deferred
      until timeout value or end of transaction
  """
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
  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'),}
624
    ) + OFS.History.Historical.manage_options
625 626 627 628 629 630 631

  __ac_permissions__=(

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

      'manage_catalogView', 'manage_catalogFind',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
632 633
      'manage_catalogFilter',
      'manage_catalogAdvanced',
634 635

      'manage_catalogReindex', 'manage_catalogFoundItems',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
636 637
      'manage_catalogClear',
      'manage_main',
638 639 640 641 642 643
      'manage_editFilter',
      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
Yoshinori Okuji's avatar
Yoshinori Okuji committed
644 645
      'all_meta_types', 'valid_roles',
      'getCatalogSearchTableIds',
646
      'getFilterableMethodList', ],
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
     ['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' },
672 673 674 675 676
    { 'id'      : 'sql_catalog_reserve_uid',
      'description' : 'A method to reserve a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
677 678 679 680 681
    { 'id'      : 'sql_catalog_delete_uid',
      'description' : 'A method to delete a uid value',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
682 683
    { 'id'      : 'sql_catalog_object_list',
      'description' : 'Methods to be called to catalog the list of objects',
684 685 686 687 688 689 690 691
      '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' },
692 693 694
    { 'id'      : 'sql_catalog_translation_list',
      'description' : 'Methods to be called to catalog the list of translation objects',
      'type'    : 'selection',
695 696
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
697 698 699
    { 'id'      : 'sql_delete_translation_list',
      'description' : 'Methods to be called to delete translations',
      'type'    : 'selection',
700 701
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
702 703
    { 'id'      : 'sql_clear_catalog',
      'description' : 'The methods which should be called to clear the catalog',
704 705 706
      'type'    : 'multiple selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
707
    { 'id'      : 'sql_record_object_list',
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      '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
727 728 729 730 731
    { 'id'      : 'sql_search_security',
      'description' : 'Main method to search security',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    { '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' },
767 768 769 770 771
    { 'id'      : 'sql_catalog_index',
      'description' : 'Method to get the main catalog index',
      'type'    : 'selection',
      'select_variable' : 'getCatalogMethodIds',
      'mode'    : 'w' },
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
    { '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' },
802 803 804 805 806
    { 'id'      : 'sql_catalog_index_on_order_keys',
      'description' : 'Columns which should be used by specifying an index when sorting on them',
      'type'    : 'multiple selection',
      'select_variable' : 'getSortColumnIds',
      'mode'    : 'w' },
807 808 809 810 811 812 813 814 815
    { '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' },
816 817 818 819 820
    { 'id'      : 'sql_catalog_scriptable_keys',
      'title'   : 'Related keys',
      'description' : 'Virtual columns to generate scriptable scriptable queries',
      'type'    : 'lines',
      'mode'    : 'w' },
821 822
  )

823
  sql_catalog_produce_reserved = ''
824
  sql_catalog_delete_uid = ''
825 826 827 828 829 830 831 832 833 834 835
  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
836
  sql_search_security = ''
837 838 839 840 841 842
  sql_count_results = ''
  sql_getitem_by_path = ''
  sql_getitem_by_uid = ''
  sql_catalog_tables = ''
  sql_search_tables = ()
  sql_catalog_schema = ''
843
  sql_catalog_index = ''
844 845 846
  sql_unique_values = ''
  sql_catalog_paths = ''
  sql_catalog_keyword_search_keys =  ()
847 848 849 850 851
  sql_catalog_full_text_search_keys = ()
  sql_catalog_request_keys = ()
  sql_search_result_keys = ()
  sql_catalog_topic_search_keys = ()
  sql_catalog_multivalue_keys = ()
852
  sql_catalog_index_on_order_keys = ()
853
  sql_catalog_related_keys = ()
854
  sql_catalog_scriptable_keys = ()
855

856 857 858 859 860 861
  # 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
862

863 864 865 866 867 868 869
  # 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
870

871 872 873 874 875 876 877 878 879 880
  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
881 882 883
    self.schema = {}  # mapping from attribute name to column
    self.names = {}   # mapping from column to attribute name
    self.indexes = {}   # empty mapping
884
    self.filter_dict = PersistentMapping()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
885

886 887 888 889 890 891
  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')
892 893 894 895 896 897 898 899 900 901 902 903
    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]
904
      if isinstance(value, basestring):
905
        f.write('  <property id=%s type="str">%s</property>\n' % (quoteattr(property_id), escape(value)))
906
      elif isinstance(value, (tuple, list)):
907 908 909
        f.write('  <property id=%s type="tuple">\n' % quoteattr(property_id))
        # Sort for easy diff
        item_list = []
910
        for item in value:
911
          if isinstance(item, basestring):
912 913 914 915
            item_list.append(item)
        item_list.sort()
        for item in item_list:
          f.write('    <item type="str">%s</item>\n' % escape(str(item)))
916
        f.write('  </property>\n')
917 918 919
    # 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'):
920 921
      filter_list = []
      for filter_id in self.filter_dict.keys():
922
        filter_definition = self.filter_dict[filter_id]
923 924 925 926 927 928 929
        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']:
930 931
          # If a filter is not activated, no need to output it.
          continue
932
        if not filter_def['expression']:
933 934
          # If the expression is not specified, meaningless to specify it.
          continue
935
        f.write('  <filter id=%s expression=%s />\n' % (quoteattr(filter_id), quoteattr(filter_def['expression'])))
936
        # For now, portal types are not exported, because portal types are too specific to each site.
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
    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):
958
            raise CatalogError, 'unknown property id %r' % (id,)
959
          if type not in ('str', 'tuple'):
960
            raise CatalogError, 'unknown property type %r' % (type,)
961 962 963 964
          if type == 'str':
            value = ''
            for text in prop.childNodes:
              if text.nodeType == text.TEXT_NODE:
965
                value = str(text.data)
966 967 968 969 970 971
                break
          else:
            value = []
            for item in prop.getElementsByTagName("item"):
              item_type = item.getAttribute("type")
              if item_type != 'str':
972
                raise CatalogError, 'unknown item type %r' % (item_type,)
973 974
              for text in item.childNodes:
                if text.nodeType == text.TEXT_NODE:
975
                  value.append(str(text.data))
976 977 978 979
                  break
            value = tuple(value)

          setattr(self, id, value)
980

981 982 983
        if not hasattr(self, 'filter_dict'):
          self.filter_dict = PersistentMapping()
        for filt in root.getElementsByTagName("filter"):
984
          id = str(filt.getAttribute("id"))
985 986 987 988 989 990 991 992 993 994 995 996
          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
997 998 999 1000
      finally:
        doc.unlink()
    finally:
      f.close()
Aurel's avatar
Aurel committed
1001

1002 1003 1004 1005 1006 1007 1008
  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__)))
1009 1010 1011

  def _clearSecurityCache(self):
    self.security_uid_dict = OIBTree()
1012
    self.security_uid_index = None
1013 1014

  security.declarePrivate('getSecurityUid')
1015
  def getSecurityUid(self, wrapped_object):
1016 1017 1018 1019 1020 1021 1022
    """
      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
1023
    allowed_roles_and_users = wrapped_object.allowedRolesAndUsers()
1024 1025 1026 1027
    # 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)
1028 1029
    # Make sure no duplicates
    if getattr(aq_base(self), 'security_uid_dict', None) is None:
1030 1031 1032
      self._clearSecurityCache()
    if self.security_uid_dict.has_key(allowed_roles_and_users):
      return (self.security_uid_dict[allowed_roles_and_users], None)
1033 1034 1035 1036 1037 1038 1039 1040
    # If the id_tool is there, it is better to use it, it allows
    # to create many new security uids by the same time
    # because with this tool we are sure that we will have 2 different
    # uids if two instances are doing this code in the same time
    id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
    if id_tool is not None:
      default = 1
      # We must keep compatibility with existing sites
1041 1042
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is not None:
1043 1044 1045 1046
        # At some point, it was a Length
        if isinstance(previous_security_uid, Length):
          default = previous_security_uid() + 1
        else:
1047
          default = previous_security_uid
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
      security_uid = id_tool.generateNewLengthId(id_group='security_uid_index',
                                        default=default)
    else:
      previous_security_uid = getattr(self, 'security_uid_index', None)
      if previous_security_uid is None:
        previous_security_uid = 0
      # At some point, it was a Length
      if isinstance(previous_security_uid, Length):
        previous_security_uid = previous_security_uid()
      security_uid = previous_security_uid + 1
      self.security_uid_index = security_uid
1059 1060
    self.security_uid_dict[allowed_roles_and_users] = security_uid
    return (security_uid, allowed_roles_and_users)
1061

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1062 1063 1064 1065 1066 1067
  def clear(self):
    """
    Clears the catalog by calling a list of methods
    """
    methods = self.sql_clear_catalog
    for method_name in methods:
1068
      method = getattr(self, method_name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1069 1070
      try:
        method()
1071 1072
      except ConflictError:
        raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1073
      except:
1074
        LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
1075
            'could not clear catalog with %s' % method_name, error=sys.exc_info())
1076

1077
    # Reserved uids have been removed.
1078
    self.clearReserved()
1079

1080
    # Add a dummy item so that SQLCatalog will not use existing uids again.
1081
    self.insertMaxUid()
1082

1083
    # Remove the cache of catalog schema.
1084 1085
    if hasattr(self, '_v_catalog_schema_dict') :
      del self._v_catalog_schema_dict
1086

1087
    self._clearSecurityCache()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
  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()])

1099 1100 1101 1102 1103 1104
  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
1105 1106 1107 1108 1109
    try:
      method()
    except ConflictError:
      raise
    except:
1110
      LOG('SQLCatalog', WARNING,
Romain Courteaud's avatar
Romain Courteaud committed
1111 1112 1113
          'could not clear reserved catalog with %s' % \
              method_id, error=sys.exc_info())
      raise
1114
    self._last_clear_reserved_time += 1
1115

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1116 1117 1118 1119 1120 1121 1122 1123 1124
  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]
1125
    raise KeyError, uid
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

  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

1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  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

1163
  security.declarePublic('getCatalogSearchResultKeys')
1164 1165 1166 1167
  def getCatalogSearchResultKeys(self):
    """Return search result keys.
    """
    return self.sql_search_result_keys
1168

1169
  def _getCatalogSchema(self, table=None):
1170 1171 1172
    # XXX: Using a volatile as a cache makes it impossible to flush
    # consistently on all connections containing the volatile. Another
    # caching scheme must be used here.
1173
    catalog_schema_dict = getattr(aq_base(self), '_v_catalog_schema_dict', {})
1174

1175 1176 1177 1178 1179 1180 1181 1182 1183
    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)
1184 1185
      except ConflictError:
        raise
1186
      except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1187
        LOG('SQLCatalog', WARNING, '_getCatalogSchema failed with the method %s' % method_name, error=sys.exc_info())
1188 1189 1190
        pass
      catalog_schema_dict[table] = tuple(result_list)
      self._v_catalog_schema_dict= catalog_schema_dict
1191

1192
    return catalog_schema_dict[table]
1193

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1194 1195
  def getColumnIds(self):
    """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1196 1197 1198
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1199
    def _getColumnIds():
1200 1201 1202 1203 1204 1205
      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 ?
1206
      for related in self.getSQLCatalogRelatedKeyList():
1207 1208 1209
        related_tuple = related.split('|')
        related_key = related_tuple[0].strip()
        keys[related_key] = 1
1210 1211 1212 1213
      for scriptable in self.getSQLCatalogScriptableKeyList():
        scriptable_tuple = scriptable.split('|')
        scriptable = scriptable_tuple[0].strip()
        keys[scriptable] = 1
1214 1215 1216
      keys = keys.keys()
      keys.sort()
      return keys
Aurel's avatar
Aurel committed
1217
    return CachingMethod(_getColumnIds, id='SQLCatalog.getColumnIds', cache_factory='erp5_content_long')()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1218

1219 1220 1221 1222 1223
  def getColumnMap(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
1224
    def _getColumnMap():
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
      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
1236
    return CachingMethod(_getColumnMap, id='SQLCatalog.getColumnMap', cache_factory='erp5_content_long')()
1237

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1238 1239 1240 1241 1242 1243 1244
  def getResultColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids
    """
    keys = {}
    for table in self.getCatalogSearchTableIds():
1245 1246 1247
      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
1248 1249 1250 1251
    keys = keys.keys()
    keys.sort()
    return keys

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
  def getSortColumnIds(self):
    """
    Calls the show column method and returns dictionnary of
    Field Ids that can be used for a sort
    """
    keys = {}
    for table in self.getTableIds():
      field_list = self._getCatalogSchema(table=table)
      for field in field_list:
        keys['%s.%s' % (table, field)] = 1
    keys = keys.keys()
    keys.sort()
    return keys

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1266 1267 1268
  def getTableIds(self):
    """
    Calls the show table method and returns dictionnary of
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1269 1270 1271
    Field Ids
    """
    keys = []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1272 1273
    method_name = self.sql_catalog_tables
    try:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1274 1275 1276
      method = getattr(self,  method_name)
      search_result = method()
      for c in search_result:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1277
        keys.append(c[0])
1278 1279
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1280 1281
    except:
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1282 1283
    return keys

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
  def getUIDBuffer(self, force_new_buffer=False):
    global global_uid_buffer_dict
    klass = self.__class__
    assert klass._reserved_uid_lock.locked()
    assert getattr(self, 'aq_base', None) is not None
    instance_key = self.getPhysicalPath()
    if instance_key not in global_uid_buffer_dict:
      global_uid_buffer_dict[instance_key] = {}
    uid_buffer_dict = global_uid_buffer_dict[instance_key]
    thread_key = get_ident()
    if force_new_buffer or thread_key not in uid_buffer_dict:
      uid_buffer_dict[thread_key] = UidBuffer()
    return uid_buffer_dict[thread_key]
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1298
  # the cataloging API
1299 1300 1301
  def produceUid(self):
    """
      Produces reserved uids in advance
1302
    """
1303 1304 1305 1306
    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.
1307 1308 1309 1310
    force_new_buffer = (klass._local_clear_reserved_time != self._last_clear_reserved_time)
    uid_buffer = self.getUIDBuffer(force_new_buffer=force_new_buffer)
    klass._local_clear_reserved_time = self._last_clear_reserved_time
    if len(uid_buffer) == 0:
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
      id_tool = getattr(self.getPortalObject(), 'portal_ids', None)
      if id_tool is not None:
        if self._max_uid is None:
          self._max_uid = Length()
        uid_list = id_tool.generateNewLengthIdList(id_group='catalog_uid',
                     id_count=UID_BUFFER_SIZE, default=self._max_uid())
        # TODO: if this method is kept and former uid allocation code is
        # discarded, self._max_uid duplicates work done by portal_ids: it
        # already keeps track of the highest allocated number for all id
        # generator groups.
      else:
        method_id = self.sql_catalog_produce_reserved
        method = getattr(self, method_id)
        # 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()
        uid_list = [x.uid for x in method(count = UID_BUFFER_SIZE, instance_id = instance_id) if x.uid != 0]
1333
      uid_buffer.extend(uid_list)
1334

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
  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
1348

1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
  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

1369 1370 1371
  def newUid(self):
    """
      This is where uid generation takes place. We should consider a multi-threaded environment
1372 1373
      with multiple ZEO clients on a single ZEO server.

1374
      The main risk is the following:
1375

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

1378
      - one reindexing node N1 starts reindexing f
1379

1380
      - another reindexing node N2 starts reindexing e
1381

1382 1383 1384
      - 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

1385
      Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
1386
      with the risk of graph loops
1387
    """
1388
    if not self.isIndexable():
1389 1390
      return None

1391 1392 1393 1394
    klass = self.__class__
    try:
      klass._reserved_uid_lock.acquire()
      self.produceUid()
1395 1396 1397
      uid_buffer = self.getUIDBuffer()
      if len(uid_buffer) > 0:
        uid = uid_buffer.pop()
1398 1399 1400 1401 1402 1403
        # 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
1404 1405 1406 1407
        if self._max_uid is None:
          self._max_uid = Length()
        if uid > self._max_uid():
          self._max_uid.set(uid)
1408
        return long(uid)
1409 1410 1411 1412
      else:
        raise CatalogError("Could not retrieve new uid")
    finally:
      klass._reserved_uid_lock.release()
1413

1414 1415 1416
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None):
    """ index Zope object(s) that 'urls' point to """
    if urls:
1417
      if isinstance(urls, str):
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
        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:
1433
      if isinstance(urls, str):
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
        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`)))

1457
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None,
Romain Courteaud's avatar
Romain Courteaud committed
1458
                          URL1=None, sql_catalog_id=None):
1459 1460 1461 1462
    """ clears the whole enchilada """
    self.clear()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1463
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1464
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1465 1466

  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None):
1467
    """ clears reserved uids """
1468 1469 1470
    self.clearReserved()

    if RESPONSE and URL1:
Romain Courteaud's avatar
Romain Courteaud committed
1471
      RESPONSE.redirect('%s/manage_catalogAdvanced?' \
1472
                        'manage_tabs_message=Catalog%%20Cleared' % URL1)
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509

  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
1510
  def catalogObject(self, object, path, is_object_moved=0):
1511 1512
    """Add an object to the Catalog by calling all SQL methods and
    providing needed arguments.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1513

1514 1515
    'object' is the object to be catalogged."""
    self._catalogObjectList([object])
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1516

1517 1518 1519 1520
  def catalogObjectList(self, object_list, method_id_list=None, 
                        disable_cache=0, check_uid=1, idxs=None):
    """Add objects to the Catalog by calling all SQL methods and
    providing needed arguments.
1521

1522 1523
      method_id_list : specify which methods should be used. If not
                       set, it will take the default value of portal_catalog.
1524 1525

      disable_cache : do not use cache, so values will be computed each time,
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
                      only useful in some particular cases, most of the time
                      you don't need to use it.

    Each element of 'object_list' is an object to be catalogged.

    'uid' is the unique Catalog identifier for this object.
    
    Note that this method calls _catalogObjectList with fragments of
    the object list, because calling _catalogObjectList with too many
    objects at a time bloats the process's memory consumption, due to
    caching."""
    # XXX 300 is arbitrary.
    for i in xrange(0, len(object_list), 300):
      self._catalogObjectList(object_list[i:i+300], 
                              method_id_list=method_id_list,
                              disable_cache=disable_cache,
                              check_uid=check_uid,
                              idxs=idxs)
    
  def _catalogObjectList(self, object_list, method_id_list=None, 
                         disable_cache=0, check_uid=1, idxs=None):
    """This is the real method to catalog objects.

    XXX: For now newUid is used to allocated UIDs. Is this good?
    Is it better to INSERT then SELECT?"""
1551
    LOG('SQLCatalog', TRACE, 'catalogging %d objects' % len(object_list))
1552
    #LOG('catalogObjectList', 0, 'called with %r' % (object_list,))
1553

1554
    if idxs not in (None, []):
1555 1556
      LOG('ZSLQCatalog.SQLCatalog:catalogObjectList', WARNING, 
          'idxs is ignored in this function and is only provided to be compatible with CMFCatalogAware.reindexObject.')
1557

1558 1559
    if not self.isIndexable():
      return None
1560

Jérome Perrin's avatar
Jérome Perrin committed
1561
    portal_catalog = self.getSiteRoot().portal_catalog
1562

1563 1564
    # Reminder about optimization: It might be possible to issue just one
    # query to get enought results to check uid & path consistency.
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
    path_uid_dict = {}
    uid_path_dict = {}

    if check_uid:
      path_list = []
      path_list_append = path_list.append
      uid_list = []
      uid_list_append = uid_list.append
      for object in object_list:
        path = object.getPath()
        if path is not None:
          path_list_append(path)
        uid = object.uid
        if uid is not None:
          uid_list_append(uid)
      path_uid_dict = self.getUidDictForPathList(path_list=path_list)
      uid_path_dict = self.getPathDictForUidList(uid_list=uid_list)

1583
    for object in object_list:
1584
      if not getattr(aq_base(object), 'uid', None):
1585
        try:
1586
          object.uid = self.newUid()
1587 1588
        except ConflictError:
          raise
1589
        except:
1590
          raise RuntimeError, 'could not set missing uid for %r' % (object,)
1591
      elif check_uid:
1592 1593
        uid = object.uid
        path = object.getPath()
1594
        index = path_uid_dict.get(path, None)
1595
        try:
1596
          index = long(index)
1597
        except TypeError:
1598
          index = None
1599 1600 1601
        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:
1602 1603
          if uid != index or isinstance(uid, int):
            # We want to make sure that uid becomes long if it is an int
1604
            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))
1605 1606 1607 1608 1609 1610
            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
1611
          if uid in uid_path_dict:
1612 1613 1614
            catalog_path = uid_path_dict.get(uid)
          else:
            catalog_path = self.getPathForUid(uid)
1615 1616 1617 1618 1619 1620
          #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()
1621 1622
              uid_buffer = self.getUIDBuffer()
              if uid_buffer is not None:
1623 1624 1625 1626 1627 1628 1629 1630
                # 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.
1631
                try:
1632
                  uid_buffer.remove(uid)
1633 1634
                except ValueError:
                  pass
1635 1636 1637 1638
            finally:
              klass._reserved_uid_lock.release()
          elif catalog_path is not None:
            # An uid conflict happened... Why?
1639 1640 1641 1642
            # 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,))

1643
            object.uid = self.newUid()
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1644
            LOG('SQLCatalog', WARNING,
1645
                '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))
1646

1647 1648
    if method_id_list is None:
      method_id_list = self.sql_catalog_object_list
1649
    econtext_cache = {}
1650 1651
    argument_cache = {}

1652
    try:
1653
      if not disable_cache:
1654
        enableReadOnlyTransactionCache(self)
1655

1656
      method_kw_dict = {}
1657
      for method_name in method_id_list:
1658
        kw = {}
1659
        if self.isMethodFiltered(method_name):
1660 1661 1662 1663 1664 1665 1666
          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
Jérome Perrin's avatar
Jérome Perrin committed
1667
            if type_list and object.getPortalType() not in type_list:
1668 1669
              continue
            elif expression is not None:
1670
              try:
1671
                econtext = econtext_cache[object.uid]
1672
              except KeyError:
1673 1674 1675
                econtext = self.getExpressionContext(object)
                econtext_cache[object.uid] = econtext
              result = expression(econtext)
1676 1677 1678 1679 1680
              if not result:
                continue
            catalogged_object_list.append(object)
        else:
          catalogged_object_list = object_list
1681

1682 1683
        if len(catalogged_object_list) == 0:
          continue
1684

1685
        method_kw_dict[method_name] = kw
1686

1687 1688
        #LOG('catalogObjectList', 0, 'method_name = %s' % (method_name,))
        method = getattr(self, method_name)
1689
        if method.meta_type in ("Z SQL Method", "LDIF Method"):
1690
          # Build the dictionnary of values
1691
          arguments = split(method.arguments_src)
1692 1693 1694
        elif method.meta_type == "Script (Python)":
          arguments = \
            method.func_code.co_varnames[:method.func_code.co_argcount]
1695 1696 1697 1698 1699 1700 1701 1702 1703
        else:
          arguments = []
        for arg in arguments:
          value_list = []
          append = value_list.append
          for object in catalogged_object_list:
            try:
              value = argument_cache[(object.uid, arg)]
            except KeyError:
1704
              try:
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
                value = getattr(object, arg, None)
                if callable(value):
                  value = value()
              except ConflictError:
                raise
              except:
                value = None
              if not disable_cache:
                argument_cache[(object.uid, arg)] = value
            append(value)
          kw[arg] = value_list
1716

1717
      for method_name in method_id_list:
1718 1719 1720 1721
        if method_name not in method_kw_dict:
          continue
        kw = method_kw_dict[method_name]
        method = getattr(self, method_name)
Jérome Perrin's avatar
Jérome Perrin committed
1722
        method = aq_base(method).__of__(portal_catalog) # Use method in
1723 1724 1725 1726
                # the context of portal_catalog
        # Alter/Create row
        try:
          #start_time = DateTime()
1727
          #LOG('catalogObjectList', DEBUG, 'kw = %r, method_name = %r' % (kw, method_name))
1728 1729 1730 1731 1732 1733 1734
          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]))
1735

1736 1737 1738
        except ConflictError:
          raise
        except:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1739
          LOG('SQLCatalog', WARNING, 'could not catalog objects %s with method %s' % (object_list, method_name),
1740 1741 1742
              error=sys.exc_info())
          raise
    finally:
1743
      if not disable_cache:
1744
        disableReadOnlyTransactionCache(self)
1745

1746 1747
  if psyco is not None:
    psyco.bind(_catalogObjectList)
1748

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
  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
1761 1762 1763 1764
    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
1765
      return self.uncatalogObject(path=path,uid=uid)
1766 1767 1768
    method = getattr(self, method_name)
    method(uid = uid)

1769
  def uncatalogObject(self, path=None, uid=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
    """
    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

    """
1782
    if not self.isIndexable():
1783 1784
      return None

1785 1786
    if uid is None and path is not None:
      uid = self.getUidForPath(path)
1787 1788
    methods = self.sql_uncatalog_object
    if uid is None:
1789
      return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1790
    for method_name in methods:
1791 1792
      # 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
1793
      method = getattr(self, method_name)
1794
      method(uid = uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1795

1796 1797 1798 1799
  def catalogTranslationList(self, object_list):
    """Catalog translations.
    """
    method_name = self.sql_catalog_translation_list
1800 1801
    return self.catalogObjectList(object_list, method_id_list = (method_name,),
                                  check_uid=0)
1802

1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813
  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())
1814

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1815 1816 1817
  def uniqueValuesFor(self, name):
    """ return unique values for FieldIndex name """
    method = getattr(self, self.sql_unique_values)
1818
    return method(column=name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1819 1820 1821 1822 1823 1824 1825 1826

  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 """
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
    #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
1837 1838
      return None

1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
  def getUidDictForPathList(self, path_list):
    """ Looks up into catalog table to convert path into uid """
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_path)
    path_uid_dict = {}
    try:
      search_result = method(path_list = path_list)
      # If not empty, return first record
      for result in search_result:
        path_uid_dict[result.path] = result.uid
    except ValueError, message:
      # This code is only there for backward compatibility
      # XXX this must be removed one day
      # This means we have the previous zsql method
      # and we must call the method for every path
      for path in path_list:
        search_result = method(path = path)
        if len(search_result) > 0:
          path_uid_dict[path] = search_result[0].uid
    return path_uid_dict

  def getPathDictForUidList(self, uid_list):
    """ Looks up into catalog table to convert uid into path """
    # Get the appropriate SQL Method
    method = getattr(self, self.sql_getitem_by_uid)
    uid_path_dict = {}
    try:
      search_result = method(uid_list = uid_list)
      # If not empty, return first record
      for result in search_result:
        uid_path_dict[result.uid] = result.path
    except ValueError, message:
      # This code is only there for backward compatibility
      # XXX this must be removed one day
      # This means we have the previous zsql method
      # and we must call the method for every path
      for uid in uid_list:
        search_result = method(uid = uid)
        if len(search_result) > 0:
Yoshinori Okuji's avatar
Yoshinori Okuji committed
1878
          uid_path_dict[uid] = search_result[0].path
1879 1880
    return uid_path_dict

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1881 1882 1883 1884 1885 1886 1887 1888 1889
  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
1890 1891 1892 1893
      try:
        int(uid)
      except ValueError:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1894 1895 1896 1897 1898 1899 1900 1901
      # 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
1902 1903
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1904 1905 1906
    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
1907
      LOG('SQLCatalog', WARNING, "could not find path from uid %s" % (uid,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
      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
1936 1937
    except ConflictError:
      raise
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1938 1939 1940
    except:
      # This is a real LOG message
      # which is required in order to be able to import .zexp files
1941 1942
      LOG('SQLCatalog', WARNING,
          "could not find metadata from path %s" % (path,))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1943 1944 1945 1946 1947 1948
      return None

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

1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
  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
1961 1962
            if not isinstance(id, str):
              id=id()
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
            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

1974
  def getSQLCatalogRelatedKeyList(self, key_list=None):
1975 1976
    """
    Return the list of related keys.
1977
    This method can be overidden in order to implement
1978 1979
    dynamic generation of some related keys.
    """
1980 1981
    if key_list is None:
      key_list = []
1982
    # Do not generate dynamic related key for acceptable_keys
1983
    dynamic_key_list = [k for k in key_list \
1984 1985 1986
        if k not in self.getColumnMap().keys()]
    dynamic_kw = {}

1987
    dynamic_list = self.getDynamicRelatedKeyList(dynamic_key_list)
1988 1989 1990
    full_list = list(dynamic_list) + list(self.sql_catalog_related_keys)
    return full_list

1991 1992 1993
  # Compatibililty SQL Sql
  getSqlCatalogRelatedKeyList = getSQLCatalogRelatedKeyList

1994 1995 1996 1997 1998
  def getSQLCatalogScriptableKeyList(self):
    """
    Return the list of scriptable keys.
    """
    return self.sql_catalog_scriptable_keys
1999

2000 2001
  def getTableIndex(self, table):
    """
2002
    Return a map between index and column for a given table
2003 2004 2005 2006 2007 2008 2009 2010
    """
    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:
2011 2012
        if table_index.has_key(line.KEY_NAME):
          table_index[line.KEY_NAME].append(line.COLUMN_NAME)
2013
        else:
2014 2015
          table_index[line.KEY_NAME] = [line.COLUMN_NAME,]
      LOG("SQLCatalog.getTableIndex", INFO, "index = %s for table = %s" \
2016 2017 2018
          %(table_index, table))
      return table_index
    return CachingMethod(_getTableIndex, id='SQLCatalog.getTableIndex', \
Aurel's avatar
Aurel committed
2019
                         cache_factory='erp5_content_long')(table=table)
2020 2021


2022
  def getIndex(self, table, column_list, all_column_list):
2023 2024 2025
    """
    Return possible index for a column list in a given table
    """
2026
    def _getIndex(table, column_list, all_column_list):
2027 2028 2029
      index_dict = self.getTableIndex(table)
      if isinstance(column_list, str):
        column_list = [column_list,]
2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051
      # 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
2052
    return CachingMethod(_getIndex, id='SQLCatalog.getIndex', cache_factory='erp5_content_long')\
2053 2054
          (table=table, column_list=column_list, all_column_list=all_column_list)

2055

2056
  def buildSQLQuery(self, query_table='catalog', REQUEST=None,
2057
                          ignore_empty_string=1, query=None, stat__=0, **kw):
2058
    """ Builds a complex SQL query to simulate ZCatalog behaviour """
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2059 2060 2061 2062 2063 2064 2065
    # 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

2066
    #LOG('SQLCatalog.buildSQLQuery, kw',0,kw)
2067 2068
    # 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
2069 2070
      kw = REQUEST

2071
    acceptable_key_map = self.getColumnMap()
2072 2073
    full_text_search_keys = list(self.sql_catalog_full_text_search_keys)
    keyword_search_keys = list(self.sql_catalog_keyword_search_keys)
2074
    topic_search_keys = self.sql_catalog_topic_search_keys
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2075
    multivalue_keys = self.sql_catalog_multivalue_keys
Aurel's avatar
Aurel committed
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
    # 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
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121

    # 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

2122 2123 2124 2125 2126 2127 2128 2129
    # 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

2130 2131 2132 2133
    # Build the list of Queries and ComplexQueries
    query_dict = {}
    key_list = [] # the list of column keys
    key_alias_dict = {}
2134
    query_group_by_list = None # Useful to keep a default group_by passed by scriptable keys
2135 2136 2137
    query_related_table_map_dict = {}
    if query is not None:
      kw ['query'] = query
2138
    for key in kw.keys():
2139
      if key not in RESERVED_KEY_LIST:
2140 2141 2142
        value = kw[key]
        current_query = None
        new_query_dict = {}
2143 2144 2145 2146 2147
        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])
2148 2149
          current_query = method(value) # May return None
          if hasattr(current_query, 'order_by'): query_group_by_list = current_query.order_by
2150
        else:
2151
          if isinstance(value, dict):
2152
            for value_key in value.keys():
2153 2154
              if value_key == 'query':
                new_query_dict[key] = value['query']
2155
              else:
2156
                new_query_dict[value_key] = value[value_key]
2157
          else:
2158
            new_query_dict[key] = value
2159
          current_query = Query(**new_query_dict)
2160 2161 2162
        if current_query is not None:
          query_dict[key] = current_query
          key_list.extend(current_query.getSQLKeyList())
2163
          query_related_table_map_dict.update(current_query.getRelatedTableMapDict())
2164

2165 2166 2167 2168 2169
    # 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:
2170 2171 2172
        sort_key = sort_info[0]
        if sort_key not in key_list:
          key_list.append(sort_key)
2173

2174
    related_tuples = self.getSQLCatalogRelatedKeyList(key_list=key_list)
Aurel's avatar
Aurel committed
2175

2176
    # Define related maps
2177 2178
    # each tuple from `related_tuples` has the form (key,
    # 'table1,table2,table3/column/where_expression')
2179
    related_keys = {}
2180 2181 2182
    related_method = {}
    related_table_map = {}
    related_column = {}
2183
    related_table_list = {}
2184
    table_rename_index = 0
2185
    related_methods = {} # related methods which need to be used
2186 2187 2188
    for t in related_tuples:
      t_tuple = t.split('|')
      key = t_tuple[0].strip()
2189 2190
      if key in key_list:
        join_tuple = t_tuple[1].strip().split('/')
2191
        related_keys[key] = None
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
        method_id = join_tuple[2]
        table_list = tuple(join_tuple[0].split(','))
        related_method[key] = method_id
        related_table_list[key] = table_list
        related_column[key] = join_tuple[1]
        # Check if some aliases where specified in queries
        map_list = query_related_table_map_dict.get(key,None)
        # Rename tables to prevent conflicts
        if not related_table_map.has_key((table_list,method_id)):
          if map_list is None:
            map_list = []
            for table_id in table_list:
              map_list.append((table_id,
                 "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
          related_table_map[(table_list,method_id)] = map_list
2208

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2209 2210
    # We take additional parameters from the REQUEST
    # and give priority to the REQUEST
2211
    if REQUEST is not None:
2212
      for key in acceptable_key_map.iterkeys():
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2213 2214
        if REQUEST.has_key(key):
          # Only copy a few keys from the REQUEST
2215
          if key in self.sql_catalog_request_keys:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2216
            kw[key] = REQUEST[key]
2217 2218

    def getNewKeyAndUpdateVariables(key):
2219
      key_is_acceptable = key in acceptable_key_map # Only calculate once
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
      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
2230
          new_key = "%s.%s" % (related_table_map[(table_list,method_id)][-1][-1],
2231 2232 2233 2234 2235 2236 2237 2238
                               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 \
2239
                '%s.%s' % (query_table, key) in acceptable_key_map:
2240 2241 2242
              new_key = '%s.%s' % (query_table, key)
            elif key == 'uid':
              # uid is always ambiguous so we can only change it here
2243
              new_key = 'catalog.uid'
2244 2245 2246 2247
          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
2248
            from_table_dict[acceptable_key_map[new_key][0]] = acceptable_key_map[new_key][0]
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
      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 = ''

2259
    from_table_dict = {'catalog' : 'catalog'} # Always include catalog table
2260
    if len(kw):
2261
      if kw.has_key('select_expression'):
Jérome Perrin's avatar
Jérome Perrin committed
2262
        select_expression_list.append(kw['select_expression'])
2263
      if kw.has_key('group_by_expression'):
2264
        group_by_expression_list.append(kw['group_by_expression'])
2265
      # Grouping
2266
      group_by_list = kw.get('group_by', query_group_by_list)
2267 2268 2269 2270
      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:
2271 2272
            new_key = getNewKeyAndUpdateVariables(key)
            group_by_expression_list.append(new_key)
2273 2274 2275 2276
        except ConflictError:
          raise
        except:
          LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build the new group by expression', error=sys.exc_info())
2277 2278 2279 2280
          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)
2281

2282
    sort_on = None
2283
    sort_key_list = []
2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295
    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
2296
          else:
2297 2298 2299 2300 2301 2302 2303 2304
            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
2305
        for (original_key, so, as_type) in sort_index:
2306
          key = getNewKeyAndUpdateVariables(original_key)
2307
          if key is not None:
2308
            sort_key_list.append(key)
2309 2310 2311 2312 2313 2314
            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)
2315
            else:
2316 2317
              new_sort_index.append('%s' % key)
          else:
2318 2319
            LOG('SQLCatalog', WARNING, 'buildSQLQuery could not build sort '
                'index (%s -> %s)' % (original_key, key))
2320 2321 2322 2323 2324 2325 2326
        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 = ''
2327
        sort_key_list = []
2328 2329 2330 2331 2332

    for key in key_list:
      if not key_alias_dict.has_key(key):
        getNewKeyAndUpdateVariables(key)
    if len(query_dict):
2333
      for key, query in query_dict.items():
2334 2335 2336 2337 2338 2339 2340 2341
        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
2342

2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
    # 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
2360 2361
    if kw.get('where_expression',None) not in (None,''):
      where_expression_list.append(kw['where_expression'])
2362 2363
    if len(where_expression_list)>1:
      where_expression_list = ['(%s)' % x for x in where_expression_list]
2364 2365 2366 2367 2368 2369 2370 2371
    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
2372

2373
    # force index if exists when doing sort as mysql doesn't manage them efficiently
2374
    if len(sort_key_list) > 0:
2375 2376
      index_from_table = {}
      # first group columns from a same table
2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
      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]

2388
        table = from_table_dict[related_table]
2389 2390 2391 2392 2393 2394
        # Check if it's a column for which we want to specify index
        index_columns = getattr(self, 'sql_catalog_index_on_order_keys', [])
        sort_column = '%s.%s' %(table, column)
        if not sort_column in index_columns:
          continue
        # Group columns
2395 2396 2397 2398 2399 2400
        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():
2401
        available_index_list = self.getIndex(table, index_from_table[table], key_list)
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413
        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

2414
    # Use a dictionary at the moment.
2415
    return { 'from_table_list' : from_table_dict.items(),
2416
             'order_by_expression' : sort_on,
Yoshinori Okuji's avatar
Yoshinori Okuji committed
2417
             'where_expression' : where_expression,
2418
             'limit_expression' : limit_expression,
2419 2420
             'select_expression': select_expression,
             'group_by_expression' : group_by_expression}
2421

2422 2423 2424
  # Compatibililty SQL Sql
  buildSqlQuery = buildSQLQuery

2425
  def queryResults(self, sql_method, REQUEST=None, used=None, src__=0, build_sql_query_method=None, **kw):
2426
    """ Returns a list of brains from a set of constraints on variables """
2427 2428 2429
    if build_sql_query_method is None:
      build_sql_query_method = self.buildSQLQuery
    query = build_sql_query_method(REQUEST=REQUEST, **kw)
2430 2431 2432
    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
2433
    kw['limit_expression'] = query['limit_expression']
2434
    kw['select_expression'] = query['select_expression']
2435
    kw['group_by_expression'] = query['group_by_expression']
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2436
    # Return the result
2437

2438 2439 2440
    #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))
2441
    #LOG('queryResults',0,'from_table_list: %s' % str(query['from_table_list']))
2442
    return sql_method(src__=src__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2443

2444
  def searchResults(self, REQUEST=None, used=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2445
    """ Returns a list of brains from a set of constraints on variables """
2446
    # The used argument is deprecated and is ignored
2447
    method = getattr(self, self.sql_search_results)
2448
    return self.queryResults(method, REQUEST=REQUEST, used=used, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2449 2450 2451

  __call__ = searchResults

2452
  def countResults(self, REQUEST=None, used=None, stat__=1, **kw):
2453
    """ Returns the number of items which satisfy the where_expression """
2454 2455
    # Get the search method
    method = getattr(self, self.sql_count_results)
2456
    return self.queryResults(method, REQUEST=REQUEST, used=used, stat__=stat__, **kw)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2457

2458
  def recordObjectList(self, path_list, catalog=1):
2459
    """
2460
      Record the path of an object being catalogged or uncatalogged.
2461
    """
2462 2463
    method = getattr(self, self.sql_record_object_list)
    method(path_list=path_list, catalog=catalog)
2464

2465
  def deleteRecordedObjectList(self, uid_list=()):
2466 2467 2468 2469
    """
      Delete all objects which contain any path.
    """
    method = getattr(self, self.sql_delete_recorded_object_list)
2470
    method(uid_list=uid_list)
2471

2472
  def readRecordedObjectList(self, catalog=1):
2473 2474 2475 2476
    """
      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)
2477
    return method(catalog=catalog)
2478 2479 2480 2481 2482 2483 2484 2485 2486

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

2489 2490 2491 2492
      # Remove unused filters.
      for id in self.filter_dict.keys():
        if id not in method_id_list:
          del self.filter_dict[id]
2493

2494
      for id in method_id_list:
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520
        # 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]
2521
          if isinstance(list_type, str):
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
            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
2537
      if getattr(aq_base(self), 'filter_dict', None) is None:
2538 2539
        self.filter_dict = PersistentMapping()
        return 0
2540
      try:
2541
        return self.filter_dict[method_name]['filtered']
2542 2543
      except KeyError:
        return 0
2544 2545 2546
    return 0

  def getExpression(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2547
    """ Get the filter expression text for this method.
2548 2549
    """
    if withCMF:
2550
      if getattr(aq_base(self), 'filter_dict', None) is None:
2551 2552
        self.filter_dict = PersistentMapping()
        return ""
2553
      try:
2554
        return self.filter_dict[method_name]['expression']
2555 2556
      except KeyError:
        return ""
2557 2558 2559
    return ""

  def getExpressionInstance(self, method_name):
Jérome Perrin's avatar
Jérome Perrin committed
2560
    """ Get the filter expression instance for this method.
2561 2562
    """
    if withCMF:
2563
      if getattr(aq_base(self), 'filter_dict', None) is None:
2564 2565
        self.filter_dict = PersistentMapping()
        return None
2566
      try:
2567
        return self.filter_dict[method_name]['expression_instance']
2568 2569
      except KeyError:
        return None
2570 2571
    return None

Jérome Perrin's avatar
Jérome Perrin committed
2572 2573
  def isPortalTypeSelected(self, method_name, portal_type):
    """ Returns true if the portal type is selected for this method.
2574 2575
    """
    if withCMF:
2576
      if getattr(aq_base(self), 'filter_dict', None) is None:
2577 2578
        self.filter_dict = PersistentMapping()
        return 0
2579 2580 2581 2582
      try:
        return portal_type in (self.filter_dict[method_name]['type'])
      except KeyError:
        return 0
2583 2584 2585 2586 2587 2588 2589 2590 2591
    return 0


  def getFilterableMethodList(self):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    method_dict = {}
    if withCMF:
2592 2593 2594 2595
      methods = getattr(self,'sql_catalog_object',()) + \
                getattr(self,'sql_uncatalog_object',()) + \
                getattr(self,'sql_update_object',()) + \
                getattr(self,'sql_catalog_object_list',())
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609
      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,
2610 2611 2612 2613 2614 2615 2616
            #'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
2617
            'isDocument':   ob.isDocument, # XXX
2618 2619
            'isInventory':  ob.isInventory, # XXX
            'isInventoryMovement': ob.isInventoryMovement, # XXX
2620 2621 2622 2623 2624 2625
            }
        return getEngine().getContext(data)


Globals.default__class_init__(Catalog)

Jean-Paul Smets's avatar
Jean-Paul Smets committed
2626
class CatalogError(Exception): pass
2627 2628 2629



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