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
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
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
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
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
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
1364
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
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
# -*- coding: utf-8 -*-
##############################################################################
#
# 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.
#
##############################################################################
"""
ERP5 portal_selection tool.
"""
from OFS.SimpleItem import SimpleItem
from Products.CMFCore.utils import UniqueObject
from Globals import InitializeClass, DTMLFile, PersistentMapping, get_request
from AccessControl import ClassSecurityInfo
from Products.ERP5Type.Tool.BaseTool import BaseTool
from Products.ERP5Type import Permissions as ERP5Permissions
from Products.ERP5Form import _dtmldir
from Selection import Selection, DomainSelection
from ZPublisher.HTTPRequest import FileUpload
import md5
import string, re
from urlparse import urlsplit, urlunsplit
from zLOG import LOG, INFO
from Acquisition import aq_base
from Products.ERP5Type.Message import translateString
import warnings
_MARKER = []
class SelectionError( Exception ):
pass
class SelectionTool( BaseTool, UniqueObject, SimpleItem ):
"""
The SelectionTool object is the place holder for all
methods and algorithms related to persistent selections
in ERP5.
"""
id = 'portal_selections'
meta_type = 'ERP5 Selections'
portal_type = 'Selection Tool'
security = ClassSecurityInfo()
#
# ZMI methods
#
manage_options = ( ( { 'label' : 'Overview'
, 'action' : 'manage_overview'
},
{ 'label' : 'View Selections'
, 'action' : 'manage_viewSelections'
},
{ 'label' : 'Configure'
, 'action' : 'manage_configure'
} ))
security.declareProtected( ERP5Permissions.ManagePortal
, 'manage_overview' )
manage_overview = DTMLFile( 'explainSelectionTool', _dtmldir )
security.declareProtected( ERP5Permissions.ManagePortal
, 'manage_viewSelections' )
manage_viewSelections = DTMLFile( 'SelectionTool_manageViewSelections', _dtmldir )
security.declareProtected( ERP5Permissions.ManagePortal
, 'manage_configure' )
manage_configure = DTMLFile( 'SelectionTool_configure', _dtmldir )
security.declareProtected( ERP5Permissions.ManagePortal
, 'manage_deleteSelection' )
def manage_deleteSelection(self, selection_name, REQUEST=None):
"""
Relete a specified selection
"""
self._deleteSelectionFromContainer(selection_name)
if REQUEST is not None:
return REQUEST.RESPONSE.redirect('%s/%s' %
(self.absolute_url(), 'manage_viewSelections'))
security.declareProtected( ERP5Permissions.ManagePortal
, 'manage_deleteGlobalSelection' )
def manage_deleteGlobalSelection(self, selection_name, REQUEST=None):
"""
Relete a specified selection
"""
self._deleteGlobalSelectionFromContainer(selection_name)
if REQUEST is not None:
return REQUEST.RESPONSE.redirect('%s/%s' %
(self.absolute_url(), 'manage_viewSelections'))
# storages of SelectionTool
security.declareProtected(ERP5Permissions.ManagePortal
, 'getStorageItemList')
def getStorageItemList(self):
"""Return the list of available storages
"""
#storage_item_list = [('Persistent Mapping', 'selection_data',)]
#list of tuple may fail dtml code: zope/documenttemplate/dt_in.py +578
storage_item_list = [['Persistent Mapping', 'selection_data']]
memcached_plugin_list = self.portal_memcached.contentValues(portal_type='Memcached Plugin', sort_on='int_index')
storage_item_list.extend([['/'.join((mp.getParentValue().getTitle(), mp.getTitle(),)), mp.getRelativeUrl()] for mp in memcached_plugin_list])
return storage_item_list
security.declareProtected( ERP5Permissions.ManagePortal, 'setStorage')
def setStorage(self, value, RESPONSE=None):
"""
Set the storage of Selection Tool.
"""
if value in [item[1] for item in self.getStorageItemList()]:
self.storage = value
else:
raise ValueError, 'Given storage type (%s) is now supported.' % (value,)
if RESPONSE is not None:
RESPONSE.redirect('%s/manage_configure' % (self.absolute_url()))
security.declareProtected( ERP5Permissions.ManagePortal, 'getStorage')
def getStorage(self, default='selection_data'):
"""return the selected storage
"""
storage = getattr(aq_base(self), 'storage', default)
if storage is not default:
#Backward compatibility
if storage == 'Persistent Mapping':
storage = 'selection_data'
elif storage == 'Memcached Tool':
memcached_plugin_list = self.portal_memcached.contentValues(portal_type='Memcached Plugin', sort_on='int_index')
if len(memcached_plugin_list):
storage = memcached_plugin_list[0].getRelativeUrl()
else:
storage = 'selection_data'
return storage
def isMemcachedUsed(self):
return 'portal_memcached' in self.getStorage()
def _redirectToOriginalForm(self, REQUEST=None, form_id=None, dialog_id=None,
query_string=None,
no_reset=False, no_report_depth=False):
"""Redirect to the original form or dialog, using the information given
as parameters.
(Actually does not redirect in the HTTP meaning because of URL
limitation problems.)
DEPRECATED parameters :
query_string is used to transmit parameters from caller to callee.
If no_reset is True, replace reset parameters with noreset.
If no_report_depth is True, replace report_depth parameters with
noreport_depth.
"""
if REQUEST is None:
return
form = REQUEST.form
if no_reset and form.has_key('reset'):
form['noreset'] = form['reset'] # Kept for compatibility - might no be used anymore
del form['reset']
if no_report_depth and form.has_key('report_depth'):
form['noreport_depth'] = form['report_depth'] # Kept for compatibility - might no be used anymore
del form['report_depth']
if query_string is not None:
warnings.warn('DEPRECATED: _redirectToOriginalForm got called with a query_string. The variables must be passed in REQUEST.form.',
DeprecationWarning)
context = REQUEST['PARENTS'][0]
form_id = dialog_id or REQUEST.get('dialog_id', None) or form_id or REQUEST.get('form_id', 'view')
return getattr(context, form_id)()
security.declareProtected(ERP5Permissions.View, 'getSelectionNameList')
def getSelectionNameList(self, context=None, REQUEST=None):
"""
Returns the selection names of the current user.
"""
if self.isMemcachedUsed():
return []
return sorted(self._getSelectionNameListFromContainer())
# backward compatibility
security.declareProtected(ERP5Permissions.View, 'getSelectionNames')
def getSelectionNames(self, context=None, REQUEST=None):
warnings.warn("getSelectionNames() is deprecated.\n"
"Please use getSelectionNameList() instead.",
DeprecationWarning)
return self.getSelectionNameList(context, REQUEST)
security.declareProtected(ERP5Permissions.View, 'callSelectionFor')
def callSelectionFor(self, selection_name, context=None, REQUEST=None):
if context is None: context = self
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is None:
return None
return selection(context=context)
security.declareProtected(ERP5Permissions.View, 'getSelectionFor')
def getSelectionFor(self, selection_name, REQUEST=None):
"""
Returns the selection instance for a given selection_name
"""
if isinstance(selection_name, (tuple, list)):
selection_name = selection_name[0]
selection = self._getSelectionFromContainer(selection_name)
if selection is not None:
return selection.__of__(self)
def __getitem__(self, key):
return self.getSelectionParamsFor(key)
security.declareProtected(ERP5Permissions.View, 'setSelectionFor')
def setSelectionFor(self, selection_name, selection_object, REQUEST=None):
"""
Sets the selection instance for a given selection_name
"""
if selection_object != None:
# Set the name so that this selection itself can get its own name.
selection_object.edit(name=selection_name)
if self.getSelectionFor(selection_name) != selection_object:
self._setSelectionToContainer(selection_name, selection_object)
security.declareProtected(ERP5Permissions.View, 'getSelectionParamsFor')
def getSelectionParamsFor(self, selection_name, params=None, REQUEST=None):
"""
Returns the params in the selection
"""
if params is None: params = {}
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
if len(selection.params) > 0:
return selection.getParams()
else:
return params
else:
return params
# backward compatibility
security.declareProtected(ERP5Permissions.View, 'getSelectionParams')
getSelectionParams = getSelectionParamsFor
security.declareProtected(ERP5Permissions.View, 'setSelectionParamsFor')
def setSelectionParamsFor(self, selection_name, params, REQUEST=None):
"""
Sets the selection params for a given selection_name
"""
selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object is not None:
selection_object.edit(params=params)
else:
selection_object = Selection(params=params)
self.setSelectionFor(selection_name, selection_object, REQUEST)
security.declareProtected(ERP5Permissions.View, 'getSelectionDomainDictFor')
def getSelectionDomainDictFor(self, selection_name, REQUEST=None):
"""
Returns the Domain dict for a given selection_name
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
try:
return selection.getDomain().asDomainDict
except AttributeError:
return {}
security.declareProtected(ERP5Permissions.View, 'getSelectionReportDictFor')
def getSelectionReportDictFor(self, selection_name, REQUEST=None):
"""
Returns the Report dict for a given selection_name
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
try:
return selection.getReport().asDomainDict
except AttributeError:
return {}
security.declareProtected(ERP5Permissions.View, 'setSelectionCheckedUidsFor')
def setSelectionCheckedUidsFor(self, selection_name, checked_uids, REQUEST=None):
"""
Sets the checked uids for a given selection_name
"""
selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object:
selection_object.edit(checked_uids=checked_uids)
else:
selection_object = Selection(checked_uids=checked_uids)
self.setSelectionFor(selection_name, selection_object, REQUEST)
security.declareProtected(ERP5Permissions.View, 'updateSelectionCheckedUidList')
def updateSelectionCheckedUidList(self, selection_name, listbox_uid, uids, REQUEST=None):
"""
Updates the unchecked uids(listbox_uids) and checked uids (uids)
for a given selection_name
"""
if listbox_uid is None:
listbox_uid = []
if uids is None:
uids = []
self.uncheckAll(selection_name,listbox_uid,REQUEST=REQUEST)
self.checkAll(selection_name,uids,REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedUidsFor')
def getSelectionCheckedUidsFor(self, selection_name, REQUEST=None):
"""
Returns the checked uids for a given selection_name
"""
selection_object = self.getSelectionFor(selection_name, REQUEST)
if selection_object:
return selection_object.getCheckedUids()
return []
security.declareProtected(ERP5Permissions.View, 'checkAll')
def checkAll(self, list_selection_name, listbox_uid=[], REQUEST=None,
query_string=None, form_id=None):
"""
Check uids in a given listbox_uid list for a given list_selection_name
"""
selection_object = self.getSelectionFor(list_selection_name, REQUEST)
if selection_object:
selection_uid_dict = {}
for uid in selection_object.checked_uids:
selection_uid_dict[uid] = 1
for uid in listbox_uid:
try:
selection_uid_dict[int(uid)] = 1
except ValueError:
selection_uid_dict[uid] = 1
self.setSelectionCheckedUidsFor(list_selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string, no_reset=True)
security.declareProtected(ERP5Permissions.View, 'uncheckAll')
def uncheckAll(self, list_selection_name, listbox_uid=[], REQUEST=None,
query_string=None, form_id=None):
"""
Uncheck uids in a given listbox_uid list for a given list_selection_name
"""
selection_object = self.getSelectionFor(list_selection_name, REQUEST)
if selection_object:
selection_uid_dict = {}
for uid in selection_object.checked_uids:
selection_uid_dict[uid] = 1
for uid in listbox_uid:
try:
if selection_uid_dict.has_key(int(uid)): del selection_uid_dict[int(uid)]
except ValueError:
if selection_uid_dict.has_key(uid): del selection_uid_dict[uid]
self.setSelectionCheckedUidsFor(list_selection_name, selection_uid_dict.keys(), REQUEST=REQUEST)
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string, no_reset=True)
security.declareProtected(ERP5Permissions.View, 'getSelectionListUrlFor')
def getSelectionListUrlFor(self, selection_name, REQUEST=None):
"""
Returns the URL of the list mode of selection instance
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection:
return selection.getListUrl()
else:
return None
security.declareProtected(ERP5Permissions.View, 'getSelectionInvertModeFor')
def getSelectionInvertModeFor(self, selection_name, REQUEST=None):
"""Get the 'invert_mode' parameter of a selection.
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
return selection.isInvertMode()
return 0
security.declareProtected(ERP5Permissions.View, 'setSelectionInvertModeFor')
def setSelectionInvertModeFor(self, selection_name,
invert_mode, REQUEST=None):
"""Change the 'invert_mode' parameter of a selection.
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
selection.edit(invert_mode=invert_mode)
security.declareProtected(ERP5Permissions.View, 'getSelectionInvertModeUidListFor')
def getSelectionInvertModeUidListFor(self, selection_name, REQUEST=None):
"""Get the 'invert_mode' parameter of a selection.
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
return selection.getInvertModeUidList()
return 0
security.declareProtected(ERP5Permissions.View, 'getSelectionIndexFor')
def getSelectionIndexFor(self, selection_name, REQUEST=None):
"""Get the 'index' parameter of a selection.
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
return selection.getIndex()
return None
security.declareProtected(ERP5Permissions.View, 'setSelectionToIds')
def setSelectionToIds(self, selection_name, selection_uids, REQUEST=None):
"""
Sets the selection to a small list of uids of documents
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
selection.edit(invert_mode=1, uids=selection_uids, checked_uids=selection_uids)
security.declareProtected(ERP5Permissions.View, 'setSelectionToAll')
def setSelectionToAll(self, selection_name, REQUEST=None,
reset_domain_tree=False, reset_report_tree=False):
"""
Resets the selection
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
selection.edit(invert_mode=0, params={}, checked_uids=[], report_opened=1)
if reset_domain_tree:
selection.edit(domain=None, domain_path=None, domain_list=None)
if reset_report_tree:
selection.edit(report=None, report_path=None, report_list=None)
security.declareProtected(ERP5Permissions.View, 'setSelectionSortOrder')
def setSelectionSortOrder(self, selection_name, sort_on, REQUEST=None):
"""
Defines the sort order of the selection
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
selection.edit(sort_on=sort_on)
security.declareProtected(ERP5Permissions.View, 'setSelectionQuickSortOrder')
def setSelectionQuickSortOrder(self, selection_name=None, sort_on=None, REQUEST=None,
query_string=None, form_id=None):
"""
Defines the sort order of the selection directly from the listbox
In this method, sort_on is just a string that comes from url
"""
# selection_name, sort_on and form_id params are kept only for bacward compatibilty
# as some test call setSelectionQuickSortOrder in url with these params
listbox_id = None
if REQUEST is not None:
form = REQUEST.form
if sort_on is None:
listbox_id, sort_on = form["setSelectionQuickSortOrder"].split(".", 1)
if REQUEST is not None:
if listbox_id is not None:
selection_name_key = "%s_list_selection_name" %listbox_id
selection_name = form[selection_name_key]
elif selection_name is None:
selection_name = form['selection_name']
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
current_sort_on = self.getSelectionSortOrder(selection_name)
# We must first switch from asc to desc and vice-versa if sort_order exists
# in selection
n = 0
for current in current_sort_on:
if current[0] == sort_on:
n = 1
if current[1] == 'ascending':
new_sort_on = [(sort_on, 'descending')]
break
else:
new_sort_on = [(sort_on,'ascending')]
break
# And if no one exists, we just set ascending sort
if n == 0:
new_sort_on = [(sort_on,'ascending')]
selection.edit(sort_on=new_sort_on)
if REQUEST is not None:
if form.has_key('listbox_uid') and \
form.has_key('uids'):
self.uncheckAll(selection_name, REQUEST.get('listbox_uid'))
self.checkAll(selection_name, REQUEST.get('uids'))
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string, no_reset=True)
security.declareProtected(ERP5Permissions.View, 'getSelectionSortOrder')
def getSelectionSortOrder(self, selection_name, REQUEST=None):
"""
Returns the sort order of the selection
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is None: return ()
return selection.sort_on
security.declareProtected(ERP5Permissions.View, 'setSelectionColumns')
def setSelectionColumns(self, selection_name, columns, REQUEST=None):
"""
Defines the columns in the selection
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
selection.edit(columns=columns)
security.declareProtected(ERP5Permissions.View, 'getSelectionColumns')
def getSelectionColumns(self, selection_name, columns=None, REQUEST=None):
"""
Returns the columns in the selection if not empty, otherwise
returns the value of columns argument
"""
if columns is None: columns = []
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
if len(selection.columns) > 0:
return selection.columns
return columns
security.declareProtected(ERP5Permissions.View, 'setSelectionStats')
def setSelectionStats(self, selection_name, stats, REQUEST=None):
"""
Defines the stats in the selection
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
selection.edit(stats=stats)
security.declareProtected(ERP5Permissions.View, 'getSelectionStats')
def getSelectionStats(self, selection_name, stats=_MARKER, REQUEST=None):
"""
Returns the stats in the selection
"""
if stats is not _MARKER:
default_stats = stats
else:
default_stats = [' '] * 6
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
return getattr(aq_base(selection), 'stats', default_stats)
return default_stats
security.declareProtected(ERP5Permissions.View, 'viewFirst')
def viewFirst(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
"""
Access first item in a selection
"""
if not REQUEST:
REQUEST = get_request()
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection:
method = self.unrestrictedTraverse(selection.method_path)
selection_list = selection(method = method, context=self, REQUEST=REQUEST)
if len(selection_list):
o = selection_list[0]
url = o.absolute_url()
else:
url = REQUEST.getURL()
else:
url = REQUEST.getURL()
ignore_layout = int(REQUEST.get('ignore_layout', 0))
url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, 0, selection_name, ignore_layout)
REQUEST.RESPONSE.redirect(url)
security.declareProtected(ERP5Permissions.View, 'viewLast')
def viewLast(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
"""
Access last item in a selection
"""
if not REQUEST:
REQUEST = get_request()
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection:
method = self.unrestrictedTraverse(selection.method_path)
selection_list = selection(method = method, context=self, REQUEST=REQUEST)
if len(selection_list):
o = selection_list[-1]
url = o.absolute_url()
else:
url = REQUEST.getURL()
else:
url = REQUEST.getURL()
ignore_layout = int(REQUEST.get('ignore_layout', 0))
url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, -1, selection_name, ignore_layout)
REQUEST.RESPONSE.redirect(url)
security.declareProtected(ERP5Permissions.View, 'viewNext')
def viewNext(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
"""
Access next item in a selection
"""
if not REQUEST:
REQUEST = get_request()
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection:
method = self.unrestrictedTraverse(selection.method_path)
selection_list = selection(method = method, context=self, REQUEST=REQUEST)
if len(selection_list):
o = selection_list[(int(selection_index) + 1) % len(selection_list)]
url = o.absolute_url()
else:
url = REQUEST.getURL()
else:
url = REQUEST.getURL()
ignore_layout = int(REQUEST.get('ignore_layout', 0))
url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, int(selection_index) + 1, selection_name, ignore_layout)
REQUEST.RESPONSE.redirect(url)
security.declareProtected(ERP5Permissions.View, 'viewPrevious')
def viewPrevious(self, selection_index='', selection_name='', form_id='view', REQUEST=None):
"""
Access previous item in a selection
"""
if not REQUEST:
REQUEST = get_request()
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection:
method = self.unrestrictedTraverse(selection.method_path)
selection_list = selection(method = method, context=self, REQUEST=REQUEST)
if len(selection_list):
o = selection_list[(int(selection_index) - 1) % len(selection_list)]
url = o.absolute_url()
else:
url = REQUEST.getURL()
else:
url = REQUEST.getURL()
ignore_layout = int(REQUEST.get('ignore_layout', 0))
url = '%s/%s?selection_index=%s&selection_name=%s&ignore_layout:int=%s' % (url, form_id, int(selection_index) - 1, selection_name, ignore_layout)
REQUEST.RESPONSE.redirect(url)
# ListBox related methods
security.declareProtected(ERP5Permissions.View, 'firstPage')
def firstPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
"""
Access the first page of a list
XXX: As its complementary (lastPage) is broken, this method is
probably not used either. If so, it should be removed along with
lastPage.
"""
if uids is None: uids = []
REQUEST.form['list_start'] = 0
self.uncheckAll(list_selection_name, listbox_uid)
return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'lastPage')
def lastPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
"""
Access the last page of a list
XXX: This method is broken, since "total_size" field is not
present in the listbox rendering any longer. It should be
removed.
"""
if uids is None: uids = []
selection = self.getSelectionFor(list_selection_name, REQUEST)
if selection is not None:
params = selection.getParams()
# XXX This will not work if the number of lines shown in the listbox is greater
# than the BIG_INT constan. Such a case has low probability but is not
# impossible. If you are in this case, send me a mail ! -- Kev
BIG_INT = 10000000
last_page_start = BIG_INT
total_lines = REQUEST.form.get('total_size', BIG_INT)
if total_lines != BIG_INT:
lines_per_page = params.get('list_lines', 1)
last_page_start = int(total_lines) - (int(total_lines) % int(lines_per_page))
REQUEST.form['list_start'] = last_page_start
self.uncheckAll(list_selection_name, listbox_uid)
return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'nextPage')
def nextPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
"""
Access the next page of a list
"""
if uids is None: uids = []
selection = self.getSelectionFor(list_selection_name, REQUEST)
if selection is not None:
params = selection.getParams()
lines = int(params.get('list_lines', 0))
form = REQUEST.form
if form.has_key('page_start'):
try:
list_start = (int(form.pop('page_start', 0)) - 1) * lines
except ValueError:
list_start = 0
else:
list_start = int(form.pop('list_start', 0))
params['list_start'] = max(list_start + lines, 0)
selection.edit(params=params)
self.uncheckAll(list_selection_name, listbox_uid)
return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'previousPage')
def previousPage(self, list_selection_name, listbox_uid, uids=None, REQUEST=None):
"""
Access the previous page of a list
"""
if uids is None: uids = []
selection = self.getSelectionFor(list_selection_name, REQUEST)
if selection is not None:
params = selection.getParams()
lines = int(params.get('list_lines', 0))
form = REQUEST.form
if form.has_key('page_start'):
try:
list_start = (int(form.pop('page_start', 0)) - 1) * lines
except ValueError:
list_start = 0
else:
list_start = int(form.pop('list_start', 0))
params['list_start'] = max(list_start - lines, 0)
selection.edit(params=params)
self.uncheckAll(list_selection_name, listbox_uid)
return self.checkAll(list_selection_name, uids, REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'setPage')
def setPage(self, list_selection_name, listbox_uid, query_string=None, uids=None, REQUEST=None):
"""
Sets the current displayed page in a selection
"""
if uids is None: uids = []
selection = self.getSelectionFor(list_selection_name, REQUEST)
if selection is not None:
params = selection.getParams()
lines = int(params.get('list_lines', 0))
form = REQUEST.form
if form.has_key('page_start'):
try:
list_start = (int(form.pop('page_start', 0)) - 1) * lines
except ValueError:
list_start = 0
else:
list_start = int(form.pop('list_start', 0))
params['list_start'] = max(list_start, 0)
selection.edit(params=params)
self.uncheckAll(list_selection_name, listbox_uid)
return self.checkAll(list_selection_name, uids, REQUEST=REQUEST, query_string=query_string)
# PlanningBox related methods
security.declareProtected(ERP5Permissions.View, 'setLanePath')
def setLanePath(self, uids=None, REQUEST=None, form_id=None,
query_string=None):
"""
Set graphic zoom level in PlanningBox
"""
if uids is None:
uids = []
request = REQUEST
selection_name=request.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
params = selection.getParams()
lane_path = request.form.get('lane_path', None)
if lane_path is None:
# If lane_path is not defined try to
# use the last one from params
lane_path = params.get('lane_path',1)
bound_start = request.form.get('bound_start', None)
if bound_start is not None:
params['bound_start'] = bound_start
params['lane_path'] = lane_path
params['zoom_variation'] = 0
selection.edit(params=params)
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST,
form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'nextLanePage')
def nextLanePage(self, uids=None, REQUEST=None, form_id=None, query_string=None):
"""
Set next graphic zoom start in PlanningBox
"""
if uids is None:
uids = []
request = REQUEST
selection_name=request.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
params = selection.getParams()
params['bound_variation'] = 1
selection.edit(params=params)
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST,
form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'previousLanePage')
def previousLanePage(self, uids=None, REQUEST=None, form_id=None, query_string=None):
"""
Set previous graphic zoom in PlanningBox
"""
if uids is None:
uids = []
request = REQUEST
selection_name=request.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is not None:
params = selection.getParams()
params['bound_variation'] = -1
selection.edit(params=params)
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST,
form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'setDomainRoot')
def setDomainRoot(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root domain for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
root_url = REQUEST.form.get('domain_root_url','portal_categories')
selection.edit(domain_path=root_url, domain_list=())
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'setDomainRootFromParam')
def setDomainRootFromParam(self, REQUEST, selection_name, domain_root):
if REQUEST is None:
return
selection = self.getSelectionFor(selection_name, REQUEST)
selection.edit(domain_path=domain_root, domain_list=())
security.declareProtected(ERP5Permissions.View, 'unfoldDomain')
def unfoldDomain(self, REQUEST, form_id=None, query_string=None):
"""
Unfold domain for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
domain_url = REQUEST.form.get('domain_url',None)
domain_depth = REQUEST.form.get('domain_depth',0)
domain_list = list(selection.getDomainList())
domain_list = domain_list[0:min(domain_depth, len(domain_list))]
if isinstance(domain_url, str):
selection.edit(domain_list = domain_list + [domain_url])
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'foldDomain')
def foldDomain(self, REQUEST, form_id=None, query_string=None):
"""
Fold domain for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
domain_url = REQUEST.form.get('domain_url',None)
domain_depth = REQUEST.form.get('domain_depth',0)
domain_list = list(selection.getDomainList())
domain_list = domain_list[0:min(domain_depth, len(domain_list))]
selection.edit(domain_list=[x for x in domain_list if x != domain_url])
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'setReportRoot')
def setReportRoot(self, REQUEST, form_id=None, query_string=None):
"""
Sets the root report for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
root_url = REQUEST.form.get('report_root_url','portal_categories')
selection.edit(report_path=root_url, report_list=())
if REQUEST is not None:
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string)
security.declareProtected(ERP5Permissions.View, 'unfoldReport')
def unfoldReport(self, REQUEST, form_id=None, query_string=None):
"""
Unfold report for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
report_url = REQUEST.form.get('report_url',None)
if type(report_url) == type('a'):
selection.edit(report_list=list(selection.getReportList()) + [report_url])
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string,
no_report_depth=True)
security.declareProtected(ERP5Permissions.View, 'foldReport')
def foldReport(self, REQUEST, form_id=None, query_string=None):
"""
Fold domain for the current selection
"""
selection_name = REQUEST.list_selection_name
selection = self.getSelectionFor(selection_name, REQUEST)
report_url = REQUEST.form.get('report_url',None)
if type(report_url) == type('a'):
report_list = selection.getReportList()
selection.edit(report_list=[x for x in report_list if x != report_url])
return self._redirectToOriginalForm(REQUEST=REQUEST, form_id=form_id,
query_string=query_string,
no_report_depth=True)
security.declareProtected(ERP5Permissions.View, 'getListboxDisplayMode')
def getListboxDisplayMode(self, selection_name, REQUEST=None):
if REQUEST is None:
REQUEST = get_request()
selection = self.getSelectionFor(selection_name, REQUEST)
if getattr(selection, 'report_tree_mode', 0):
return 'ReportTreeMode'
elif getattr(selection, 'domain_tree_mode', 0):
return 'DomainTreeMode'
return 'FlatListMode'
security.declareProtected(ERP5Permissions.View, 'setListboxDisplayMode')
def setListboxDisplayMode(self, REQUEST, listbox_display_mode,
selection_name=None, redirect=0,
form_id=None, query_string=None):
"""
Toggle display of the listbox
"""
request = REQUEST
# XXX FIXME
# Dirty fix: we must be able to change the display mode of a listbox
# in form_view
# But, form can have multiple listbox...
# This need to be cleaned
# Beware, this fix may break the report system...
# and we don't have test for this
# Possible fix: currently, display mode icon are implemented as
# method. It could be easier to generate them as link (where we
# can define explicitely parameters through the url).
try:
list_selection_name = request.list_selection_name
except AttributeError:
pass
else:
if list_selection_name is not None:
selection_name = request.list_selection_name
# Get the selection
selection = self.getSelectionFor(selection_name, REQUEST)
if selection is None:
selection = Selection()
self.setSelectionFor(selection_name, selection, REQUEST=REQUEST)
if listbox_display_mode == 'FlatListMode':
flat_list_mode = 1
domain_tree_mode = 0
report_tree_mode = 0
elif listbox_display_mode == 'DomainTreeMode':
flat_list_mode = 0
domain_tree_mode = 1
report_tree_mode = 0
elif listbox_display_mode == 'ReportTreeMode':
flat_list_mode = 0
domain_tree_mode = 0
report_tree_mode = 1
else:
flat_list_mode = 0
domain_tree_mode = 0
report_tree_mode = 0
selection.edit(flat_list_mode=flat_list_mode,
domain_tree_mode=domain_tree_mode,
report_tree_mode=report_tree_mode)
# It is better to reset the query when changing the display mode.
params = selection.getParams()
if 'where_expression' in params: del params['where_expression']
selection.edit(params=params)
if redirect:
return self._redirectToOriginalForm(REQUEST=request, form_id=form_id,
query_string=query_string,
no_reset=True)
security.declareProtected(ERP5Permissions.View, 'setFlatListMode')
def setFlatListMode(self, REQUEST, selection_name=None):
"""
Set display of the listbox to FlatList mode
"""
return self.setListboxDisplayMode(
REQUEST=REQUEST, listbox_display_mode='FlatListMode',
selection_name=selection_name, redirect=1)
security.declareProtected(ERP5Permissions.View, 'setDomainTreeMode')
def setDomainTreeMode(self, REQUEST, selection_name=None):
"""
Set display of the listbox to DomainTree mode
"""
return self.setListboxDisplayMode(
REQUEST=REQUEST, listbox_display_mode='DomainTreeMode',
selection_name=selection_name, redirect=1)
security.declareProtected(ERP5Permissions.View, 'setReportTreeMode')
def setReportTreeMode(self, REQUEST, selection_name=None):
"""
Set display of the listbox to ReportTree mode
"""
return self.setListboxDisplayMode(
REQUEST=REQUEST, listbox_display_mode='ReportTreeMode',
selection_name=selection_name, redirect=1)
security.declareProtected(ERP5Permissions.View, 'getSelectionSelectedValueList')
def getSelectionSelectedValueList(self, selection_name, REQUEST=None, selection_method=None, context=None):
"""
Get the list of values selected for 'selection_name'
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is None:
return []
return selection(method=selection_method, context=context, REQUEST=REQUEST)
security.declareProtected(ERP5Permissions.View, 'getSelectionCheckedValueList')
def getSelectionCheckedValueList(self, selection_name, REQUEST=None):
"""
Get the list of values checked for 'selection_name'
"""
selection = self.getSelectionFor(selection_name, REQUEST=REQUEST)
if selection is None:
return []
uid_list = selection.getCheckedUids()
value_list = self.portal_catalog.getObjectList(uid_list)
return value_list
security.declareProtected(ERP5Permissions.View, 'getSelectionValueList')
def getSelectionValueList(self, selection_name, REQUEST=None, selection_method=None, context=None):
"""
Get the list of values checked or selected for 'selection_name'
"""
value_list = self.getSelectionCheckedValueList(selection_name, REQUEST=REQUEST)
if len(value_list) == 0:
value_list = self.getSelectionSelectedValueList(
selection_name,
REQUEST=REQUEST,
selection_method=selection_method,
context=context)
return value_list
security.declareProtected(ERP5Permissions.View, 'getSelectionUidList')
def getSelectionUidList(self, selection_name, REQUEST=None, selection_method=None, context=None):
"""
Get the list of uids checked or selected for 'selection_name'
"""
return [x.getObject().getUid() for x in self.getSelectionValueList(selection_name, REQUEST=REQUEST, selection_method=selection_method, context=context)]
security.declareProtected(ERP5Permissions.View, 'selectionHasChanged')
def selectionHasChanged(self, md5_string, object_uid_list):
"""
We want to be sure that the selection did not change
"""
# XXX To avoid the difference of the string representations of int and long,
# convert each element to a string.
object_uid_list = [str(x) for x in object_uid_list]
object_uid_list.sort()
new_md5_string = md5.new(str(object_uid_list)).hexdigest()
return md5_string != new_md5_string
# Related document searching
def viewSearchRelatedDocumentDialog(self, index, form_id,
REQUEST=None, sub_index=None, **kw):
"""
Returns a search related document dialog
A set of forwarders us defined to circumvent limitations of HTML
"""
if sub_index != None:
REQUEST.form['sub_index'] = sub_index
object_path = REQUEST.form['object_path']
# Find the object which needs to be updated
o = self.restrictedTraverse(object_path)
# Find the field which was clicked on
# Important to get from the object instead of self
form = getattr(o, form_id)
field = None
# Search the correct field
relation_field_found = 0
relation_index = 0
# XXX may be should support another parameter,
for field in form.get_fields(include_disabled=0):
if field.get_value('editable', REQUEST=REQUEST):
try:
field.get_value('is_relation_field')
except KeyError:
pass
else:
if index == relation_index:
relation_field_found = 1
break
else:
relation_index += 1
if not relation_field_found:
# We didn't find the field...
raise SelectionError, "SelectionTool: can not find the relation" \
" field %s" % index
else:
# Field found
field_key = field.generate_field_key()
field_value = REQUEST.form[field_key]
dialog_id = field.get_value('relation_form_id') or \
'Base_viewRelatedObjectList'
redirect_form = getattr(o, dialog_id)
# XXX Hardcoded listbox field
selection_name = redirect_form.listbox.get_value('selection_name')
# Reset current selection
self.setSelectionFor(selection_name, None)
if (field.get_value('is_multi_relation_field')) and \
(sub_index is None):
# user click on the wheel, not on the validation button
# we need to facilitate user search
# first: store current field value in the selection
base_category = field.get_value('base_category')
property_get_related_uid_method_name = \
"get%sUidList" % ''.join(['%s%s' % (x[0].upper(), x[1:]) \
for x in base_category.split('_')])
current_uid_list = getattr(o, property_get_related_uid_method_name)\
(portal_type=[x[0] for x in \
field.get_value('portal_type')])
# Checked current uid
kw ={}
catalog_index = field.get_value('catalog_index')
kw[catalog_index] = field_value
self.setSelectionParamsFor(selection_name,
kw.copy())
self.setSelectionCheckedUidsFor(selection_name,
current_uid_list)
field_value = str(field_value)
if len(field_value):
sql_catalog = self.portal_catalog.getSQLCatalog()
field_value = sql_catalog.buildQuery({
catalog_index: field_value.splitlines()
}).asSearchTextExpression(sql_catalog, column='')
REQUEST.form[field_key] = field_value
portal_status_message = translateString("Please select one (or more) object.")
else:
portal_status_message = translateString("Please select one object.")
# Save the current REQUEST form
# We can't put FileUpload instances because we can't pickle them
saved_form_data = {}
for key, value in REQUEST.form.items():
if not isinstance(value, FileUpload):
saved_form_data[key] = value
base_category = None
kw = {}
kw['dialog_id'] = dialog_id
kw['selection_name'] = selection_name
kw['selection_index'] = 0 # We start on the first page
kw['field_id'] = field.id
parameter_list = field.get_value('parameter_list')
if len(parameter_list) > 0:
for k,v in parameter_list:
kw[k] = v
kw['reset'] = 0
kw['base_category'] = field.get_value( 'base_category')
kw['form_id'] = form_id
kw[field.get_value('catalog_index')] = field_value
kw['portal_status_message'] = portal_status_message
kw['saved_form_data'] = saved_form_data
kw['ignore_layout'] = int(REQUEST.get('ignore_layout', 0))
# remove ignore_layout parameter from cancel_url otherwise we
# will have two ignore_layout parameters after clicking cancel
# button.
split_referer = list(urlsplit(REQUEST.get('HTTP_REFERER')))
split_referer[3] = '&'.join([x for x in \
split_referer[3].split('&') \
if not re.match('^ignore_layout[:=]', x)])
kw['cancel_url'] = urlunsplit(split_referer)
proxy_listbox_ids = field.get_value('proxy_listbox_ids')
REQUEST.set('proxy_listbox_ids', proxy_listbox_ids)
if len(proxy_listbox_ids) > 0:
REQUEST.set('proxy_listbox_id', proxy_listbox_ids[0][0])
else:
REQUEST.set('proxy_listbox_id', \
"Base_viewRelatedObjectListBase/listbox")
# Empty the selection (uid)
REQUEST.form = kw # New request form
# Define new HTTP_REFERER
REQUEST.HTTP_REFERER = '%s/%s' % (o.absolute_url(),
dialog_id)
# If we are called from a Web Site, we should return
# in the context of the Web Section
if self.getApplicableLayout() is not None:
return getattr(o.__of__(self.getWebSectionValue()), dialog_id)(REQUEST=REQUEST)
# Return the search dialog
return getattr(o, dialog_id)(REQUEST=REQUEST)
security.declarePublic('buildSQLJoinExpressionFromDomainSelection')
def buildSQLJoinExpressionFromDomainSelection(self, selection_domain,
domain_id=None,
exclude_domain_id=None,
category_table_alias='category'):
if isinstance(selection_domain, DomainSelection):
warnings.warn("To pass a DomainSelection instance is deprecated.\n"
"Please use a domain dict instead.",
DeprecationWarning)
else:
selection_domain = DomainSelection(selection_domain).__of__(self)
return selection_domain.asSQLJoinExpression(
category_table_alias=category_table_alias)
security.declarePublic('buildSQLExpressionFromDomainSelection')
def buildSQLExpressionFromDomainSelection(self, selection_domain,
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'):
if isinstance(selection_domain, DomainSelection):
warnings.warn("To pass a DomainSelection instance is deprecated.\n"
"Please use a domain dict instead.",
DeprecationWarning)
else:
selection_domain = DomainSelection(selection_domain).__of__(self)
return selection_domain.asSQLExpression(
strict_membership = strict_membership,
join_table=join_table,
join_column=join_column,
base_category=base_category,
category_table_alias = category_table_alias)
def _aq_dynamic(self, name):
"""
Generate viewSearchRelatedDocumentDialog0,
viewSearchRelatedDocumentDialog1,... if necessary
"""
aq_base_name = getattr(aq_base(self), name, None)
if aq_base_name == None:
DYNAMIC_METHOD_NAME = 'viewSearchRelatedDocumentDialog'
method_name_length = len(DYNAMIC_METHOD_NAME)
zope_security = '__roles__'
if (name[:method_name_length] == DYNAMIC_METHOD_NAME) and \
(name[-len(zope_security):] != zope_security):
method_count_string_list = name[method_name_length:].split('_')
method_count_string = method_count_string_list[0]
# be sure that method name is correct
try:
method_count = string.atoi(method_count_string)
except TypeError:
return aq_base_name
else:
if len(method_count_string_list) > 1:
# be sure that method name is correct
try:
sub_index = string.atoi(method_count_string_list[1])
except TypeError:
return aq_base_name
else:
sub_index = None
# generate dynamicaly needed forwarder methods
def viewSearchRelatedDocumentDialogWrapper(self, form_id,
REQUEST=None, **kw):
"""
viewSearchRelatedDocumentDialog Wrapper
"""
# LOG('SelectionTool.viewSearchRelatedDocumentDialogWrapper, kw',
# 0, kw)
return self.viewSearchRelatedDocumentDialog(
method_count, form_id,
REQUEST=REQUEST, sub_index=sub_index, **kw)
setattr(self.__class__, name,
viewSearchRelatedDocumentDialogWrapper)
klass = aq_base(self).__class__
security_property_id = '%s__roles__' % (name, )
# Declare method as public
setattr(klass, security_property_id, None)
return getattr(self, name)
else:
return aq_base_name
return aq_base_name
def _getUserId(self):
return self.portal_membership.getAuthenticatedMember().getUserName()
# XXX It would be good to add somthing here
# So that 2 anonymous users do not share the same selection
def _getSelectionFromContainer(self, selection_name):
user_id = self._getUserId()
if user_id is None: return None
if self.isMemcachedUsed():
return self._getMemcachedContainer().get('%s-%s' %
(user_id, selection_name))
else:
return self._getPersistentContainer(user_id).get(selection_name,
None)
def _setSelectionToContainer(self, selection_name, selection):
user_id = self._getUserId()
if user_id is None: return
if self.isMemcachedUsed():
self._getMemcachedContainer().set('%s-%s' % (user_id, selection_name), aq_base(selection))
else:
self._getPersistentContainer(user_id)[selection_name] = aq_base(selection)
def _deleteSelectionFromContainer(self, selection_name):
user_id = self._getUserId()
if user_id is None: return None
if self.isMemcachedUsed():
del(self._getMemcachedContainer()['%s-%s' % (user_id, selection_name)])
else:
del(self._getPersistentContainer(user_id)[selection_name])
def _deleteGlobalSelectionFromContainer(self, selection_name):
if not self.isMemcachedUsed():
if getattr(aq_base(self), 'selection_data', None) is not None:
for user_id in self.selection_data.keys():
mapping = self._getPersistentContainer(user_id)
if mapping.has_key(selection_name):
del(mapping[selection_name])
def _getSelectionNameListFromContainer(self):
if self.isMemcachedUsed():
return []
else:
user_id = self._getUserId()
if user_id is None: return []
return self._getPersistentContainer(user_id).keys()
def _getMemcachedContainer(self):
value = getattr(aq_base(self), '_v_selection_data', None)
if value is None:
plugin_path = self.getStorage()
value = self.getPortalObject().\
portal_memcached.getMemcachedDict(key_prefix='selection_tool',
plugin_path=plugin_path)
setattr(self, '_v_selection_data', value)
return value
def _getPersistentContainer(self, user_id):
if getattr(aq_base(self), 'selection_data', None) is None:
self.selection_data = PersistentMapping()
if not self.selection_data.has_key(user_id):
self.selection_data[user_id] = SelectionPersistentMapping()
return self.selection_data[user_id]
InitializeClass( SelectionTool )
class SelectionPersistentMapping(PersistentMapping):
"""A conflict-free PersistentMapping.
Like selection objects, the purpose is to only prevent restarting
transactions.
"""
def _p_independent(self) :
return 1
def _p_resolveConflict(self, oldState, savedState, newState):
# update keys that only savedState has
oldState = newState
# dict returned by PersistentMapping.__getstate__ contains the data
# under '_container' key in zope 2.7 and 'data' in zope 2.8
if 'data' in oldState:
oldState['data'].update(savedState['data'])
else:
oldState['_container'].update(savedState['_container'])
return oldState
class TreeListLine:
def __init__(self,object,is_pure_summary,depth, is_open,select_domain_dict,exception_uid_list):
self.object=object
self.is_pure_summary=is_pure_summary
self.depth=depth
self.is_open=is_open
self.select_domain_dict=select_domain_dict
self.exception_uid_list=exception_uid_list
def getObject(self):
return self.object
def getIsPureSummary(self):
return self.is_pure_summary
def getDepth(self):
return self.depth
def getIsOpen(self):
return self.is_open
def getSelectDomainDict(self):
return self.select_domain_dict
def getExceptionUidList(self):
return self.exception_uid_list
def makeTreeList(here, form, root_dict, report_path, base_category,
depth, unfolded_list, form_id, selection_name,
report_depth, is_report_opened=1, list_method=None,
filtered_portal_types=[] ,sort_on = (('id', 'ASC'),)):
"""
(object, is_pure_summary, depth, is_open, select_domain_dict)
select_domain_dict is a dictionary of associative list of (id, domain)
"""
if isinstance(report_path, str):
report_path = report_path.split('/')
portal_categories = getattr(form, 'portal_categories', None)
portal_domains = getattr(form, 'portal_domains', None)
portal_object = form.portal_url.getPortalObject()
if len(report_path):
base_category = report_path[0]
if root_dict is None:
root_dict = {}
is_empty_level = 1
while is_empty_level:
if not root_dict.has_key(base_category):
root = None
if portal_categories is not None:
if portal_categories._getOb(base_category, None) is not None:
if base_category == 'parent':
# parent has a special treatment
root = root_dict[base_category] = root_dict[None] = here
report_path = report_path[1:]
else:
root = root_dict[base_category] = root_dict[None] = \
portal_categories[base_category]
report_path = report_path[1:]
if root is None and portal_domains is not None:
if portal_domains._getOb(base_category, None) is not None:
root = root_dict[base_category] = root_dict[None] = \
portal_domains[base_category]
report_path = report_path[1:]
if root is None:
try:
root = root_dict[None] = \
portal_object.unrestrictedTraverse(report_path)
except KeyError:
LOG('SelectionTool', INFO, "Not found %s" % str(report_path))
root = None
report_path = ()
else:
root = root_dict[None] = root_dict[base_category]
report_path = report_path[1:]
is_empty_level = (root is not None) and \
(root.objectCount() == 0) and (len(report_path) != 0)
if is_empty_level:
base_category = report_path[0]
tree_list = []
if root is None:
return tree_list
if base_category == 'parent':
# Use searchFolder as default
if list_method is None:
if hasattr(aq_base(root), 'objectValues'):
# If this is a folder, try to browse the hierarchy
object_list = root.searchFolder(sort_on=sort_on)
else:
if filtered_portal_types not in [[],None,'']:
object_list = list_method(portal_type=filtered_portal_types,
sort_on=sort_on)
else:
object_list = list_method(sort_on=sort_on)
for zo in object_list:
o = zo.getObject()
if o is not None:
new_root_dict = root_dict.copy()
new_root_dict[None] = new_root_dict[base_category] = o
selection_domain = DomainSelection(domain_dict = new_root_dict)
if (report_depth is not None and depth <= (report_depth - 1)) or \
o.getRelativeUrl() in unfolded_list:
exception_uid_list = [] # Object we do not want to display
for sub_zo in o.searchFolder(sort_on=sort_on):
sub_o = sub_zo.getObject()
if sub_o is not None and hasattr(aq_base(root), 'objectValues'):
exception_uid_list.append(sub_o.getUid())
# Summary (open)
tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, exception_uid_list)]
if is_report_opened :
# List (contents, closed, must be strict selection)
tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, exception_uid_list)]
tree_list += makeTreeList(here, form, new_root_dict, report_path,
base_category, depth + 1, unfolded_list, form_id,
selection_name, report_depth,
is_report_opened=is_report_opened, sort_on=sort_on)
else:
tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, ())] # Summary (closed)
else:
# process to recover objects in case a generation script is used
if hasattr(root,'getChildDomainValueList'):
oblist = root.getChildDomainValueList(root,depth=depth)
else:
oblist = root.objectValues()
for o in oblist:
new_root_dict = root_dict.copy()
new_root_dict[None] = new_root_dict[base_category] = o
selection_domain = DomainSelection(domain_dict = new_root_dict)
if (report_depth is not None and depth <= (report_depth - 1)) or o.getRelativeUrl() in unfolded_list:
tree_list += [TreeListLine(o, 1, depth, 1, selection_domain, None)] # Summary (open)
if is_report_opened :
tree_list += [TreeListLine(o, 0, depth, 0, selection_domain, None)] # List (contents, closed, must be strict selection)
tree_list += makeTreeList(here, form, new_root_dict, report_path, base_category, depth + 1,
unfolded_list, form_id, selection_name, report_depth,
is_report_opened=is_report_opened, sort_on=sort_on)
else:
tree_list += [TreeListLine(o, 1, depth, 0, selection_domain, None)] # Summary (closed)
return tree_list
# Automaticaly add wrappers on Folder so it can access portal_selections.
# Cannot be done in ERP5Type/Document/Folder.py because ERP5Type must not
# depend on ERP5Form.
from Products.CMFCore.utils import getToolByName
from Products.ERP5Type.Core.Folder import FolderMixIn
from ZPublisher.mapply import mapply
method_id_filter_list = [x for x in FolderMixIn.__dict__ if callable(getattr(FolderMixIn, x))]
candidate_method_id_list = [x for x in SelectionTool.__dict__ if callable(getattr(SelectionTool, x)) and not x.startswith('_') and not x.endswith('__roles__') and x not in method_id_filter_list]
# Monkey patch FolderMixIn with SelectionTool methods
# kept here for compatibility with previous implementations
# of Listbox HTML renderer. See bellow new implementation
for property_id in candidate_method_id_list:
def portal_selection_wrapper(self, wrapper_property_id=property_id, *args, **kw):
"""
Wrapper method for SelectionTool.
"""
portal_selection = getToolByName(self, 'portal_selections')
request = self.REQUEST
method = getattr(portal_selection, wrapper_property_id)
return mapply(method, positional=args, keyword=request,
context=self, bind=1)
setattr(FolderMixIn, property_id, portal_selection_wrapper)
security_property_id = '%s__roles__' % (property_id, )
security_property = getattr(SelectionTool, security_property_id, None)
if security_property is not None:
setattr(FolderMixIn, security_property_id, security_property)
def createFolderMixInPageSelectionMethod(listbox_id):
"""
This method must be called by listbox at rendering time.
It dynamically creates methods on FolderMixIn in line
with the naming of the listbox field. Generated method
are able to convert request parameters in order to
mimic the API of a listbox with ID "listbox". This
approach was required for example to implement
multiple multi-page listboxes in view mode. It also
opens the way towards multiple editable listboxes in the same
page although this is something which we can not recommend.
"""
# Immediately return in the method already exists
test_method_id = "%s_nextPage" % listbox_id
if hasattr(FolderMixIn, test_method_id):
return
# Monkey patch FolderMixIn
for property_id in candidate_method_id_list:
def portal_selection_wrapper(self, wrapper_listbox_id=listbox_id,
wrapper_property_id=property_id, *args, **kw):
"""
Wrapper method for SelectionTool.
"""
portal_selection = getToolByName(self, 'portal_selections')
request = self.REQUEST
selection_name_property_id = "%s_list_selection_name" % listbox_id
listbox_uid_property_id = "%s_uid" % listbox_id
list_start_property_id = "%s_list_start" % listbox_id
page_start_property_id = "%s_page_start" % listbox_id
# Rename request parameters
if request.has_key(selection_name_property_id):
request.form['list_selection_name'] = request[selection_name_property_id]
if request.has_key(listbox_uid_property_id):
request.form['listbox_uid'] = request[listbox_uid_property_id]
if request.has_key(list_start_property_id):
request.form['list_start'] = request[list_start_property_id]
if request.has_key(page_start_property_id):
request.form['page_start'] = request[page_start_property_id]
# Call the wrapper
method = getattr(portal_selection, wrapper_property_id)
return mapply(method, positional=args, keyword=request,
context=self, bind=1)
new_property_id = "%s_%s" % (listbox_id, property_id)
setattr(FolderMixIn, new_property_id, portal_selection_wrapper)
security_property_id = '%s__roles__' % (property_id, )
security_property = getattr(SelectionTool, security_property_id, None)
if security_property is not None:
new_security_property_id = '%s__roles__' % (new_property_id, )
setattr(FolderMixIn, new_security_property_id, security_property)