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
##############################################################################
#
# Copyright (c) 2002,2007 Nexedi SARL and Contributors. All Rights Reserved.
# Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
from Globals import InitializeClass, Persistent, Acquisition
from Acquisition import aq_base, aq_inner, aq_parent, aq_self
from OFS.SimpleItem import SimpleItem
from OFS.Traversable import Traversable
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions as ERP5Permissions
from Products.PythonScripts.Utility import allow_class
import string
# Put a try in front XXX
from Products.CMFCategory.Category import Category
from Products.ERP5.Document.Domain import Domain
from zLOG import LOG
from Products.ERP5Type.Tool.MemcachedTool import MEMCACHED_TOOL_MODIFIED_FLAG_PROPERTY_ID
class Selection(Acquisition.Implicit, Traversable, Persistent):
"""
Selection
A Selection instance allows a ListBox object to browse the data
resulting from a method call such as an SQL Method Call. Selection
instances are used to implement persistent selections in ERP5.
Selection uses the following control variables
- method -- a method which will be used
to select objects
- params -- a dictionnary of parameters to call the
method with
- sort_on -- a dictionnary of parameters to sort
the selection
- uids -- a list of object uids which defines the
selection
- invert_mode -- defines the mode of the selection
if mode is 1, then only show the
ob
- list_url -- the URL to go back to list mode
- checked_uids -- a list of uids checked
- domain_path -- the path to the root of the selection tree
- domain_list -- the relative path of the current selected domain
XXX this will have to be updated for cartesion product
- report_path -- the report path
- report_list -- list of open report nodes
XXX this will have to be updated for cartesion product
- domain -- a DomainSelection instance
- report -- a DomainSelection instance
- flat_list_mode --
- domain_tree_mode --
- report_tree_mode --
"""
method_path=None
params=None
sort_on=()
default_sort_on=()
uids=()
invert_mode=0
list_url=''
columns=()
checked_uids=()
name=None
index=None
domain_path = ('portal_categories',)
domain_list = ((),)
report_path = ('portal_categories',)
report_list = ((),)
domain=None
report=None
report_opened=None
security = ClassSecurityInfo()
security.declareObjectPublic()
security.declarePublic('domain')
security.declarePublic('report')
def getId(self):
return self.name
def __init__(self, method_path=None, params=None, sort_on=None, default_sort_on=None,
uids=None, invert_mode=0, list_url='', domain=None, report=None,
columns=None, checked_uids=None, name=None, index=None):
if params is None: params = {}
if sort_on is None: sort_on = []
if default_sort_on is None: default_sort_on = []
if uids is None: uids = []
if columns is None: columns = []
if checked_uids is None: checked_uids = []
# XXX Because method_path is an URI, it must be in ASCII.
# Shouldn't Zope automatically does this conversion? -yo
if type(method_path) is type(u'a'):
method_path = method_path.encode('ascii')
self.method_path = method_path
self.params = params
self.uids = uids
self.invert_mode = invert_mode
self.list_url = list_url
self.columns = columns
self.sort_on = sort_on
self.default_sort_on = default_sort_on
self.checked_uids = checked_uids
self.name = name
self.index = index
self.domain_path = ('portal_categories',)
self.domain_list = ()
self.report_path = None
self.report_list = ()
self.domain = None
self.report = None
self.report_opened = None
security.declarePrivate('edit')
def edit(self, params=None, **kw):
setattr(self, MEMCACHED_TOOL_MODIFIED_FLAG_PROPERTY_ID, True)
if params is not None:
# We should only keep params which do not start with field_
# in order to make sure we do not collect unwanted params
# resulting form the REQUEST generated by an ERP5Form submit
params = dict([item for item in params.iteritems() \
if not item[0].startswith('field_')])
if self.params != params:
self.params = params
if kw is not None:
for k,v in kw.iteritems():
if k in ('domain', 'report', 'domain_path', 'report_path', 'domain_list', 'report_list') or v is not None:
# XXX Because method_path is an URI, it must be in ASCII.
# Shouldn't Zope automatically does this conversion? -yo
if k == 'method_path' and isinstance(v, unicode):
v = v.encode('ascii')
if getattr(self, k, None) != v:
setattr(self, k, v)
def _p_independent(self) :
return 1
def _p_resolveConflict(self, oldState, savedState, newState) :
"""Selection are edited by listboxs, so many conflicts can happen,
this is a workaround, so that no unnecessary transaction is
restarted."""
return newState
def __call__(self, method = None, context=None, REQUEST=None):
#LOG("Selection", 0, str((self.__dict__)))
#LOG("Selection", 0, str(method))
#LOG('Selection', 0, "self.invert_mode = %s" % repr(self.invert_mode))
kw = self.params.copy()
if self.invert_mode is not 0:
kw['uid'] = self.uids
if method is None or isinstance(method, str):
method_path = method or self.method_path
method = context.unrestrictedTraverse(method_path)
if type(method) is type('a'):
method = context.unrestrictedTraverse(self.method_path)
sort_on = getattr(self, 'sort_on', [])
if len(sort_on) == 0:
sort_on = getattr(self, 'default_sort_on', [])
if len(sort_on) > 0:
kw['sort_on'] = sort_on
elif kw.has_key('sort_on'):
del kw['sort_on'] # We should not sort if no sort was defined
# We should always set selection_name with self.name
kw['selection_name'] = self.name
if method is not None:
if callable(method):
if self.domain is not None and self.report is not None:
result = method(selection_domain = self.domain,
selection_report = self.report, selection=self, **kw)
elif self.domain is not None:
result = method(selection_domain = self.domain, selection=self, **kw)
elif self.report is not None:
result = method(selection_report = self.report, selection=self, **kw)
else:
result = method(selection=self, **kw)
return result
else:
return []
else:
return []
def __getitem__(self, index, REQUEST=None):
return self(REQUEST)[index]
security.declarePublic('getName')
def getName(self):
"""
Get the name of this selection.
"""
return self.name
security.declarePublic('getIndex')
def getIndex(self):
"""
Get the index of this selection.
"""
return self.index
security.declarePublic('getDomain')
def getDomain(self):
"""
Get the domain selection of this selection.
"""
return self.domain
security.declarePublic('getReport')
def getReport(self):
"""
Get the report selection of this selection.
"""
return self.report
security.declarePublic('getParams')
def getParams(self):
"""
Get a dictionary of parameters in this selection.
"""
#LOG('getParams',0,'params: %s' % str(self.params))
if self.params is None:
self.params = {}
if type(self.params) != type({}):
self.params = {}
return self.params
security.declarePublic('getSortOrder')
def getSortOrder(self):
"""
Return sort order stored in selection
"""
return self.sort_on
security.declarePublic('getListUrl')
def getListUrl(self):
result = ''
#LOG('getListUrl', 0, 'list_url = %s' % str(self.list_url))
if self.list_url is None:
self.list_url = ''
else:
result = self.list_url
return result
security.declarePublic('getCheckedUids')
def getCheckedUids(self):
if not hasattr(self, 'checked_uids'):
self.checked_uids = []
elif self.checked_uids is None:
self.checked_uids = []
return self.checked_uids
security.declarePublic('getDomainPath')
def getDomainPath(self, default=None):
if self.domain_path is None:
if default is None:
self.domain_path = self.getDomainList()[0]
else:
self.domain_path = default
return self.domain_path
security.declarePublic('getDomainList')
def getDomainList(self):
if self.domain_list is None:
self.domain_list = (('portal_categories',),)
return self.domain_list
security.declarePublic('getReportPath')
def getReportPath(self, default=None):
if self.report_path is None:
if default is None:
self.report_path = self.getReportList()[0]
else:
self.report_path = default
return self.report_path
security.declarePublic('getZoom')
def getZoom(self):
try:
current_zoom=self.params['zoom']
if current_zoom != None:
return current_zoom
else:
return 1
except KeyError:
return 1
security.declarePublic('getReportList')
def getReportList(self):
if self.report_list is None:
self.report_list = (('portal_categories',),)
return self.report_list
security.declarePublic('isReportOpened')
def isReportOpened(self):
if self.report_opened is None:
self.report_opened = 1
return self.report_opened
security.declarePublic('isInvertMode')
def isInvertMode(self):
return self.invert_mode
security.declarePublic('getInvertModeUidList')
def getInvertModeUidList(self):
return self.uids
InitializeClass(Selection)
allow_class(Selection)
class DomainSelection(Acquisition.Implicit, Traversable, Persistent):
"""
A class to store a selection of domains which defines a report
section. There are different ways to use DomainSelection in
SQL methods. As a general principle, SQL methods are passed
DomainSelection instances as a parameter.
Example 1: (hand coded)
The domain is accessed directly from the selection and a list of
uids is gathered from the ZODB to feed the SQL request. This
approach is only suitable for categories and relations. It is
not suitable for predicates. Do not use it unless there is no other way.
<dtml-if selection.domain.eip>
<dtml-in "selection.domain.eip.getCategoryChildUidList()">uid = <dtml-sqlvar sequence-item type="int"></dtml-in>
</dtml-if>
Example 2: (auto generated)
The domain object is in charge of generating automatically all
SQL expressions to feed the SQL method (or the catalog). This
is the recommended approach.
<dtml-var "selection.domain.asSQLExpression(table_map=(('eip','movement'), ('group', 'catalog')))">
<dtml-var "selection.domain.asSQLJoinExpression(table_map=(('eip','movement'), ('group', 'catalog')))">
Example 3: (mixed)
The category or predicate of the domain object is accessed. SQL
code generation is invoked on it. This is better than the manual
approach.
<dtml-var "selection.domain.eip.asSQLExpresion(table="resource_category")">
Current implementation is only suitable for categories.
It needs to be extended to support also predicates. The right approach
would be to turn any category into a predicate.
"""
security = ClassSecurityInfo()
security.declareObjectPublic()
def __init__(self, domain_dict = None):
#LOG('DomainSelection', 0, '__init__ is called with %r' % (domain_dict,))
if domain_dict is not None:
self.domain_dict = domain_dict
for k, v in domain_dict.iteritems():
if k is not None:
setattr(self, k, v)
def __len__(self):
return len(self.domain_dict)
security.declarePublic('getCategoryList')
def getCategoryList(self):
return
def _getDomainObject(self, portal, domain):
"""Return a domain or category object.
"""
if isinstance(domain, tuple):
# This is the new form. The first item describes the name of a tool or
# None if a domain is under a module. The second item is the relative
# URL of a domain.
tool = domain[0]
if tool is None:
obj = portal.restrictedTraverse(domain[1])
elif tool == 'portal_domains':
# Special case, as Domain Tool may generate a domain dynamically.
obj = portal.portal_domains.getDomainByPath(domain[1])
else:
obj = portal[tool].restrictedTraverse(domain[1])
elif isinstance(domain, str):
# XXX backward compatibility: a domain was represented by a string previously.
obj = portal.portal_domains.getDomainByPath(domain)
else:
# XXX backward compatibility: a category was represented by an object itself.
obj = aq_base(domain).__of__(portal)
return obj
security.declarePublic('asSQLExpression')
def asSQLExpression(self, table_map=None, domain_id=None,
exclude_domain_id=None, strict_membership=0,
join_table="catalog", join_column="uid",
base_category=None, category_table_alias='category'):
select_expression = []
portal = self.getPortalObject()
for k, d in self.domain_dict.iteritems():
d = self._getDomainObject(portal, d)
if k == 'parent':
# Special treatment for parent
select_expression.append(
d.getParentSQLExpression(table='catalog',
strict_membership=strict_membership))
elif k is not None:
if getattr(aq_base(d), 'isPredicate', 0):
select_expression.append(
d.asSQLExpression(table='%s_%s' % (k, category_table_alias),
strict_membership=strict_membership))
else:
# This is a category, we must join
select_expression.append('%s.%s = %s_%s.uid' % \
(join_table, join_column,
k, category_table_alias))
select_expression.append(
d.asSQLExpression(table='%s_%s' % (k, category_table_alias),
base_category=k,
strict_membership=strict_membership))
# XXX We should take into account k explicitely
# if we want to support category acquisition
if select_expression:
result = "( %s )" % ' AND '.join(select_expression)
else:
result = ''
#LOG('DomainSelection', 0, 'asSQLExpression returns %r' % (result,))
return result
# Compatibility SQL Sql
security.declarePublic('asSqlExpression')
asSqlExpression = asSQLExpression
security.declarePublic('asSQLJoinExpression')
def asSQLJoinExpression(self, domain_id=None, exclude_domain_id=None,
category_table_alias='category'):
join_expression = []
#LOG('DomainSelection', 0, 'domain_id = %r, exclude_domain_id = %r, self.domain_dict = %r' % (domain_id, exclude_domain_id, self.domain_dict))
portal = self.getPortalObject()
for k, d in self.domain_dict.iteritems():
d = self._getDomainObject(portal, d)
if k == 'parent':
pass
elif k is not None:
if getattr(aq_base(d), 'isPredicate', 0):
join_expression.append(d.asSQLJoinExpression(table='%s_%s' % (k, category_table_alias)))
else:
# This is a category, we must join
join_expression.append('category AS %s_%s' % (k, category_table_alias))
result = "%s" % ' , '.join(join_expression)
#LOG('DomainSelection', 0, 'asSQLJoinExpression returns %r' % (result,))
return result
# Compatibility SQL Sql
security.declarePublic('asSqlJoinExpression')
asSqlJoinExpression = asSQLJoinExpression
security.declarePublic('asDomainDict')
def asDomainDict(self, domain_id=None, exclude_domain_id=None):
return self.domain_dict
security.declarePublic('asDomainItemDict')
def asDomainItemDict(self, domain_id=None, exclude_domain_id=None):
pass
security.declarePublic('updateDomain')
def updateDomain(self, domain):
pass
InitializeClass(DomainSelection)
allow_class(DomainSelection)