1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
##############################################################################
#
# 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
from string import lower, split, join
from thread import get_ident
from DateTime import DateTime
from Products.PluginIndexes.common.randid import randid
from Products.CMFCore.Expression import Expression
from Acquisition import aq_parent, aq_inner, aq_base, aq_self
from zLOG import LOG
import time
import sys
UID_BUFFER_SIZE = 900
MAX_UID_BUFFER_SIZE = 20000
class Catalog(Persistent, Acquisition.Implicit, ExtensionClass.Base):
""" An Object Catalog
An Object Catalog maintains a table of object metadata, and a
series of manageable indexes to quickly search for objects
(references in the metadata) that satisfy a search query.
This class is not Zope specific, and can be used in any python
program to build catalogs of objects. Note that it does require
the objects to be Persistent, and thus must be used with ZODB3.
uid -> the (local) universal ID of objects
path -> the (local) path of objects
bgrain defined in meyhods...
TODO:
- optmization: indexing objects should be deferred
until timeout value or end of transaction
"""
_after_clear_reserved = 0
def __init__(self):
self.schema = {} # mapping from attribute name to column
self.names = {} # mapping from column to attribute name
self.indexes = {} # empty mapping
def clear(self):
"""
Clears the catalog by calling a list of methods
"""
methods = self.sql_clear_catalog
for method_name in methods:
method = getattr(self,method_name)
try:
method()
except:
pass
self._after_clear_reserved = 1
def clearReserved(self):
"""
Clears reserved uids
"""
method_id = self.sql_catalog_clear_reserved
method = getattr(self, method_id)
method()
self._after_clear_reserved = 1
def __getitem__(self, uid):
"""
Get an object by UID
Note: brain is defined in Z SQL Method object
"""
method = getattr(self, self.sql_getitem_by_uid)
search_result = method(uid = uid)
if len(search_result) > 0:
return search_result[0]
else:
return None
def editSchema(self, names_list):
"""
Builds a schema from a list of strings
Splits each string to build a list of attribute names
Columns on the database should not change during this operations
"""
i = 0
schema = {}
names = {}
for cid in self.getColumnIds():
name_list = []
for name in names_list[i].split():
schema[name] = cid
name_list += [name,]
names[cid] = tuple(name_list)
i += 1
self.schema = schema
self.names = names
def getColumnIds(self):
"""
Calls the show column method and returns dictionnary of
Field Ids
"""
method_name = self.sql_catalog_schema
keys = {}
for table in self.getCatalogSearchTableIds():
try:
method = getattr(self, method_name)
search_result = method(table=table)
for c in search_result:
keys[c.Field] = 1
keys['%s.%s' % (table, c.Field)] = 1 # Is this inconsistent ?
except:
pass
keys = keys.keys()
keys.sort()
return keys
def getResultColumnIds(self):
"""
Calls the show column method and returns dictionnary of
Field Ids
"""
method_name = self.sql_catalog_schema
keys = {}
for table in self.getCatalogSearchTableIds():
try:
method = getattr(self, method_name)
search_result = method(table=table)
for c in search_result:
keys['%s.%s' % (table, c.Field)] = 1
except:
pass
keys = keys.keys()
keys.sort()
return keys
def getTableIds(self):
"""
Calls the show table method and returns dictionnary of
Field Ids
"""
keys = []
method_name = self.sql_catalog_tables
try:
method = getattr(self, method_name)
search_result = method()
for c in search_result:
keys.append(c[0])
except:
pass
return keys
# the cataloging API
def produceUid(self):
"""
Produces reserved uids in advance
"""
method_id = self.sql_catalog_produce_reserved
method = getattr(self, method_id)
thread_id = get_ident()
uid_list = getattr(self, '_v_uid_buffer', [])
if self._after_clear_reserved:
# Reset uid list after clear reserved
self._after_clear_reserved = 0
uid_list = []
if len(uid_list) < UID_BUFFER_SIZE:
date = DateTime()
new_uid_list = method(count = UID_BUFFER_SIZE, thread_id=thread_id, date=date)
uid_list.extend( filter(lambda x: x != 0, map(lambda x: x.uid, new_uid_list )))
self._v_uid_buffer = uid_list
def newUid(self):
"""
This is where uid generation takes place. We should consider a multi-threaded environment
with multiple ZEO clients on a single ZEO server.
The main risk is the following:
- objects a/b/c/d/e/f are created (a is parent of b which is parent of ... of f)
- one reindexing node N1 starts reindexing f
- another reindexing node N2 starts reindexing e
- 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
Similar problems may happen with relations and acquisition of uid values (ex. order_uid)
with the risk of graph loops
"""
self.produceUid()
uid_list = getattr(self, '_v_uid_buffer', [])
if len(uid_list) > 0:
return uid_list.pop()
else:
raise CatalogError("Could not retrieve new uid")
def catalogObject(self, object, path, is_object_moved=0):
"""
Adds an object to the Catalog by calling
all SQL methods and providing needed arguments.
'object' is the object to be cataloged
'uid' is the unique Catalog identifier for this object
"""
LOG('Catalog object:',0,str(path))
# Prepare the dictionnary of values
kw = {}
# Check if already Catalogued
if hasattr(object, 'uid'):
# Try to use existing uid
# WARNING COPY PASTE....
uid = object.uid
else:
# Look up in (previous) path
uid = 0
if is_object_moved:
index = uid # We trust the current uid
else:
index = self.getUidForPath(path)
if index:
if (uid != index):
# Update uid attribute of object
uid = int(index)
LOG("Write Uid",0, "uid %s index %s" % (uid, index))
object.uid = uid
# We will check if there is an filter on this
# method, if so we may not call this zsqlMethod
# for this object
for method_name in self.sql_update_object:
if self.isMethodFiltered(method_name):
if self.filter_dict.has_key(method_name):
portal_type = object.getPortalType()
if portal_type not in (self.filter_dict[method_name]['type']):
LOG('catalog_object',0,'XX1 this method is broken because not in types: %s' % method_name)
continue
else:
expression = self.filter_dict[method_name]['expression_instance']
if expression is not None:
econtext = self.getExpressionContext(object)
result = expression(econtext)
if not result:
#LOG('catalog_object',0,'XX2 this method is broken because expression: %s' % method_name)
continue
LOG('catalog_object',0,'this method is not broken: %s' % method_name)
# Get the appropriate SQL Method
# Lookup by path is required because of OFS Semantics
method = getattr(self, method_name)
if method.meta_type == "Z SQL Method":
# Build the dictionnary of values
arguments = method.arguments_src
for arg in split(arguments):
try:
value = getattr(object, arg)
if callable(value):
value = value()
kw[arg] = value
except:
#LOG("SQLCatalog Warning: Callable value could not be called",0,str((path, arg, method_name)))
kw[arg] = None
method = aq_base(method).__of__(object.__of__(self)) # Use method in the context of object
# Generate UID
kw['path'] = path
kw['uid'] = int(index)
kw['insert_catalog_line'] = 0
LOG("SQLCatalog Warning: insert_catalog_line, case1 value",0,0)
# LOG
# LOG("Call SQL Method %s with args:" % method_name,0, str(kw))
# Alter row
LOG("Call SQL Method %s with args:" % method_name,0, str(kw))
method(**kw)
else:
# Get the appropriate SQL Method
# Lookup by path is required because of OFS Semantics
if uid:
# 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
catalog_path = self.getPathForUid(uid)
if catalog_path == "reserved":
# Reserved line in catalog table
insert_catalog_line = 0
LOG("SQLCatalog Warning: insert_catalog_line, case2",0,insert_catalog_line)
elif catalog_path is None:
# No line in catalog table
insert_catalog_line = 1
LOG("SQLCatalog Warning: insert_catalog_line, case3",0,insert_catalog_line)
else:
LOG('SQLCatalog WARNING',0,'assigning new uid to already catalogued object %s' % path)
uid = 0
insert_catalog_line = 0
LOG("SQLCatalog Warning: insert_catalog_line, case4",0,insert_catalog_line)
if not uid:
# Generate UID
index = self.newUid()
object.uid = index
insert_catalog_line = 0
LOG("SQLCatalog Warning: insert_catalog_line, case5",0,insert_catalog_line)
else:
index = uid
for method_name in self.sql_catalog_object:
# We will check if there is an filter on this
# method, if so we may not call this zsqlMethod
# for this object
if self.isMethodFiltered(method_name):
if self.filter_dict.has_key(method_name):
portal_type = object.getPortalType()
if portal_type not in (self.filter_dict[method_name]['type']):
LOG('catalog_object',0,'XX1 this method is broken because not in types: %s' % method_name)
continue
else:
expression = self.filter_dict[method_name]['expression_instance']
if expression is not None:
econtext = self.getExpressionContext(object)
result = expression(econtext)
if not result:
LOG('catalog_object',0,'XX2 this method is broken because expression: %s' % method_name)
continue
LOG('catalog_object',0,'this method is not broken: %s' % method_name)
method = getattr(self, method_name)
if method.meta_type == "Z SQL Method":
# Build the dictionnary of values
arguments = method.arguments_src
for arg in split(arguments):
try:
value = getattr(object, arg)
if callable(value):
value = value()
kw[arg] = value
except:
LOG("SQLCatalog Warning: Callable value could not be called",0,str((path, arg, method_name)))
kw[arg] = None
method = aq_base(method).__of__(object.__of__(self)) # Use method in the context of object
# Generate UID
kw['path'] = path
kw['uid'] = index
kw['insert_catalog_line'] = insert_catalog_line
# Alter/Create row
zope_root = self.getPortalObject().aq_parent
root_indexable = int(getattr(zope_root,'isIndexable',1))
if root_indexable:
#LOG("Call SQL Method %s with args:" % method_name,0, str(kw))
method(**kw)
def uncatalogObject(self, path):
"""
Uncatalog and object from the Catalog.
Note, the uid must be the same as when the object was
catalogued, otherwise it will not get removed from the catalog
This method should not raise an exception if the uid cannot
be found in the catalog.
XXX Add filter of methods
"""
LOG('Uncatalog object:',0,str(path))
uid = self.getUidForPath(path)
methods = self.sql_uncatalog_object
for method_name in methods:
method = getattr(self, method_name)
try:
#if 1:
method(uid = uid)
except:
# This is a real LOG message
# which is required in order to be able to import .zexp files
LOG("SQLCatalog Warning: could not uncatalog object uid %s with method %s" %
(uid, method_name),0,str(path))
def uniqueValuesFor(self, name):
""" return unique values for FieldIndex name """
method = getattr(self, self.sql_unique_values)
return method()
def getPaths(self):
""" Returns all object paths stored inside catalog """
method = getattr(self, self.sql_catalog_paths)
return method()
def getUidForPath(self, path):
""" Looks up into catalog table to convert path into uid """
try:
if path is None:
return None
# Get the appropriate SQL Method
method = getattr(self, self.sql_getitem_by_path)
search_result = method(path = path)
# If not emptyn return first record
if len(search_result) > 0:
return search_result[0].uid
else:
return None
except:
# This is a real LOG message
# which is required in order to be able to import .zexp files
LOG("Warning: could not find uid from path",0,str(path))
return None
def hasPath(self, path):
""" Checks if path is catalogued """
return self.getUidForPath(path) is not None
def getPathForUid(self, uid):
""" Looks up into catalog table to convert uid into path """
try:
if uid is None:
return None
# 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
except:
# This is a real LOG message
# which is required in order to be able to import .zexp files
LOG("Warning: could not find path from uid",0,str(uid))
return None
def getMetadataForUid(self, uid):
""" Accesses a single record for a given uid """
if uid is None:
return None
# Get the appropriate SQL Method
method = getattr(self, self.sql_getitem_by_uid)
brain = method(uid = uid)[0]
result = {}
for k in brain.__record_schema__.keys():
result[k] = getattr(brain,k)
return result
def getIndexDataForUid(self, uid):
""" Accesses a single record for a given uid """
return self.getMetadataForUid(uid)
def getMetadataForPath(self, path):
""" Accesses a single record for a given path """
try:
if uid is None:
return None
# Get the appropriate SQL Method
method = getattr(self, self.sql_getitem_by_path)
brain = method(path = path)[0]
result = {}
for k in brain.__record_schema__.keys():
result[k] = getattr(brain,k)
return result
except:
# This is a real LOG message
# which is required in order to be able to import .zexp files
LOG("Warning: could not find uid from path",0,str(path))
return None
def getIndexDataForPath(self, path):
""" Accesses a single record for a given path """
return self.getMetadataForPath(path)
def buildSQLQuery(self, REQUEST=None, **kw):
"""
"""
def queryResults(self, sql_method, REQUEST=None, used=None, **kw):
""" Builds a complex SQL query to simulate ZCalatog behaviour """
""" Returns a list of brains from a set of constraints on variables """
# 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
# If kw is not set, then use REQUEST instead
if kw is None or kw == {}:
kw = REQUEST
# We take additional parameters from the REQUEST
# and give priority to the REQUEST
if REQUEST is not None:
acceptable_keys = self.getColumnIds()
for key in acceptable_keys:
if REQUEST.has_key(key):
# Only copy a few keys from the REQUEST
if key in self.sql_catalog_request_keys:
kw[key] = REQUEST[key]
# Let us start building the query
if kw:
query = []
acceptable_keys = self.getColumnIds()
full_text_search_keys = self.sql_catalog_full_text_search_keys
keyword_search_keys = self.sql_catalog_keyword_search_keys
for key, value in kw.items():
if key not in ('query', 'sort-on', 'sort_on', 'sort-order', 'sort_order'):
# Make sure key belongs to schema
if key in acceptable_keys:
# uid is always ambiguous so we can only change it here
if key == 'uid': key = 'catalog.uid'
# Default case: variable equality
if type(value) is type(''):
if value != '':
# we consider empty string as Non Significant
if value == '=':
# But we consider the sign = as empty string
value=''
if '%' in value:
query += ["%s LIKE '%s'" % (key, value)]
elif value[0] == '>':
query += ["%s > '%s'" % (key, value[1:])]
elif value[0] == '<':
query += ["%s < '%s'" % (key, value[1:])]
elif key in keyword_search_keys:
# We must add % in the request to simulate the catalog
query += ["%s LIKE '%%%s%%'" % (key, value)]
elif key in full_text_search_keys:
# We must add % in the request to simulate the catalog
query += ["MATCH %s AGAINST ('%s')" % (key, value)]
else:
query += ["%s = '%s'" % (key, value)]
elif type(value) is type([]) or type(value) is type(()):
# We have to create an OR from tuple or list
query_item = []
for value_item in value:
if value_item != '':
# we consider empty string as Non Significant
# also for lists
if type(value_item) in (type(1), type(1.0)):
query_item += ["%s = %s" % (key, value_item)]
else:
if '%' in value_item:
query_item += ["%s LIKE '%s'" % (key, str(value_item))]
elif key in keyword_search_keys:
# We must add % in the request to simulate the catalog
query_item += ["%s LIKE '%%%s%%'" % (key, str(value_item))]
elif key in full_text_search_keys:
# We must add % in the request to simulate the catalog
query_item += ["MATCH %s AGAINST ('%s')" % (key, value)]
else:
query_item += ["%s = '%s'" % (key, str(value_item))]
if len(query_item) > 0:
query += ['(%s)' % join(query_item, ' OR ')]
else:
query += ["%s = %s" % (key, value)]
elif key is 'query':
# Not implemented yet
pass
if kw.has_key('query'):
if len(query) > 0:
kw['query'] = "(%s) AND (%s)" % (kw['query'], join(query, ' AND ') )
else:
kw['query'] = join(query, ' AND ')
#LOG("Search Query Args:",0,str(kw))
# 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 so into a string
if type(so) is not type('a'):
so = 'ascending'
# We must now turn sort_index into
# a dict with keys as sort keys and values as sort order
if type(sort_index) is type('a'):
sort_index = [(sort_index, so)]
elif type(sort_index) is not type(()) and type(sort_index) is not type([]):
sort_index = None
# If sort_index is a dictionnary
# then parse it and change it
if sort_index is not None:
try:
new_sort_index = []
for (k , v) in sort_index:
if v == 'descending' or v == 'reverse':
new_sort_index += ['%s DESC' % k]
else:
new_sort_index += ['%s' % k]
sort_index = join(new_sort_index,',')
kw['sort_on'] = str(sort_index)
except:
pass
# Return the result
# LOG('queryResults',0,'kw: %s' % str(kw))
return sql_method(**kw)
def searchResults(self, REQUEST=None, used=None, **kw):
""" Builds a complex SQL query to simulate ZCalatog behaviour """
""" Returns a list of brains from a set of constraints on variables """
# The used argument is deprecated and is ignored
try:
# Get the search method
method = getattr(self, self.sql_search_results)
# Return the result
kw['used'] = used
kw['REQUEST'] = REQUEST
return self.queryResults(method, **kw)
except:
LOG("Warning: could not search catalog",0,'', error=sys.exc_info())
return []
__call__ = searchResults
def countResults(self, REQUEST=None, used=None, **kw):
""" Builds a complex SQL query to simulate ZCalatog behaviour """
""" Returns the number of items which satisfy the query """
try:
# Get the search method
#LOG("countResults: scr:",0,str(self.sql_count_results))
#LOG("countResults: used:",0,str(used))
#LOG("countResults: kw:",0,str(kw))
method = getattr(self, self.sql_count_results)
# Return the result
kw['used'] = used
kw['REQUEST'] = REQUEST
return self.queryResults(method, **kw)
except:
LOG("Warning: could not count catalog",0,str(self.sql_count_results))
return [[0]]
class CatalogError(Exception): pass