ZSQLCatalog.py 50.4 KB
Newer Older
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
##############################################################################
#
# 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
#
##############################################################################
"""ZCatalog product"""

from Globals import DTMLFile, MessageDialog
import Globals

from OFS.Folder import Folder
from DateTime import DateTime
21
from Acquisition import Implicit, aq_base
Jean-Paul Smets's avatar
Jean-Paul Smets committed
22 23 24 25
from Persistence import Persistent
from DocumentTemplate.DT_Util import InstanceDict, TemplateDict
from DocumentTemplate.DT_Util import Eval
from AccessControl.Permission import name_trans
26 27
from SQLCatalog import CatalogError
from AccessControl import ClassSecurityInfo
Jean-Paul Smets's avatar
Jean-Paul Smets committed
28
from AccessControl.DTML import RestrictedDTML
29
from Products.CMFCore.utils import getToolByName
30
from Products.ERP5Type.Cache import clearCache
31
import string, sys
32
import time
Yoshinori Okuji's avatar
Yoshinori Okuji committed
33
import urllib
34
from ZODB.POSException import ConflictError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
35

36
from zLOG import LOG, ERROR, INFO
Jean-Paul Smets's avatar
Jean-Paul Smets committed
37

38 39
_marker = object()

40
manage_addZSQLCatalogForm=DTMLFile('dtml/addZSQLCatalog',globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
41

42 43 44 45
HOT_REINDEXING_FINISHED_STATE = 'finished'
HOT_REINDEXING_RECORDING_STATE = 'recording'
HOT_REINDEXING_DOUBLE_INDEXING_STATE = 'double indexing'

46
def manage_addZSQLCatalog(self, id, title,
Jean-Paul Smets's avatar
Jean-Paul Smets committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
             vocab_id='create_default_catalog_',
             REQUEST=None):
  """Add a ZCatalog object
  """
  id=str(id)
  title=str(title)
  vocab_id=str(vocab_id)
  if vocab_id == 'create_default_catalog_':
    vocab_id = None

  c=ZCatalog(id, title, self)
  self._setObject(id, c)
  if REQUEST is not None:
    return self.manage_main(self, REQUEST,update_menu=1)


class ZCatalog(Folder, Persistent, Implicit):
  """ZCatalog object

  A ZCatalog contains arbirary index like references to Zope
  objects.  ZCatalog's can index either 'Field' values of object, or
  'Text' values.

  ZCatalog does not store references to the objects themselves, but
  rather to a unique identifier that defines how to get to the
  object.  In Zope, this unique idenfier is the object's relative
  path to the ZCatalog (since two Zope object's cannot have the same
  URL, this is an excellent unique qualifier in Zope).

  Most of the dirty work is done in the _catalog object, which is an
  instance of the Catalog class.  An interesting feature of this
  class is that it is not Zope specific.  You can use it in any
  Python program to catalog objects.

  """

  meta_type = "ZSQLCatalog"
  icon='misc_/ZCatalog/ZCatalog.gif'
85
  security = ClassSecurityInfo()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
86 87 88 89 90 91 92 93

  manage_options = (
    {'label': 'Contents',       # TAB: Contents
     'action': 'manage_main',
     'help': ('OFSP','ObjectManager_Contents.stx')},
    {'label': 'Catalog',      # TAB: Cataloged Objects
     'action': 'manage_catalogView',
     'help':('ZCatalog','ZCatalog_Cataloged-Objects.stx')},
94 95
    {'label' : 'Filter',        # TAB: Filter
     'action' : 'manage_catalogFilter' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
96 97 98 99 100 101 102 103 104
    {'label': 'Properties',     # TAB: Properties
     'action': 'manage_propertiesForm',
     'help': ('OFSP','Properties.stx')},
    {'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')},
105 106
    {'label': 'Hot Reindexing',       # TAB: Hot Reindex
     'action': 'manage_catalogHotReindexing',
107
     },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
    {'label': 'Undo',         # TAB: Undo
     'action': 'manage_UndoForm',
     'help': ('OFSP','Undo.stx')},
    {'label': 'Security',       # TAB: Security
     'action': 'manage_access',
     'help': ('OFSP','Security.stx')},
    {'label': 'Ownership',      # TAB: Ownership
     'action': 'manage_owner',
     'help': ('OFSP','Ownership.stx'),}
    )

  __ac_permissions__=(

    ('Manage ZCatalog Entries',
     ['manage_catalogObject', 'manage_uncatalogObject',
      'catalog_object', 'uncatalog_object', 'refreshCatalog',

      'manage_catalogView', 'manage_catalogFind',
126
      'manage_catalogSchema', 'manage_catalogFilter',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
127
      'manage_catalogAdvanced', 'manage_objectInformation',
128
      'manage_catalogHotReindexing',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
129

130
      'manage_catalogReindex', 'manage_catalogFoundItems',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
131
      'manage_catalogClear', 'manage_editSchema',
132
      'manage_main',
133 134 135
      'manage_editFilter',

      'manage_hotReindexAll',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
136 137 138 139 140 141

      ],
     ['Manager']),

    ('Search ZCatalog',
     ['searchResults', '__call__', 'uniqueValuesFor',
142
      'getpath', 'schema', 'names', 'indexes',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
143
      'all_meta_types', 'valid_roles', 'resolve_url',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
144
      'getobject', 'getObject', 'getObjectList', 'getCatalogSearchTableIds',
145
      'getCatalogSearchResultKeys', 'getFilterableMethodList', ],
Jean-Paul Smets's avatar
Jean-Paul Smets committed
146
     ['Anonymous', 'Manager']),
147 148 149 150 151

    ('Import/Export objects',
     ['manage_catalogExportProperties', 'manage_catalogImportProperties', ],
     ['Manager']),

Jean-Paul Smets's avatar
Jean-Paul Smets committed
152 153 154
    )

  _properties = (
Jean-Paul Smets's avatar
Jean-Paul Smets committed
155
    { 'id'      : 'title',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
156 157 158
      'description' : 'The title of this catalog',
      'type'    : 'string',
      'mode'    : 'w' },
159 160
    { 'id'      : 'default_sql_catalog_id',
      'description' : 'The id of the default SQL Catalog',
Jean-Paul Smets's avatar
Jean-Paul Smets committed
161
      'type'    : 'selection',
162
      'select_variable'    : 'getSQLCatalogIdList',
163
      'mode'    : 'w' },
Jean-Paul Smets's avatar
Jean-Paul Smets committed
164

165 166 167 168 169 170 171 172 173 174 175 176 177
    # Hot Reindexing
    { 'id'      : 'source_sql_catalog_id',
      'description' : 'The id of a source SQL Catalog for hot reindexing',
      'type'    : 'string',
      'mode'    : '' },
    { 'id'      : 'destination_sql_catalog_id',
      'description' : 'The id of a destination SQL Catalog for hot reindexing',
      'type'    : 'string',
      'mode'    : '' },
    { 'id'      : 'hot_reindexing_state',
      'description' : 'The state of hot reindexing',
      'type'    : 'string',
      'mode'    : '' },
178 179 180 181
    { 'id'      : 'archive_path',
      'description' : 'The path of the archive which is create',
      'type'    : 'string',
      'mode'    : '' },
182 183

  )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
184

185 186 187 188
  source_sql_catalog_id = None
  destination_sql_catalog_id = None
  hot_reindexing_state = None
  default_sql_catalog_id = None
189
  archive_path = None
190
  
Jean-Paul Smets's avatar
Jean-Paul Smets committed
191
  manage_catalogAddRowForm = DTMLFile('dtml/catalogAddRowForm', globals())
192
  manage_catalogFilter = DTMLFile( 'dtml/catalogFilter', globals() )
Jean-Paul Smets's avatar
Jean-Paul Smets committed
193 194 195 196 197
  manage_catalogView = DTMLFile('dtml/catalogView',globals())
  manage_catalogFind = DTMLFile('dtml/catalogFind',globals())
  manage_catalogSchema = DTMLFile('dtml/catalogSchema', globals())
  manage_catalogIndexes = DTMLFile('dtml/catalogIndexes', globals())
  manage_catalogAdvanced = DTMLFile('dtml/catalogAdvanced', globals())
198
  manage_catalogHotReindexing = DTMLFile('dtml/catalogHotReindexing', globals())
Jean-Paul Smets's avatar
Jean-Paul Smets committed
199 200 201 202 203 204 205 206
  manage_objectInformation = DTMLFile('dtml/catalogObjectInformation',
                                                              globals())

  def __init__(self, id, title='', container=None):
    if container is not None:
      self=self.__of__(container)
    self.id=id
    self.title=title
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

  def getSQLCatalogIdList(self):
    return self.objectIds(spec=('SQLCatalog',))

  def getSQLCatalog(self, id=None, default_value=None):
    """
      Get the default SQL Catalog.
    """
    if id is None:
      if not self.default_sql_catalog_id:
        id_list = self.getSQLCatalogIdList()
        if len(id_list) > 0:
          self.default_sql_catalog_id = id_list[0]
        else:
          return default_value
      id = self.default_sql_catalog_id

224
    return self._getOb(id, default_value)
225 226 227 228

  def manage_catalogExportProperties(self, REQUEST=None, RESPONSE=None, sql_catalog_id=None):
    """
      Export properties to an XML file.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
229
    """
230 231 232
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.manage_exportProperties(REQUEST=REQUEST, RESPONSE=RESPONSE)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
233

234 235 236 237 238 239 240
  def manage_catalogImportProperties(self, file, sql_catalog_id=None):
    """
      Import properties from an XML file.
    """
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.manage_importProperties(file)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
241

242 243 244 245 246 247
  def __len__(self):
    catalog = self.getSQLCatalog()
    if catalog is None:
      return 0
    return len(catalog)

248 249 250 251 252 253 254 255 256
  def getHotReindexingState(self):
    """
      Return the current hot reindexing state.
    """
    value = getattr(self, 'hot_reindexing_state', None)
    if value is None:
      return HOT_REINDEXING_FINISHED_STATE
    return value

257
  def setHotReindexingState(self, state='', source_sql_catalog_id=None, destination_sql_catalog_id=None, archive_path=None):
258 259
    """
      Set the state of hot reindexing.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
260

261 262 263
      Do not use setProperty because the state should not modified from the ZMI directly.
      It must be maintained very carefully.
    """
264
    #LOG("setHotReindexingState call", 300, state)
265 266 267
    if source_sql_catalog_id is None:
      source_sql_catalog_id = self.default_sql_catalog_id

268
    if state == HOT_REINDEXING_FINISHED_STATE:
269 270 271
      self.hot_reindexing_state = None
      self.source_sql_catalog_id = None
      self.destination_sql_catalog_id = None
272
      self.archive_path = None
273 274
    elif state == HOT_REINDEXING_RECORDING_STATE or \
         state == HOT_REINDEXING_DOUBLE_INDEXING_STATE:
275 276 277
      self.hot_reindexing_state = state
      self.source_sql_catalog_id = source_sql_catalog_id
      self.destination_sql_catalog_id = destination_sql_catalog_id
278
      self.archive_path = archive_path
279 280
    else:
      raise CatalogError, 'unknown hot reindexing state %s' % state
Jean-Paul Smets's avatar
Jean-Paul Smets committed
281

282 283 284
  def finishHotReindexing(self, source_sql_catalog_id,
                          destination_sql_catalog_id, skin_selection_dict,
                          sql_connection_id_dict):
285
    """
286
      Exchange databases and finish reindexing in the same transaction.
287
    """
288 289 290 291 292
    if self.archive_path is not None  and \
           getattr(self, "portal_archives", None) is not None:
      current_archive = self.portal_archives.getCurrentArchive()
    else:
      current_archive = None
Aurel's avatar
Aurel committed
293
    default_catalog_id = self.default_sql_catalog_id
294 295 296 297
    self.exchangeDatabases(source_sql_catalog_id=source_sql_catalog_id,
                           destination_sql_catalog_id=destination_sql_catalog_id,
                           skin_selection_dict=skin_selection_dict,
                           sql_connection_id_dict=sql_connection_id_dict)
298 299 300
    # cancel archive use as current catalog before archiving
    if current_archive is not None:
      current_archive.cancel()
301
    self.setHotReindexingState(state=HOT_REINDEXING_FINISHED_STATE)
302
    clearCache(cache_factory_list=('erp5_content_short',))
303

304
  def cancelHotReindexing(self):
305
    """
306 307 308 309 310
      Cancel a hot reindexing.
      Remove the hot reindexing state and flush related activities.

      TODO: Find a safe way to remove activities started by
            ERP5Site_reindexAll.
311
    """
312 313 314 315 316 317 318 319 320 321
    if self.getHotReindexingState() == HOT_REINDEXING_FINISHED_STATE:
      raise Exception, 'cancelHotReindexing called while no Hot Reindexing '\
                       'was runing. Nothing done.'
    # Remove hot reindexing state
    self.setHotReindexingState(HOT_REINDEXING_FINISHED_STATE)
    portal_activities = getToolByName(self, 'portal_activities')
    if portal_activities is not None:
      object_path = self.getPhysicalPath()
      # Activities must be removed in the reverse order they were inserted
      # to make sure removing one does not accidntaly trigger the next one.
322 323
      method_id_list = ('finishHotReindexing', 'runInventoryMethod',
                        'playBackRecordedObjectList', 'InventoryModule_reindexMovementList'
324 325 326 327 328 329 330 331
                        'setHotReindexingState')
      for method_id in method_id_list:
        portal_activities.flush(object_path, method_id=method_id)

  def playBackRecordedObjectList(self, sql_catalog_id, catalog=0):
    """
      Play back the actions scheduled while hot reindexing was in "record"
      state.
332

333 334 335
      sql_catalog_id   Id of the catalog on which the actions will be played.
      catalog          0 : play unindex actions
                       1 : play index actions
336

337 338 339 340 341 342 343 344 345 346 347
      This function schedules itself for later execution.
      This is done in order to avoid accessing "too many" objects in the same
      transaction.
    """
    if self.getHotReindexingState() != HOT_REINDEXING_DOUBLE_INDEXING_STATE:
      raise Exception, 'playBackRecordedObjectList was called while '\
                       'hot_reindexing_state was not "%s". Playback aborted.' \
                       % (HOT_REINDEXING_DOUBLE_INDEXING_STATE, )
    catalog_object = self.getSQLCatalog(sql_catalog_id)
    result = catalog_object.readRecordedObjectList(catalog=catalog)
    if len(result):
348
      for o in result:
349 350 351 352 353 354 355 356 357 358
        if catalog==0:
          self.uncatalog_object(uid=o.path, sql_catalog_id=sql_catalog_id)
        elif catalog==1:
          try:
            obj = self.resolve_path(o.path)
          except ConflictError:
            raise
          except:
            obj = None
          if obj is not None:
359
            obj.reindexObject(sql_catalog_id=sql_catalog_id)
360 361
        else:
          raise ValueError, '%s is not a valid value for "catalog".' % (catalog, )
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
      catalog_object.deleteRecordedObjectList(uid_list=[o.uid for o in result])
      # Re-schedule the same action in case there are remaining rows in the
      # table. This can happen if the database connector limits the number
      # of rows in the result.
      self.activate(passive_commit=1, priority=5).\
          playBackRecordedObjectList(sql_catalog_id=sql_catalog_id,
                                     catalog=catalog)
    else:
      # If there iss nothing to do, go to next step.
      if catalog == 0:
        # If we were replaying unindex actions, time to replay index actions.
        self.activate(passive_commit=1, priority=5).\
            playBackRecordedObjectList(sql_catalog_id=sql_catalog_id,
                                       catalog=1)
      # If we were replaying index actions, there is nothing else to do.
377

378 379 380 381 382 383
  def changeSQLConnectionIds(self, folder, sql_connection_id_dict):
    if sql_connection_id_dict is not None:
      if folder.meta_type == 'Z SQL Method':
        connection_id = folder.connection_id
        if connection_id in sql_connection_id_dict:
          folder.connection_id = sql_connection_id_dict[connection_id]
384
      elif getattr(aq_base(folder), 'objectValues', _marker) is not _marker:
385 386 387
        for object in folder.objectValues():
          self.changeSQLConnectionIds(object,sql_connection_id_dict)

388 389 390 391 392 393 394
  def exchangeDatabases(self, source_sql_catalog_id, destination_sql_catalog_id,
                        skin_selection_dict, sql_connection_id_dict):
    """
      Exchange two databases.
    """
    if self.default_sql_catalog_id == source_sql_catalog_id:
      self.default_sql_catalog_id = destination_sql_catalog_id
395 396 397 398
      # Insert the latest generated uid.
      # This must be done just before swaping the catalogs in case there were
      # generated uids since destination catalog was created.
      self[destination_sql_catalog_id].insertMaxUid()
399

400 401
    LOG('exchangeDatabases skin_selection_dict:',0,skin_selection_dict)
    if skin_selection_dict is not None:
402
      #LOG('exchangeDatabases skin_selection_dict:',0,'we will do manage_skinLayers')
403 404 405 406
      for skin_name, selection in self.portal_skins.getSkinPaths():
        if skin_name in skin_selection_dict:
          new_selection = tuple(skin_selection_dict[skin_name])
          self.portal_skins.manage_skinLayers(skinpath = new_selection, skinname = skin_name, add_skin = 1)
407

408
    LOG('exchangeDatabases sql_connection_id_dict :',0,sql_connection_id_dict)
409
    if sql_connection_id_dict is not None:
410
      self.changeSQLConnectionIds(self.portal_skins, sql_connection_id_dict)
411

412
  def manage_hotReindexAll(self, source_sql_catalog_id,
413
                           destination_sql_catalog_id,
414
                           archive_path=None,
415 416 417 418 419 420
                           source_sql_connection_id_list=None,
                           destination_sql_connection_id_list=None,
                           skin_name_list=None,
                           skin_selection_list=None,
                           update_destination_sql_catalog=None,
                           REQUEST=None, RESPONSE=None):
421
    """
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
      Starts a hot reindexing.

      Hot reindexing will create a catalog and sync it with the current one.
      Once done, both catalogs will be swapped so that current catalog will
      not be used any more and destination catalog will get used "for real".

      source_catalog_id
        Id of the SQLCatalog object to use as the source catalog.
        WARNING: it is not considered normal to specify a catalog which is not
                 the current default one.
                 The feature is still provided, but you'll be on your own if
                 you try it.

      destination_sql_catalog_id 
        Id of the SQLCatalog object to use as the new catalog.

      source_sql_connection_id_list
      destination_sql_connection_id_list
        SQL Methods in portal_skins using source_sql_connection_id_list[n]
        connection will use destination_sql_connection_id_list[n] connection
        once hot reindexing is over.

      skin_name_list
      skin_selection_list
        For each skin_name_list[n], skin_selection_list[n] will be set to
        replace the existing skin selection on portal_skins.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
448
    """
449 450
    # Hot reindexing can only be runing once at a time on a system.
    if self.hot_reindexing_state is not None:
451
      raise CatalogError, 'hot reindexing process is already running %s -%s' %(self, self.hot_reindexing_state)
452 453 454 455 456 457 458 459 460 461 462 463 464

    if source_sql_catalog_id == destination_sql_catalog_id:
      raise CatalogError, 'Hot reindexing cannot be done with the same '\
                          'catalog as both source and destination. What'\
                          ' you want to do is a "clear catalog" and an '\
                          '"ERP5Site_reindexAll".'

    if source_sql_catalog_id != self.default_sql_catalog_id:
      LOG('ZSQLCatalog', 0, 'Warning : Hot reindexing is started with a '\
                            'source catalog which is not the default one.')

    # Construct a mapping for skin selections. It will be used during the
    # final hot reindexing step.
465 466 467 468 469 470 471 472 473 474 475
    skin_selection_dict = None
    if skin_name_list is not None and skin_selection_list is not None:
      skin_selection_dict = {}
      for name, selection_list in zip(skin_name_list, skin_selection_list):
        # Make sure that there is no extra space.
        new_selection_list = []
        for selection in selection_list:
          new_selection = selection.strip()
          if len(new_selection) > 0:
            new_selection_list.append(new_selection)
        skin_selection_dict[name] = new_selection_list
476

477 478
    # Construct a mapping for connection ids. It will be used during the
    # final hot reindexing step.
479
    sql_connection_id_dict = None
480 481
    if source_sql_connection_id_list is not None and \
       destination_sql_connection_id_list is not None:
482
      sql_connection_id_dict = {}
483 484 485
      for source_sql_connection_id, destination_sql_connection_id in \
          zip(source_sql_connection_id_list,
              destination_sql_connection_id_list):
486
        if source_sql_connection_id != destination_sql_connection_id:
487 488
          sql_connection_id_dict[source_sql_connection_id] = \
              destination_sql_connection_id
489

490 491 492 493 494
    destination_sql_catalog = getattr(self,destination_sql_catalog_id)
    if update_destination_sql_catalog:
      self.changeSQLConnectionIds(destination_sql_catalog,
                                  sql_connection_id_dict)

495 496
    # First of all, make sure that all root objects have uids.
    # XXX This is a workaround for tools (such as portal_simulation).
497 498
    portal = self.getPortalObject()
    for id in portal.objectIds():
499
      getUid = getattr(portal[id], 'getUid', None)
500 501
      if getUid is not None and id != "portal_uidhandler":
        # XXX check adviced by yo, getUid is different for this tool
502 503 504 505 506 507 508
        getUid() # Trigger the uid generation if none is set.

    # Mark the hot reindex as begun. Each object indexed in the still-current
    # catalog will be scheduled for reindex in the future catalog.
    LOG('hotReindexObjectList', 0, 'Starting recording')
    self.setHotReindexingState(HOT_REINDEXING_RECORDING_STATE,
                               source_sql_catalog_id=source_sql_catalog_id,
509
                               destination_sql_catalog_id=destination_sql_catalog_id,
510
                               archive_path=archive_path)
511 512
    # Clear the future catalog and start reindexing the site in it.
    final_activity_tag = 'hot_reindex_last_ERP5Site_reindexAll_tag'
513
    self.ERP5Site_reindexAll(sql_catalog_id=destination_sql_catalog_id,
514 515 516 517 518 519 520 521 522
                             final_activity_tag=final_activity_tag,
                             clear_catalog=1,
                             passive_commit=1)
    # Once reindexing is finished, change the hot reindexing state so that
    # new catalog changes are applied in both catalogs.
    self.activate(passive_commit=1,
                  after_tag=final_activity_tag,
                  priority=5).setHotReindexingState(HOT_REINDEXING_DOUBLE_INDEXING_STATE,
                      source_sql_catalog_id=source_sql_catalog_id,
523 524
                      destination_sql_catalog_id=destination_sql_catalog_id,
                      archive_path=archive_path)
525 526 527 528 529 530 531 532
    # Once in double-indexing mode, planned reindex can be replayed.
    self.activate(passive_commit=1,
                  after_method_id='setHotReindexingState',
                  priority=5).playBackRecordedObjectList(
                      sql_catalog_id=destination_sql_catalog_id)
    # Once there is nothing to replay, databases are sync'ed, so the new
    # catalog can become current.
    self.activate(passive_commit=1,
533 534 535
                  after_method_id=('playBackRecordedObjectList',
                                   'InventoryModule_reindexMovementList'),
                  after_tag='InventoryModule_reindexMovementList',
536 537 538 539 540
                  priority=5).finishHotReindexing(
                      source_sql_catalog_id=source_sql_catalog_id,
                      destination_sql_catalog_id=destination_sql_catalog_id,
                      skin_selection_dict=skin_selection_dict,
                      sql_connection_id_dict=sql_connection_id_dict)
541 542
    if RESPONSE is not None:
      URL1 = REQUEST.get('URL1')
543
      RESPONSE.redirect(URL1 + '/manage_catalogHotReindexing?manage_tabs_message=HotReindexing%20Started')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
544 545 546 547 548 549 550 551 552 553

  def manage_edit(self, RESPONSE, URL1, threshold=1000, REQUEST=None):
    """ edit the catalog """
    if type(threshold) is not type(1):
      threshold=string.atoi(threshold)
    self.threshold = threshold

    RESPONSE.redirect(URL1 + '/manage_main?manage_tabs_message=Catalog%20Changed')


554
  def manage_catalogObject(self, REQUEST, RESPONSE, URL1, urls=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
555
    """ index Zope object(s) that 'urls' point to """
556 557
    if sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
558

559 560 561
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_catalogObject(REQUEST, RESPONSE, URL1, urls=urls)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
562 563


564
  def manage_uncatalogObject(self, REQUEST, RESPONSE, URL1, urls=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
565
    """ removes Zope object(s) 'urls' from catalog """
566 567
    if sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
568

569 570 571
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_uncatalogObject(REQUEST, RESPONSE, URL1, urls=urls)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
572 573


574
  def manage_catalogReindex(self, REQUEST, RESPONSE, URL1, urls=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
575
    """ clear the catalog, then re-index everything """
576 577
    if sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
578

579 580 581
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_catalogReindex(REQUEST, RESPONSE, URL1, urls=urls)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
582

583
  def refreshCatalog(self, clear=0, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
584 585
    """ re-index everything we can find """

586 587 588 589 590
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      paths = catalog.getPaths()
      if clear:
        catalog.clear()
Jean-Paul Smets's avatar
Jean-Paul Smets committed
591

592 593 594 595 596 597
      for p in paths:
        obj = self.resolve_path(p.path)
        if not obj:
          obj = self.resolve_url(p.path, self.REQUEST)
        if obj is not None:
          self.catalog_object(obj, p.path, sql_catalog_id=sql_catalog_id)
598

599
  def manage_catalogClear(self, REQUEST=None, RESPONSE=None, URL1=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
600
    """ clears the whole enchilada """
601 602
    if REQUEST is not None and sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
603

604 605 606
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_catalogClear(REQUEST=REQUEST, RESPONSE=RESPONSE, URL1=URL1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
607

608
  def manage_catalogClearReserved(self, REQUEST=None, RESPONSE=None, URL1=None, sql_catalog_id=None):
609
    """ clears the whole enchilada """
610 611
    if REQUEST is not None and sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
612

613 614 615
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_catalogClearReserved(REQUEST=REQUEST, RESPONSE=RESPONSE, URL1=URL1)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
616 617 618 619 620 621

  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,
622 623
                 obj_permission=None,
                 sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
624 625
    """ Find object according to search criteria and Catalog them
    """
626 627 628 629 630 631 632 633 634 635
    if sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)

    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_catalogFoundItems(REQUEST, RESPONSE, URL2, URL1,
                                       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_roles=obj_roles, obj_permission=obj_permission)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656

    elapse = time.time()
    c_elapse = time.clock()

    words = 0
    obj = REQUEST.PARENTS[1]
    path = string.join(obj.getPhysicalPath(), '/')


    results = self.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.catalog_object,
657 658
                    apply_path=path,
                    sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
659 660 661 662 663 664 665

    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`)))

666
  def manage_editSchema(self, names, REQUEST=None, RESPONSE=None, URL1=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
667
    """ add a column """
668 669 670 671
    if REQUEST is not None and sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)

    self.editSchema(names, sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
672 673 674 675

    if REQUEST and RESPONSE:
      RESPONSE.redirect(URL1 + '/manage_catalogSchema?manage_tabs_message=Schema%20Saved')

676
  def newUid(self, sql_catalog_id=None):
677 678 679
    """
        Allocates a new uid value.
    """
680 681 682
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.newUid()
683

684 685 686 687 688 689
  def getDynamicRelatedKeyList(self, sql_catalog_id=None,**kw):
    """
    Return the list of dynamic related keys.
    """
    return []

690 691 692 693 694 695
  def wrapObject(self, object, **kw):
    """
      Return a wrapped object for reindexing.

      This method should be overridden if necessary.
    """
696
    #LOG('ZSQLCatalog wrapObject', 0, 'object = %r, kw = %r' % (object, kw))
697 698
    return object

699
  def catalog_object(self, obj, url=None, idxs=[], is_object_moved=0, sql_catalog_id=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
700
    """ wrapper around catalog """
701
    self.catalogObjectList([obj], sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
702

703 704
  def catalogObjectList(self, object_list, sql_catalog_id=None, disable_archive=0,
                        immediate_reindex_archive=1, **kw):
705 706
    """Catalog a list of objects.
    """
707
    catalog = self.getSQLCatalog(sql_catalog_id)
708
    default_catalog = self.getSQLCatalog()
709 710 711
    hot_reindexing = (self.hot_reindexing_state is not None) and \
                     (catalog is not None) and \
                     (self.source_sql_catalog_id == catalog.id)
712
    archiving = self.archive_path is not None
713
    wrapped_object_list = []
714
    failed_object_list = []
715
    url_list = []
716
    archive_list = []
717
    if getattr(self, "portal_archives", None) is not None:
718 719
      if len(self.portal_archives):
        archive_list = self.portal_archives.getArchiveList()
720 721 722

    catalog_dict = {}

Aurel's avatar
Aurel committed
723
    # Create archive object list if necessary
724
    if archiving:
725
      # while archiving only test with the archive we used, do not care
Aurel's avatar
Aurel committed
726
      # of other as they must already be ok
727 728
      archive = self.unrestrictedTraverse(self.archive_path)
      archive_obj_list = [archive,]
729 730 731 732 733 734 735 736
      for archive_path in archive_list:
        try:
          archive = self.unrestrictedTraverse(archive_path)
        except KeyError:
          continue
        if archive.getCatalogId() == self.destination_sql_catalog_id:
          archive_obj_list.append(archive)
    else:
Aurel's avatar
Aurel committed
737
      # otherwise take all archive in use to know where object must go
738 739 740 741 742 743 744
      archive_obj_list = []
      for archive_path in archive_list:
        try:
          archive = self.unrestrictedTraverse(archive_path)
        except KeyError:
          continue
        archive_obj_list.append(archive)
745
    # Construct list of object to catalogged
746 747 748 749 750 751 752 753 754
    for obj in object_list:
      if hot_reindexing:
        try: 
          url = obj.getPhysicalPath
        except AttributeError:
          raise CatalogError(
            "A cataloged object must support the 'getPhysicalPath' "
            "method if no unique id is provided when cataloging"
            )
755
        url = '/'.join(url())
756
        url_list.append(url)
757 758
        
      goto_current_catalog = 0
759
      # either we are doing archiving, either we have used archive without a catalog specified
Aurel's avatar
Aurel committed
760
      if (not disable_archive) and (archiving or (len(archive_obj_list) > 0 and sql_catalog_id is None)):
761
        # check in which archive object must go if we defined archive
762 763 764 765
        catalog_id = None
        for archive in archive_obj_list:
          if archive.test(obj) is True:
            catalog_id = archive.getCatalogId()
766 767 768 769
            # if current catalog, no need to construct dict as it will be reindex now
            if catalog_id in (default_catalog.id, self.source_sql_catalog_id):
              goto_current_catalog = 1
              continue
770 771 772 773 774
            priority = archive.getPriority()
            if catalog_dict.has_key(catalog_id):
              catalog_dict[catalog_id]['obj'].append(obj)
            else:
              catalog_dict[catalog_id] = {'priority' : priority, 'obj' : [obj,]}
Aurel's avatar
Aurel committed
775
        if catalog_id is None and not archiving:
776
          # at least put object in current catalog if no archive match
Aurel's avatar
Aurel committed
777
          # and not doing archive
778
          goto_current_catalog = 1
779
      else:
780
        goto_current_catalog = 1
781

782
      if goto_current_catalog:
783 784 785 786
        try:
          # wrap object only when sure it will be reindex now
          # thus security uid is also reindex
          wrap_obj = self.wrapObject(obj, sql_catalog_id=sql_catalog_id)
787
          wrapped_object_list.append(wrap_obj)
788 789 790
        except ConflictError:
          raise
        except:
791
          raise
792
          LOG('WARNING ZSQLCatalog', 0, 'wrapObject failed on the object %r' % (obj,), error=sys.exc_info())
793
          failed_object_list.append(obj) # XXX Strange JPS - why LOG and keep on ?? wrap_obj not defined
794

795 796 797
    # run activity or execute for each archive depending on priority
    if len(catalog_dict):
      for catalog_id in catalog_dict.keys():
798 799 800
        if goto_current_catalog and catalog_id == default_catalog.id:
          # if we reindex in current catalog, do not relaunch an activity for this
          continue
801
        d = catalog_dict[catalog_id]
802 803 804 805 806
        # build the wrapped object list
        wrapped_object_list_2 = []
        for obj in d['obj']:
          try:
            wrap_obj = self.wrapObject(obj, sql_catalog_id=catalog_id)
807
            wrapped_object_list_2.append(wrap_obj)
808 809 810 811 812 813
          except ConflictError:
            raise
          except:
            LOG('WARNING ZSQLCatalog', 0, 'wrapObject failed on the object %r' % (obj,), error=sys.exc_info())
            failed_object_list.append(obj)

814 815 816
        # hot_reindexing is True when creating an object during a hot reindex, in this case, we don't want
        # to reindex it in destination catalog, it will be recorded an play only once
        if not hot_reindexing and self.hot_reindexing_state != HOT_REINDEXING_DOUBLE_INDEXING_STATE and \
817
               self.destination_sql_catalog_id == catalog_id:
818 819 820 821
          destination_catalog = self.getSQLCatalog(self.destination_sql_catalog_id)
          # reindex objects in destination catalog
          destination_catalog.catalogObjectList(wrapped_object_list_2, **kw)
        else:
822 823 824 825 826 827 828
          archive_catalog = self.getSQLCatalog(catalog_id)
          if immediate_reindex_archive:
            archive_catalog.catalogObjectList(wrapped_object_list_2, **kw)
          else:
            for obj in d['obj']:
              obj._reindexObject(sql_catalog_id=catalog_id, activate_kw = \
                                 {'priority': d['priority']}, disable_archive=1, **kw)
829
    
830
    if catalog is not None:
831 832
      if len(wrapped_object_list):
        catalog.catalogObjectList(wrapped_object_list, **kw)
833
      if hot_reindexing:
834
        destination_catalog = self.getSQLCatalog(self.destination_sql_catalog_id)
835
        if destination_catalog.id != catalog.id:
836
          if self.hot_reindexing_state == HOT_REINDEXING_RECORDING_STATE:
837 838
            destination_catalog.recordObjectList(url_list, 1)
          else:
839 840 841
            if len(wrapped_object_list):
              destination_catalog.catalogObjectList(wrapped_object_list,**kw)

842 843
    object_list[:] = failed_object_list[:]
          
844

845
  def uncatalog_object(self, uid=None,path=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
846
    """ wrapper around catalog """
847 848
    if uid is None:
      raise TypeError, "sorry uncatalog_object supports only uid"
849
    default_catalog = self.getSQLCatalog()
850

851 852 853 854 855
    if sql_catalog_id is None:
      archive_list = []
      if getattr(self, "portal_archives", None) is not None:
        if len(self.portal_archives):
          archive_list = self.portal_archives.getArchiveList()
856

857 858 859 860 861 862 863 864 865 866 867 868 869
      if len(archive_list):
        for archive_path in archive_list:
          try:
            archive = self.unrestrictedTraverse(archive_path)
          except KeyError:
            continue
          catalog_id = archive.getCatalogId()
          if catalog_id != default_catalog.id:
            # only launch activity when not in current catalog
            self.activate(activity="SQLQueue", round_robin_scheduling=1,
                          priority=archive.getPriority()).uncatalog_object(uid=uid,path=path,
                                                                           sql_catalog_id=catalog_id)
          
870
    catalog = self.getSQLCatalog(sql_catalog_id)
871
    if catalog is not None:
872
      catalog.uncatalogObject(uid=uid,path=path)
873 874 875
      if self.hot_reindexing_state is not None and self.source_sql_catalog_id == catalog.id:
        destination_catalog = self.getSQLCatalog(self.destination_sql_catalog_id)
        if destination_catalog.id != catalog.id:
876
          if self.hot_reindexing_state == HOT_REINDEXING_RECORDING_STATE:
877 878
            destination_catalog.recordObjectList([uid], 0)
          else:
879
            destination_catalog.uncatalogObject(uid=uid)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
880

881

882 883 884 885 886 887
  def beforeUncatalogObject(self, uid=None,path=None, sql_catalog_id=None):
    """ wrapper around catalog """
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.beforeUncatalogObject(uid=uid,path=path)

888 889 890 891
  def beforeCatalogClear(self):
    """ allow to override this method """
    pass

892 893 894 895 896 897 898 899 900 901 902 903 904 905
  def catalogTranslationList(self, object_list, sql_catalog_id=None):
    """Catalog translations.
    """
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.catalogTranslationList(object_list)

  def deleteTranslationList(self, sql_catalog_id=None):
    """Delete translations.
    """
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.deleteTranslationList()

906
  def uniqueValuesFor(self, name, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
907
    """ returns the unique values for a given FieldIndex """
908 909 910
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.uniqueValuesFor(name)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
911

912 913 914
    return ()

  def getpath(self, uid, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
915 916 917
    """
    Return the path to a cataloged object given its uid
    """
918 919 920
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      object = catalog[uid]
921
      if object is not None:
922 923 924
        return object.path
      else:
        return None
Jean-Paul Smets's avatar
Jean-Paul Smets committed
925 926
  getPath = getpath

927
  def hasPath(self, path, sql_catalog_id=None):
Sebastien Robin's avatar
Sebastien Robin committed
928
    """
929
    Checks if path is catalogued
Sebastien Robin's avatar
Sebastien Robin committed
930
    """
931 932 933
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.hasPath(path)
Sebastien Robin's avatar
Sebastien Robin committed
934

935
  def getobject(self, uid, REQUEST=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
936 937 938
    """
    Return a cataloged object given its uid
    """
939 940 941
    if REQUEST is not None and sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)

942 943
    path = self.getpath(uid, sql_catalog_id=sql_catalog_id)
    obj = self.aq_parent.unrestrictedTraverse(path)
944
    if obj is None:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
945 946
      if REQUEST is None:
        REQUEST=self.REQUEST
947
      obj = self.resolve_url(path, REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
948 949 950
    return obj
  getObject = getobject

951
  def getObjectList(self, uid_list, REQUEST=None, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
952 953 954 955 956
    """
    Return a cataloged object given its uid
    """
    obj_list = []
    for uid in uid_list:
957
      obj_list.append(self.getObject(uid, REQUEST, sql_catalog_id=sql_catalog_id))
Jean-Paul Smets's avatar
Jean-Paul Smets committed
958 959
    return obj_list

960
  def getMetadataForUid(self, rid, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
961
    """return the correct metadata for the cataloged uid"""
962 963 964 965
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getMetadataForUid(int(rid))
    return {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
966

967
  def getIndexDataForUid(self, rid, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
968
    """return the current index contents for the specific uid"""
969 970 971 972
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getIndexDataForUid(rid)
    return {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
973 974 975 976 977

  # Aliases
  getMetadataForRID = getMetadataForUid
  getIndexDataForRID = getIndexDataForUid

978 979
  def schema(self, sql_catalog_id=None):
    return self.getColumnIds(sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
980

981 982
  def indexes(self, sql_catalog_id=None):
    return self.getColumnIds(sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
983

984 985 986 987 988
  def names(self, sql_catalog_id=None):
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.names
    return {}
Jean-Paul Smets's avatar
Jean-Paul Smets committed
989

990 991 992 993 994
  def getColumnIds(self, sql_catalog_id=None):
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getColumnIds()
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
995

996
  def getAttributesForColumn(self, column, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
997 998 999
    """
      Return the attribute names as a single string
    """
1000
    return string.join(self.names(sql_catalog_id=sql_catalog_id).get(column, ('',)),' ')
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1001

1002 1003 1004 1005 1006
  def _searchable_arguments(self, sql_catalog_id=None):
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getColumnIds(sql_catalog_id=sql_catalog_id)
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1007

1008 1009 1010 1011
  def editSchema(self,names, sql_catalog_id=None):
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.editSchema(names)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1012

1013
  def _searchable_result_columns(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1014
    r = []
1015 1016 1017 1018 1019 1020 1021 1022 1023
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      for name in catalog.getColumnIds():
        i = {}
        i['name'] = name
        i['type'] = 's'
        i['parser'] = str
        i['width'] = 8
        r.append(i)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1024 1025 1026 1027 1028 1029
    r.append({'name': 'data_record_id_',
          'type': 's',
          'parser': str,
          'width': 8})
    return r

1030
  security.declarePublic('buildSQLQuery')
1031
  def buildSQLQuery(self, REQUEST=None, query_table='catalog', sql_catalog_id=None, **kw):
1032 1033 1034 1035
    """
      Build a SQL query from keywords.
      If query_table is specified, it is used as the table name instead of 'catalog'.
    """
1036 1037 1038 1039
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.buildSQLQuery(REQUEST=REQUEST, query_table=query_table, **kw)
    return ''
1040

1041 1042 1043 1044
  # Compatibility SQL Sql
  security.declarePublic('buildSqlQuery')
  buildSqlQuery = buildSQLQuery

1045
  def searchResults(self, REQUEST=None, sql_catalog_id=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1046 1047 1048 1049 1050
    """
    Search the catalog according to the ZTables search interface.
    Search terms can be passed in the REQUEST or as keyword
    arguments.
    """
1051 1052
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
1053
      return apply(catalog.searchResults, (REQUEST, ), kw)
1054
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1055 1056 1057

  __call__=searchResults

1058
  def countResults(self, REQUEST=None, sql_catalog_id=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1059 1060 1061
    """
    Counts the number of items which satisfy the query defined in kw.
    """
1062 1063
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
1064
      return apply(catalog.countResults, (REQUEST, ), kw)
1065
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

## this stuff is so the find machinery works

  meta_types=() # Sub-object types that are specific to this object

  def valid_roles(self):
    "Return list of valid roles"
    obj=self
    dict={}
    dup =dict.has_key
    x=0
    while x < 100:
      if hasattr(obj, '__ac_roles__'):
        roles=obj.__ac_roles__
        for role in roles:
          if not dup(role):
            dict[role]=1
      if not hasattr(obj, 'aq_parent'):
        break
      obj=obj.aq_parent
      x=x+1
    roles=dict.keys()
    roles.sort()
    return roles

  def ZopeFindAndApply(self, obj, obj_ids=None, obj_metatypes=None,
             obj_searchterm=None, obj_expr=None,
             obj_mtime=None, obj_mspec=None,
             obj_permission=None, obj_roles=None,
             search_sub=0,
             REQUEST=None, result=None, pre='',
1097 1098
             apply_func=None, apply_path='',
             sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
    """Zope Find interface and apply

    This is a *great* hack.  Zope find just doesn't do what we
    need here; the ability to apply a method to all the objects
    *as they're found* and the need to pass the object's path into
    that method.

    """

    if result is None:
      result=[]

      if obj_metatypes and 'all' in obj_metatypes:
        obj_metatypes=None

      if obj_mtime and type(obj_mtime)==type('s'):
        obj_mtime=DateTime(obj_mtime).timeTime()

      if obj_permission:
        obj_permission=p_name(obj_permission)

      if obj_roles and type(obj_roles) is type('s'):
        obj_roles=[obj_roles]

      if obj_expr:
        # Setup expr machinations
        md=td()
        obj_expr=(Eval(obj_expr), md, md._push, md._pop)

    base=obj
    if hasattr(obj, 'aq_base'):
      base=obj.aq_base

    if not hasattr(base, 'objectItems'):
      return result
    try:  items=obj.objectItems()
    except: return result

    try: add_result=result.append
1138
    except AttributeError:
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1139 1140 1141 1142 1143
      raise AttributeError, `result`

    for id, ob in items:
      if pre: p="%s/%s" % (pre, id)
      else:   p=id
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1144

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
      dflag=0
      if hasattr(ob, '_p_changed') and (ob._p_changed == None):
        dflag=1

      if hasattr(ob, 'aq_base'):
        bs=ob.aq_base
      else: bs=ob

      if (
        (not obj_ids or absattr(bs.id) in obj_ids)
        and
        (not obj_metatypes or (hasattr(bs, 'meta_type') and
         bs.meta_type in obj_metatypes))
        and
        (not obj_searchterm or
         (hasattr(ob, 'PrincipiaSearchSource') and
          string.find(ob.PrincipiaSearchSource(), obj_searchterm) >= 0
          ))
        and
        (not obj_expr or expr_match(ob, obj_expr))
        and
        (not obj_mtime or mtime_match(ob, obj_mtime, obj_mspec))
        and
        ( (not obj_permission or not obj_roles) or \
           role_match(ob, obj_permission, obj_roles)
        )
        ):
        if apply_func:
1173
          apply_func(ob, (apply_path+'/'+p), sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
        else:
          add_result((p, ob))
          dflag=0

      if search_sub and hasattr(bs, 'objectItems'):
        self.ZopeFindAndApply(ob, obj_ids, obj_metatypes,
                    obj_searchterm, obj_expr,
                    obj_mtime, obj_mspec,
                    obj_permission, obj_roles,
                    search_sub,
                    REQUEST, result, p,
1185 1186
                    apply_func, apply_path,
                    sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
      if dflag: ob._p_deactivate()

    return result

  def resolve_url(self, path, REQUEST):
    """
    Attempt to resolve a url into an object in the Zope
    namespace. The url may be absolute or a catalog path
    style url. If no object is found, None is returned.
    No exceptions are raised.
    """
    script=REQUEST.script
    if string.find(path, script) != 0:
      path='%s/%s' % (script, path)
1201 1202 1203 1204 1205 1206
    try: 
      return REQUEST.resolve_url(path)
    except ConflictError: 
      raise
    except: 
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1207 1208 1209 1210 1211 1212 1213 1214

  def resolve_path(self, path):
    """
    Attempt to resolve a url into an object in the Zope
    namespace. The url may be absolute or a catalog path
    style url. If no object is found, None is returned.
    No exceptions are raised.
    """
1215 1216 1217 1218 1219 1220
    try: 
      return self.unrestrictedTraverse(path)
    except ConflictError:
      raise
    except: 
      pass
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1221

1222
  def manage_normalize_paths(self, REQUEST, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1223 1224 1225 1226 1227
    """Ensure that all catalog paths are full physical paths

    This should only be used with ZCatalogs in which all paths can
    be resolved with unrestrictedTraverse."""

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
    if sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)

    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      paths = catalog.paths
      uids = catalog.uids
      unchanged = 0
      fixed = []
      removed = []

      for path, rid in uids.items():
        ob = None
        if path[:1] == '/':
          ob = self.resolve_url(path[1:],REQUEST)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1243
        if ob is None:
1244 1245 1246 1247 1248 1249 1250 1251 1252
          ob = self.resolve_url(path, REQUEST)
          if ob is None:
            removed.append(path)
            continue
        ppath = string.join(ob.getPhysicalPath(), '/')
        if path != ppath:
          fixed.append((path, ppath))
        else:
          unchanged = unchanged + 1
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1253

1254 1255 1256 1257 1258 1259 1260
      for path, ppath in fixed:
        rid = uids[path]
        del uids[path]
        paths[rid] = ppath
        uids[ppath] = rid
      for path in removed:
        self.uncatalog_object(path, sql_catalog_id=sql_catalog_id)
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1261 1262 1263 1264 1265 1266

    return MessageDialog(title='Done Normalizing Paths',
      message='%s paths normalized, %s paths removed, and '
          '%s unchanged.' % (len(fixed), len(removed), unchanged),
      action='./manage_main')

1267
  def getTableIds(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1268 1269
    """Returns all tables of this catalog
    """
1270 1271 1272 1273
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getTableIds()
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1274

1275
  def getCatalogSearchResultKeys(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1276 1277 1278
    """Return selected tables of catalog which are used in JOIN.
       catalaog is always first
    """
1279 1280 1281 1282
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.sql_search_result_keys
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1283

1284
  def getCatalogSearchTableIds(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1285 1286 1287
    """Return selected tables of catalog which are used in JOIN.
       catalaog is always first
    """
1288 1289 1290 1291
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getCatalogSearchTableIds()
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1292

1293
  def getResultColumnIds(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1294 1295 1296
    """Return selected tables of catalog which are used
       as metadata
    """
1297 1298 1299 1300
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getResultColumnIds()
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1301

1302
  def getCatalogMethodIds(self, sql_catalog_id=None):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1303 1304 1305
    """Find Z SQL methods in the current folder and above
    This function return a list of ids.
    """
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getCatalogMethodIds()
    return {}

  def manage_editFilter(self, REQUEST=None, RESPONSE=None, URL1=None, sql_catalog_id=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 REQUEST is not None and sql_catalog_id is None:
      sql_catalog_id = REQUEST.get('sql_catalog_id', None)

    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      catalog.manage_editFilter(REQUEST=REQUEST, RESPONSE=RESPONSE, URL1=URL1)

  def getFilterableMethodList(self, sql_catalog_id=None):
    """
    Returns only zsql methods wich catalog or uncatalog objets
    """
    catalog = self.getSQLCatalog(sql_catalog_id)
    if catalog is not None:
      return catalog.getFilterableMethodList()
    return []
Jean-Paul Smets's avatar
Jean-Paul Smets committed
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363


Globals.default__class_init__(ZCatalog)


def p_name(name):
  return '_' + string.translate(name, name_trans) + '_Permission'

def absattr(attr):
  if callable(attr): return attr()
  return attr


class td(RestrictedDTML, TemplateDict):
  pass

def expr_match(ob, ed, c=InstanceDict, r=0):
  e, md, push, pop=ed
  push(c(ob, md))
  try: r=e.eval(md)
  finally:
    pop()
    return r

def mtime_match(ob, t, q, fn=hasattr):
  if not fn(ob, '_p_mtime'):
    return 0
  return q=='<' and (ob._p_mtime < t) or (ob._p_mtime > t)

def role_match(ob, permission, roles, lt=type([]), tt=type(())):
  pr=[]
  fn=pr.append
1364

Jean-Paul Smets's avatar
Jean-Paul Smets committed
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
  while 1:
    if hasattr(ob, permission):
      p=getattr(ob, permission)
      if type(p) is lt:
        map(fn, p)
        if hasattr(ob, 'aq_parent'):
          ob=ob.aq_parent
          continue
        break
      if type(p) is tt:
        map(fn, p)
        break
      if p is None:
        map(fn, ('Manager', 'Anonymous'))
        break

    if hasattr(ob, 'aq_parent'):
      ob=ob.aq_parent
      continue
    break

  for role in roles:
    if not (role in pr):
      return 0
  return 1