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
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2002 Nexedi SARL and Contributors. All Rights Reserved.
# Sebastien Robin <seb@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability 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
# garantees 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 Products.ERP5SyncML.XMLSyncUtils import XMLSyncUtilsMixin
from Products.ERP5SyncML.Conflict import Conflict
from Products.CMFCore.utils import getToolByName
from DateTime.DateTime import DateTime
from email.MIMEBase import MIMEBase
from email import Encoders
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, interfaces
from Globals import PersistentMapping
import pickle
from xml.sax.saxutils import escape, unescape
from cStringIO import StringIO
import re
import cStringIO
import string
from lxml import etree
parser = etree.XMLParser(remove_blank_text=True)
from xml.marshal.generic import loads as unmarshaler
from zLOG import LOG, INFO, DEBUG
from base64 import standard_b64decode
from OFS.Image import Pdata
class ERP5Conduit(XMLSyncUtilsMixin):
"""
A conduit is a piece of code in charge of
- updating an object attributes from an XUpdate XML stream
(Conduits are not in charge of creating new objects which
are eventually missing in a synchronisation process)
If an object has be created during a synchronisation process,
the way to proceed consists in:
1- creating an empty instance of the appropriate class
in the appropriate directory
2- updating that empty instance with the conduit
The first implementation of ERP5 synchronisation
will define a default location to create new objects and
a default class. This will be defined at the level of the synchronisation
tool
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx
Look carefully when we are adding elements,
for example, when we do 'insert-after', with 2 xupdate:element,
so adding 2 differents objects, actually it adds only XXXX one XXX object
In this case the getSubObjectDepth(), doesn't have
too much sence
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
There is also one problem, when we synchronize a conflict, we are not waiting
the response of the client, so that we are not sure if it take into account,
we may have CONFLICT_NOT_SYNCHRONIZED AND CONFLICT_SYNCHRONIZED
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
"""
# Declarative interfaces
__implements__ = ( interfaces.IConduit, )
# Declarative security
security = ClassSecurityInfo()
security.declareProtected(Permissions.AccessContentsInformation,'getEncoding')
def getEncoding(self):
"""
return the string corresponding to the local encoding
"""
#return "iso-8859-1"
return "utf-8"
security.declareProtected(Permissions.ModifyPortalContent, '__init__')
def __init__(self):
self.args = {}
security.declareProtected(Permissions.ModifyPortalContent, 'addNode')
def addNode(self, xml=None, object=None, previous_xml=None,
object_id=None, sub_object=None, force=0, simulate=0,
reset=0, **kw):
"""
A node is added
xml : the xml wich contains what we want to add
object : from where we want to add something
previous_xml : the previous xml of the object, if any
force : apply updates even if there's a conflict
This fucntion returns conflict_list, wich is of the form,
[conflict1,conflict2,...] where conclict1 is of the form :
[object.getPath(),keyword,local_and_actual_value,subscriber_value]
"""
reset_local_roles = 0
reset_workflow = 0
conflict_list = []
xml = self.convertToXml(xml)
#LOG('ERP5Conduit addNode:',DEBUG,etree.tostring(xml,pretty_print=True))
if xml is None:
return {'conflict_list': conflict_list, 'object': sub_object}
# In the case where this new node is a object to add
if xml.xpath('name()') in self.XUPDATE_INSERT_OR_ADD and \
self.getSubObjectDepth(xml) == 0:
if self.isHistoryAdd(xml) != -1: # bad hack XXX to be removed
for element in self.getXupdateElementList(xml):
xml = self.getElementFromXupdate(element)
conflict_list += self.addNode(
xml=xml,
object=object,
previous_xml=previous_xml,
force=force,
simulate=simulate,
reset=reset, **kw)['conflict_list']
elif xml.xpath('local-name()') == self.xml_object_tag:
if object_id is None:
object_id = self.getAttribute(xml, 'id')
if object_id is not None:
if sub_object is None:
try:
sub_object = object._getOb(object_id)
except (AttributeError, KeyError, TypeError):
sub_object = None
if sub_object is None: # If so, it doesn't exist
portal_type = ''
if xml.xpath('local-name()') == self.xml_object_tag:
portal_type = self.getObjectType(xml)
elif xml.xpath('name()') in self.XUPDATE_INSERT_OR_ADD: # Deprecated ???
portal_type = self.getXupdateObjectType(xml) # Deprecated ???
sub_object, reset_local_roles, reset_workflow = self.constructContent(
object,
object_id,
portal_type)
self.newObject(
object=sub_object,
xml=xml,
simulate=simulate,
reset=reset,
reset_local_roles=reset_local_roles,
reset_workflow=reset_workflow)
elif xml.xpath('name()') in self.XUPDATE_INSERT_OR_ADD \
and self.getSubObjectDepth(xml) >= 1:
sub_object_id = self.getSubObjectId(xml)
if previous_xml is not None and sub_object_id is not None:
# Find the previous xml corresponding to this subobject
sub_previous_xml = self.getSubObjectXml(sub_object_id, previous_xml)
#LOG('addNode', DEBUG,'isSubObjectModification sub_previous_xml: %s' % str(sub_previous_xml))
if sub_previous_xml is not None:
sub_object = None
try:
sub_object = object._getOb(sub_object_id)
except (AttributeError, KeyError, TypeError):
pass
if sub_object is not None:
#LOG('addNode', DEBUG, 'subobject.id: %s' % sub_object.id)
# Change the xml in order to directly apply
# modifications to the subobject
sub_xml = self.getSubObjectXupdate(xml)
#LOG('addNode', DEBUG, 'sub_xml: %s' % str(sub_xml))
# Then do the udpate
conflict_list += self.addNode(xml=sub_xml,object=sub_object,
previous_xml=sub_previous_xml, force=force,
simulate=simulate, reset=reset, **kw)['conflict_list']
elif (xml.xpath('local-name()') == self.history_tag \
or self.isHistoryAdd(xml) > 0) and not reset:
conflict_list += self.addWorkflowNode(object, xml, simulate)
#elif xml.tag in self.local_role_list or self.isLocalRole(xml)>0 and not simulate:
elif xml.xpath('local-name()') in self.local_role_list:
self.addLocalRoleNode(object, xml)
elif xml.xpath('local-name()') in self.local_permission_list:
conflict_list += self.addLocalPermissionNode(object, xml)
else:
conflict_list += self.updateNode(xml=xml,object=object, force=force,
simulate=simulate, reset=reset, **kw)
# We must returns the object created
return {'conflict_list':conflict_list, 'object': sub_object}
security.declareProtected(Permissions.ModifyPortalContent, 'deleteNode')
def deleteNode(self, xml=None, object=None, object_id=None, force=None,
simulate=0, reset=0, **kw):
"""
A node is deleted
"""
# In the case where we have to delete an object
#LOG('ERP5Conduit.deleteNode', DEBUG, 'deleteNode, object path: %s' % repr(object.getPhysicalPath()))
#LOG('ERP5Conduit deleteNode', DEBUG,"%s" % object_id)
#LOG('ERP5Conduit deleteNode', DEBUG,"%s" % xml)
conflict_list = []
if xml is not None:
xml = self.convertToXml(xml)
#LOG('ERP5Conduit deleteNode', DEBUG,"%s" % etree.tostring(xml,pretty_print=True))
if object_id is None:
#LOG('ERP5Conduit.deleteNode', DEBUG, 'deleteNode, SubObjectDepth: %i' % self.getSubObjectDepth(xml))
if xml.xpath('local-name()') == self.xml_object_tag:
object_id = self.getAttribute(xml,'id')
elif self.getSubObjectDepth(xml) == 1:
object_id = self.getSubObjectId(xml)
elif self.getSubObjectDepth(xml) == 2:
# we have to call delete node on a subsubobject
sub_object_id = self.getSubObjectId(xml)
try:
sub_object = object._getOb(sub_object_id)
sub_xml = self.getSubObjectXupdate(xml)
conflict_list += self.deleteNode(xml=sub_xml,object=sub_object,
force=force, simulate=simulate,
reset=reset, **kw)
except (KeyError, AttributeError, TypeError):
#LOG('ERP5Conduit.deleteNode', DEBUG, 'deleteNode, Unable to delete SubObject: %s' % str(sub_object_id))
pass
if object_id is not None: # We do have an object_id
self.deleteObject(object, object_id)
# In the case where we have to delete an user role
# If we are still there, this means the delete is for this node
elif xml.xpath('name()') in self.XUPDATE_DEL:
xml = self.getElementFromXupdate(xml)
if xml.xpath('local-name()') in self.local_role_list and not simulate:
# We want to del a local role
user = self.getAttribute(xml,'id')
#LOG('ERP5Conduit.deleteNode local_role: ', DEBUG, 'user: %s' % repr(user))
if xml.xpath('local-name()') == self.local_role_tag:
object.manage_delLocalRoles([user])
elif xml.xpath('local-name()') ==self.local_group_tag:
object.manage_delLocalGroupRoles([user])
if xml.xpath('local-name()') in self.local_permission_list and not simulate:
permission = self.getAttribute(xml,'id')
object.manage_setLocalPermissions(permission)
return conflict_list
security.declareProtected(Permissions.ModifyPortalContent, 'deleteObject')
def deleteObject(self, object, object_id):
try:
object._delObject(object_id)
except (AttributeError, KeyError):
#LOG('ERP5Conduit.deleteObject', DEBUG, 'Unable to delete: %s' % str(object_id))
pass
security.declareProtected(Permissions.ModifyPortalContent, 'updateNode')
def updateNode(self, xml=None, object=None, previous_xml=None, force=0,
simulate=0, reset=0, **kw):
"""
A node is updated with some xupdate
- xml : the xml corresponding to the update, it should be xupdate
- object : the object on wich we want to apply the xupdate
- [previous_xml] : the previous xml of the object, it is mandatory
when we have sub objects
"""
conflict_list = []
if xml is None:
return {'conflict_list':conflict_list, 'object':object}
xml = self.convertToXml(xml)
#LOG('ERP5Conduit.updateNode', DEBUG, 'xml.tag: %s' % xml.tag)
#LOG('ERP5Conduit.updateNode, force: ', DEBUG, force)
# we have an xupdate xml
#LOG('ERP5Conduit updateNode', DEBUG, "%s" % etree.tostring(xml,pretty_print=True))
if xml.xpath('name()') == 'xupdate:modifications':
conflict_list += self.applyXupdate(object=object,
xupdate=xml,
conduit=self,
previous_xml=previous_xml,
force=force,
simulate=simulate,
reset=reset,
**kw)
# we may have only the part of an xupdate
else:
args = {}
if self.isProperty(xml):
keyword = None
value = xml.attrib.get('select', None)
if value is not None:
select_list = value.split('/') # Something like:
#('','object[1]','sid[1]')
new_select_list = ()
for select_item in select_list:
if select_item.find('[') >= 0:
select_item = select_item[:select_item.find('[')]
new_select_list += (select_item,)
select_list = new_select_list # Something like : ('','object','sid')
keyword = select_list[len(select_list)-1] # this will be 'sid'
data = None
if xml.xpath('name()') not in self.XUPDATE_INSERT_OR_ADD:
for subnode in xml:
if subnode.xpath('name()') in self.XUPDATE_EL:
keyword = subnode.attrib.get('name', None)
data_xml = subnode
else:
#We can call add node
conflict_list += self.addNode(xml=xml,
object=object,
force=force,
simulate=simulate,
reset=reset,
**kw)
return conflict_list
if xml.xpath('name()') in self.XUPDATE_DEL:
conflict_list += self.deleteNode(xml=xml,
object=object,
force=force,
simulate=simulate,
reset=reset,
**kw)
return conflict_list
if keyword is None: # This is not a selection, directly the property
keyword = xml.xpath('name()')
if not (keyword in self.NOT_EDITABLE_PROPERTY):
# We will look for the data to enter
data_type = object.getPropertyType(keyword)
#LOG('ERP5Conduit.updateNode', DEBUG, 'data_type: %s for keyword: %s' % (str(data_type), keyword))
data = self.convertXmlValue(xml, data_type=data_type)
args[keyword] = data
args = self.getFormatedArgs(args=args)
# This is the place where we should look for conflicts
# For that we need :
# - data : the data from the remote box
# - old_data : the data from this box but at the time of the i
#last synchronization
# - current_data : the data actually on this box
isConflict = 0
if (previous_xml is not None) and (not force):
# if no previous_xml, no conflict
old_data = self.getObjectProperty(keyword, previous_xml,
data_type=data_type)
#current_data = object.getProperty(keyword)
current_data = self.getProperty(object, keyword)
#LOG('ERP5Conduit.updateNode', DEBUG, 'Conflict data: %s' % str(data))
#LOG('ERP5Conduit.updateNode', DEBUG, 'Conflict old_data: %s' % str(old_data))
#LOG('ERP5Conduit.updateNode', DEBUG, 'Conflict current_data: %s' % str(current_data))
if (old_data != current_data) and (data != current_data) \
and keyword not in self.force_conflict_list:
#LOG('ERP5Conduit.updateNode', DEBUG, 'Conflict on : %s' % keyword)
# Hack in order to get the synchronization working for demo
# XXX this have to be removed after
#if not (data_type in self.binary_type_list):
if 1:
# This is a conflict
isConflict = 1
xml_string = etree.tostring(xml, encoding='utf-8')
conflict = Conflict(object_path=object.getPhysicalPath(),
keyword=keyword)
conflict.setXupdate(xml_string)
if not (data_type in self.binary_type_list):
conflict.setLocalValue(current_data)
conflict.setRemoteValue(data)
conflict_list += [conflict]
# We will now apply the argument with the method edit
if args != {} and (isConflict == 0 or force) and \
(not simulate or reset):
self.editDocument(object=object, **args)
# It is sometimes required to do something after an edit
if getattr(object, 'manage_afterEdit', None) is not None:
object.manage_afterEdit()
if keyword == 'object':
# This is the case where we have to call addNode
conflict_list += self.addNode(xml=xml,
object=object,
force=force,
simulate=simulate,
reset=reset,
**kw)['conflict_list']
elif keyword == self.history_tag and not simulate:
# This is the case where we have to call addNode
conflict_list += self.addNode(xml=subnode, object=object,
force=force, simulate=simulate,
reset=reset, **kw)['conflict_list']
elif keyword in (self.local_role_tag, self.local_permission_tag) and not simulate:
# This is the case where we have to update Roles or update permission
#LOG('ERP5Conduit.updateNode', DEBUG, 'we will add a local role')
#user = self.getSubObjectId(xml)
#roles = self.convertXmlValue(data,data_type='tokens')
#object.manage_setLocalRoles(user,roles)
xml = self.getElementFromXupdate(xml)
conflict_list += self.addNode(xml=xml, object=object,
force=force, simulate=simulate,
reset=reset, **kw)['conflict_list']
elif self.isSubObjectModification(xml):
# We should find the object corresponding to
# this update, so we have to look in the previous_xml
sub_object_id = self.getSubObjectId(xml)
#LOG('ERP5Conduit.updateNode', DEBUG,'isSubObjectModification sub_object_id: %s' % sub_object_id)
if previous_xml is not None and sub_object_id is not None:
sub_previous_xml = self.getSubObjectXml(sub_object_id, previous_xml)
#LOG('ERP5Conduit.updateNode', DEBUG, 'isSubObjectModification sub_previous_xml: %s' % str(sub_previous_xml))
sub_object = None
try:
sub_object = object._getOb(sub_object_id)
except KeyError:
pass
if sub_object is not None:
#LOG('ERP5Conduit.updateNode', DEBUG, 'subobject.id: %s' % sub_object.id)
# Change the xml in order to directly apply
# modifications to the subobject
sub_xml = self.getSubObjectXupdate(xml)
#LOG('ERP5Conduit.updateNode', DEBUG, 'sub_xml: %s' % str(sub_xml))
# Then do the udpate
conflict_list += self.updateNode(xml=sub_xml, object=sub_object,
force=force,
previous_xml=sub_previous_xml,
simulate=simulate, reset=reset, **kw)
elif previous_xml is None and xml is not None and sub_object_id is not None:
sub_object = None
try:
sub_object = object[sub_object_id]
except KeyError:
pass
if sub_object is not None:
sub_xml = self.getSubObjectXupdate(xml)
conflict_list += self.updateNode(xml=sub_xml,
object=sub_object,
force=force,
simulate=simulate,
reset=reset,
**kw)
return conflict_list
security.declareProtected(Permissions.AccessContentsInformation,
'getFormatedArgs')
def getFormatedArgs(self, args=None):
"""
This lookd inside the args dictionnary and then
convert any unicode string to string
"""
new_args = {}
for keyword in args.keys():
data = args[keyword]
if isinstance(keyword, unicode):
keyword = keyword.encode(self.getEncoding())
if isinstance(data, (tuple, list)):
new_data = []
for item in data:
if isinstance(item, unicode):
item = item.encode(self.getEncoding())
new_data.append(item)
data = new_data
if isinstance(data, unicode):
data = data.encode(self.getEncoding())
if keyword == 'binary_data':
#LOG('ERP5Conduit.getFormatedArgs', DEBUG, 'binary_data keyword: %s' % str(keyword))
msg = MIMEBase('application','octet-stream')
Encoders.encode_base64(msg)
msg.set_payload(data)
data = msg.get_payload(decode=1)
new_args[keyword] = data
return new_args
security.declareProtected(Permissions.AccessContentsInformation, 'isProperty')
def isProperty(self, xml):
"""
Check if it is a simple property
not an attribute @type it's a metadata
"""
bad_list = (self.sub_object_exp, self.history_exp, self.attribute_type_exp,)
value = xml.attrib.get('select', None)
if value is not None:
for bad_string in bad_list:
if bad_string.search(value) is not None:
return 0
return 1
security.declareProtected(Permissions.AccessContentsInformation,
'getSubObjectXupdate')
def getSubObjectXupdate(self, xml):
"""
This will change the xml in order to change the update
from the object to the subobject
"""
from copy import deepcopy
xml_copy = deepcopy(xml)
self.changeSubObjectSelect(xml_copy)
return xml_copy
security.declareProtected(Permissions.AccessContentsInformation,
'isHistoryAdd')
def isHistoryAdd(self, xml):
bad_list = (self.history_exp,)
value = xml.attrib.get('select')
if value is not None:
for bad_string in bad_list:
if bad_string.search(value) is not None:
if self.bad_history_exp.search(value) is None:
return 1
else:
return -1
return 0
security.declareProtected(Permissions.AccessContentsInformation,
'isSubObjectModification')
def isSubObjectModification(self, xml):
"""
Check if it is a modification from an subobject
"""
good_list = (self.sub_object_exp,)
value = xml.attrib.get('select', None)
if value is not None:
for good_string in good_list:
if good_string.search(value) is not None:
return 1
return 0
security.declareProtected(Permissions.AccessContentsInformation,
'getSubObjectDepth')
def getSubObjectDepth(self, xml):
"""
Give the Depth of a subobject modification
0 means, no depth
1 means it is a subobject
2 means it is more depth than subobject
"""
#LOG('getSubObjectDepth',0,'xml.tag: %s' % xml.tag)
if xml.xpath('name()') in self.XUPDATE_TAG:
i = 0
if xml.xpath('name()') in self.XUPDATE_INSERT:
i = 1
#LOG('getSubObjectDepth',0,'xml2.tag: %s' % xml.tag)
value = xml.attrib.get('select', None)
if value is not None:
#LOG('getSubObjectDepth',0,'subnode.nodeValue: %s' % subnode.nodeValue)
if self.sub_sub_object_exp.search(value) is not None:
return 2 # This is sure in all cases
elif self.sub_object_exp.search(value) is not None:
#new_select = self.getSubObjectSelect(value) # Still needed ???
#if self.getSubObjectSelect(new_select) != new_select:
# return (2 - i)
#return (1 - i)
return (2 - i)
elif self.object_exp.search(value) is not None:
return (1 - i)
return 0
security.declareProtected(Permissions.ModifyPortalContent,
'changeSubObjectSelect')
def changeSubObjectSelect(self, xml):
"""
Return a string wich is the selection for the subobject
ex: for "/object[@id='161']/object[@id='default_address']/street_address"
it returns "/object[@id='default_address']/street_address"
"""
select = xml.attrib.get('select')
if self.object_exp.search(select) is not None:
s = '/'
if re.search('/.*/', select) is not None: # This means we have more than just object
new_value = select[select.find(s, select.find(s)+1):]
else:
new_value = '/'
select = new_value
xml.attrib['select'] = select
security.declareProtected(Permissions.AccessContentsInformation,
'getSubObjectId')
def getSubObjectId(self, xml):
"""
Return the id of the subobject in an xupdate modification
"""
object_id = None
value = xml.attrib.get('select', None)
if value is not None:
if self.object_exp.search(value) is not None:
s = "'"
first = value.find(s) + 1
object_id = value[first:value.find(s, first)]
return object_id
return object_id
security.declareProtected(Permissions.AccessContentsInformation,
'getHistoryIdFromSelect')
def getHistoryIdFromSelect(self, xml):
"""
Return the id of the subobject in an xupdate modification
"""
object_id = None
value = xml.attrib.get('select', None)
if value is not None:
if self.history_exp.search(value) is not None:
s = self.history_tag
object_id = value[value.find(s):]
object_id = object_id[object_id.find("'") + 1:]
object_id = object_id[:object_id.find("'")]
return object_id
return object_id
security.declareProtected(Permissions.AccessContentsInformation,
'getSubObjectXml')
def getSubObjectXml(self, object_id, xml):
"""
Return the xml of the subobject which as the id object_id
"""
xml = self.convertToXml(xml)
for subnode in xml:
if subnode.xpath('local-name()') == self.xml_object_tag:
if object_id == self.getAttribute(subnode, 'id'):
return subnode
return None
security.declareProtected(Permissions.AccessContentsInformation,'getAttribute')
def getAttribute(self, xml, param):
"""
Retrieve the given parameter from the xml
"""
return xml.attrib.get(param, None)
security.declareProtected(Permissions.AccessContentsInformation,'getObjectProperty')
def getObjectProperty(self, property, xml, data_type=None):
"""
Retrieve the given property
"""
xml = self.convertToXml(xml)
# document, with childNodes[0] a DocumentType and childNodes[1] the Element Node
for subnode in xml:
if subnode.xpath('local-name()') == property:
return self.convertXmlValue(subnode)
return None
def replaceIdFromXML(self, xml, new_id):
"""
return a xml with id replace by a new id
"""
if xml is not None and new_id is not None:
if isinstance(xml, str):
xml = etree.XML(xml)
#copy of xml object for modification
from copy import deepcopy
xml_copy = deepcopy(xml)
if xml.nsmap is None or xml.nsmap == {}:
object_element = xml_copy.find(self.xml_object_tag)
id_element = object_element.find('id')
else:
object_element = xml_copy.xpath('//syncml:object',
namespaces={'syncml':xml_copy.nsmap[xml_copy.prefix]})[0]
id_element = object_element.xpath('//syncml:id',
namespaces={'syncml':xml_copy.nsmap[xml_copy.prefix]})[0]
object_element.attrib['id'] = new_id
id_element.text = new_id
return etree.tostring(xml_copy)
def getXMLFromObjectWithId(self, object, xml_mapping):
"""
return the xml with Id of Object
"""
xml = ''
if xml_mapping is None:
return xml
func = getattr(object, xml_mapping, None)
if func is not None:
xml = func()
return xml
def getXMLFromObjectWithGid(self, object, gid, xml_mapping=None):
"""
return the xml with Gid of Object
"""
xml_id = self.getXMLFromObjectWithId(object, xml_mapping)
xml_gid = self.replaceIdFromXML(xml_id, gid)
return xml_gid
def getXMLFromObjectWithRid(self, object, rid, xml_mapping=None):
"""
return the xml with Rid of Object
"""
xml_id = self.getXMLFromObjectWithId(object, xml_mapping)
xml_rid = self.replaceIdFromXML(xml_id, rid)
return xml_rid
security.declareProtected(Permissions.AccessContentsInformation,'convertToXml')
def convertToXml(self, xml):
"""
if xml is a string, convert it to a node
"""
if xml is None: return None
if isinstance(xml, (str, unicode)):
if isinstance(xml, unicode):
xml = xml.encode('utf-8')
xml = etree.XML(xml, parser=parser)
# If we have the xml from the node erp5, we just take the subnode
if xml.xpath('local-name()') == 'erp5':
xml = xml[0]
return xml
security.declareProtected(Permissions.AccessContentsInformation,'getObjectType')
def getObjectType(self, xml):
"""
Retrieve the portal type from an xml
"""
return xml.get('portal_type')
security.declareProtected(Permissions.AccessContentsInformation,'getPropertyType')
def getPropertyType(self, xml):
"""
Retrieve the portal type from an xml
"""
return xml.get('type')
security.declareProtected(Permissions.AccessContentsInformation,'getXupdateObjectType')
def getXupdateObjectType(self, xml):
"""
Retrieve the portal type from an xupdate
XXXX This should not be used any more !!! XXXXXXXXXXX
"""
return xml.xpath('string(.//*[name() == "xupdate:attribute"][@name = "portal_type"])') or None
security.declareProtected(Permissions.ModifyPortalContent, 'newObject')
def newObject(self, object=None, xml=None, simulate=0, reset=0,
reset_local_roles=1, reset_workflow=1):
"""
modify the object with datas from
the xml (action section)
"""
args = {}
if simulate:
return
# Retrieve the list of users with a role and delete default roles
if reset_local_roles:
user_role_list = [x[0] for x in object.get_local_roles()]
object.manage_delLocalRoles(user_role_list)
if getattr(object, 'workflow_history', None) is not None and reset_workflow:
object.workflow_history = PersistentMapping()
if xml.xpath('name()').find('xupdate') >= 0:
xml = xml[0]
for subnode in xml.xpath('*'):
#get only Element nodes (not Comments or Processing instructions)
if subnode.xpath('name()') not in self.NOT_EDITABLE_PROPERTY:
keyword_type = self.getPropertyType(subnode)
# This is the case where the property is a list
keyword = subnode.xpath('name()')
args[keyword] = self.convertXmlValue(subnode, keyword_type)
elif subnode.xpath('local-name()') in self.ADDABLE_PROPERTY + (self.xml_object_tag,):
self.addNode(object=object, xml=subnode, force=1)
# We should first edit the object
args = self.getFormatedArgs(args=args)
# edit the object with a dictionnary of arguments,
# like {"telephone_number":"02-5648"}
self.editDocument(object=object, **args)
if getattr(object, 'manage_afterEdit', None) is not None:
object.manage_afterEdit()
self.afterNewObject(object)
## Then we may create subobject
#for subnode in xml:
#if subnode.tag in (self.xml_object_tag,): #,self.history_tag):
#self.addNode(object=object, xml=subnode)
security.declareProtected(Permissions.AccessContentsInformation,'afterNewObject')
def afterNewObject(self, object):
pass
security.declareProtected(Permissions.AccessContentsInformation,'getStatusFromXml')
def getStatusFromXml(self, xml):
"""
Return a worklow status from xml
"""
status = {}
for subnode in xml:
keyword = subnode.xpath('name()')
value = self.getObjectProperty(keyword, xml)
status[keyword] = value
return status
security.declareProtected(Permissions.AccessContentsInformation,'getXupdateElementList')
def getXupdateElementList(self, xml):
"""
Retrieve the list of xupdate:element subnodes
"""
return xml.xpath('|'.join(['.//*[name() = "%s"]' % name for name in self.XUPDATE_EL]))
security.declareProtected(Permissions.AccessContentsInformation,'getElementFromXupdate')
def getElementFromXupdate(self, xml):
"""
from a xupdate:element returns the element as xml
"""
if xml.xpath('name()') in self.XUPDATE_EL:
result = '<'
tag_name = xml.attrib.get('name')
result += tag_name
for subnode in xml:
if subnode.xpath('name()') == 'xupdate:attribute':
result += ' %s=' % subnode.attrib.get('name')
result += '"%s"' % subnode.text
result += '>'
# Then dumps the xml and remove what we does'nt want
xml_string = self.nodeToString(xml)
maxi = max(xml_string.find('>') + 1, \
xml_string.rfind('</xupdate:attribute>')+len('</xupdate:attribute>'))
result += xml_string[maxi:xml_string.find('</xupdate:element>')]
result += '</%s>' % tag_name
return self.convertToXml(result)
if xml.xpath('name()') in (self.XUPDATE_UPDATE + self.XUPDATE_DEL):
result = u'<'
attribute = xml.attrib.get('select')
s = '[@id='
s_place = attribute.find(s)
select_id = None
if (s_place > 0):
select_id = attribute[s_place+len(s):]
select_id = select_id[:select_id.find("'",1)+1]
else:
s_place = len(attribute)
property = attribute[:s_place].strip('/')
result += property
if select_id is not None:
result += ' id=%s' % select_id
result += '>'
xml_string = self.nodeToString(xml)
maxi = xml_string.find('>')+1
result += xml_string[maxi:xml_string.find('</%s>' % xml.xpath('name()'))]
result += '</%s>' % (property)
#LOG('getElementFromXupdate, result:',0,repr(result))
return self.convertToXml(result)
return xml
security.declareProtected(Permissions.AccessContentsInformation,'getWorkflowActionFromXml')
def getWorkflowActionFromXml(self, xml):
"""
Return the list of workflow actions
"""
action_list = []
if xml.xpath('name()') in self.XUPDATE_EL:
action_list.append(xml)
return action_list
for subnode in xml:
if subnode.xpath('local-name()') == self.action_tag:
action_list.append(subnode)
return action_list
security.declareProtected(Permissions.AccessContentsInformation,'convertXmlValue')
def convertXmlValue(self, node, data_type=None):
"""
It is possible that the xml change the value, for example
there is some too much '\n' and some spaces. We have to do some extra
things so that we convert correctly the value
XXXNicolas: I'm totally disagree with, so i comment this code
"""
if node is None: return None
if data_type is None:
data_type = self.getPropertyType(node)
if data_type == self.none_type: return None
data = node.text
if data is not None and isinstance(data, unicode):
data = data.encode('utf-8')
elif data is None:
if data_type in self.list_type_list:
return ()
elif data_type in self.text_type_list:
return ''
# We can now convert string in tuple, dict, binary...
if data_type in self.list_type_list:
data = unmarshaler(node.text)
elif data_type in self.text_type_list:
data = unescape(data)
elif data_type in self.data_type_list:
if data is None:
# data is in blocks
data = ''.join([standard_b64decode(block.text) \
for block in node.iterchildren()])
elif data_type in self.pickle_type_list:
data = pickle.loads(standard_b64decode(data))
elif data_type in self.date_type_list:
data = DateTime(data)
elif data_type in self.int_type_list:
data = int(data)
elif data_type in self.dict_type_list: # only usefull for CPS, with data = '{fr:1}'
if data == '{}':
data = {}
else:
dict_list = map(lambda x:x.split(':'), data[1:-1].split(','))
data = map(lambda (x,y):(x.replace(' ','').replace("'",''),int(y)),dict_list)
data = dict(data)
return data
# XXX is it the right place ? It should be in XupdateUtils, but here we
# have some specific things to do
security.declareProtected(Permissions.ModifyPortalContent, 'applyXupdate')
def applyXupdate(self, object=None, xupdate=None, conduit=None, force=0,
simulate=0, reset=0, **kw):
"""
Parse the xupdate and then it will call the conduit
"""
conflict_list = []
if isinstance(xupdate, (str, unicode)):
xupdate = etree.XML(xupdate, parser=parser)
#LOG("applyXupdate xupdate",debug, "%s" % etree.tostring(xupdate,pretty_print=True))
for subnode in xupdate:
sub_xupdate = self.getSubObjectXupdate(subnode)
selection_name = ''
if subnode.xpath('name()') in self.XUPDATE_INSERT_OR_ADD:
conflict_list += conduit.addNode(xml=sub_xupdate,object=object,
force=force, simulate=simulate,
reset=reset, **kw)['conflict_list']
elif subnode.xpath('name()') in self.XUPDATE_DEL:
conflict_list += conduit.deleteNode(xml=sub_xupdate, object=object,
force=force, simulate=simulate,
reset=reset, **kw)
elif subnode.xpath('name()') in self.XUPDATE_UPDATE:
conflict_list += conduit.updateNode(xml=sub_xupdate, object=object,
force=force, simulate=simulate,
reset=reset, **kw)
return conflict_list
def isWorkflowActionAddable(self, object=None, status=None, wf_tool=None,
wf_id=None, xml=None):
"""
Some checking in order to check if we should add the workfow or not
We should not returns a conflict list as we wanted before, we should
instead go to a conflict state.
"""
# We first test if the status in not already inside the workflow_history
return 1
# XXX Disable for now
wf_history = object.workflow_history
if wf_history.has_key(wf_id):
action_list = wf_history[wf_id]
else: action_list = []
addable = 1
for action in action_list:
this_one = 1
for key in action.keys():
if status[key] != action[key]:
this_one = 0
break
if this_one:
addable = 0
break
return addable
security.declareProtected(Permissions.ModifyPortalContent, 'constructContent')
def constructContent(self, object, object_id, portal_type):
"""
This allows to specify how to construct a new content.
This is really usefull if you want to write your
own Conduit.
"""
#LOG('ERP5Conduit.addNode',0,'portal_type: |%s|' % str(portal_type))
object.newContent(portal_type=portal_type, id=object_id)
subobject = object._getOb(object_id)
return subobject, 1, 1
security.declareProtected(Permissions.ModifyPortalContent, 'addWorkflowNode')
def addWorkflowNode(self, object, xml, simulate):
"""
This allows to specify how to handle the workflow informations.
This is really usefull if you want to write your own Conduit.
"""
conflict_list = []
# We want to add a workflow action
wf_tool = getToolByName(object,'portal_workflow')
wf_id = self.getAttribute(xml,'id')
if wf_id is None: # History added by xupdate
wf_id = self.getHistoryIdFromSelect(xml)
xml = xml[0]
#for action in self.getWorkflowActionFromXml(xml):
status = self.getStatusFromXml(xml)
#LOG('addNode, status:',0,status)
add_action = self.isWorkflowActionAddable(object=object,
status=status,wf_tool=wf_tool,
wf_id=wf_id,xml=xml)
if add_action and not simulate:
wf_tool.setStatusOf(wf_id,object,status)
# Specific CPS, try to remove duplicate lines in portal_repository._histories
tool = getToolByName(self,'portal_repository',None)
if tool is not None:
if getattr(self, 'getDocid', None) is not None:
docid = self.getDocid()
history = tool.getHistory(docid)
new_history = ()
for history_line in history:
if history_line not in new_history:
new_history += (history_line,)
tool.setHistory(docid,new_history)
return conflict_list
security.declareProtected(Permissions.ModifyPortalContent, 'addLocalRoleNode')
def addLocalRoleNode(self, object, xml):
"""
This allows to specify how to handle the local role informations.
This is really usefull if you want to write your own Conduit.
"""
# We want to add a local role
roles = self.convertXmlValue(xml, data_type='tokens')
user = self.getAttribute(xml, 'id')
roles = list(roles) # Needed for CPS, or we have a CPS error
#LOG('local_role: ',0,'user: %s roles: %s' % (repr(user),repr(roles)))
#user = roles[0]
#roles = roles[1:]
if xml.xpath('local-name()') == self.local_role_tag:
object.manage_setLocalRoles(user, roles)
elif xml.xpath('local-name()') == self.local_group_tag:
object.manage_setLocalGroupRoles(user, roles)
security.declareProtected(Permissions.ModifyPortalContent, 'addLocalPermissionNode')
def addLocalPermissionNode(self, object, xml):
"""
This allows to specify how to handle the local permision informations.
This is really usefull if you want to write your own Conduit.
"""
conflict_list = []
# We want to add a local role
#LOG('addLocalPermissionNode, xml',0,xml)
if len(xml.text):
roles = self.convertXmlValue(xml, data_type='tokens')
roles = list(roles) # Needed for CPS, or we have a CPS error
else:
roles = ()
permission = self.getAttribute(xml, 'id')
#LOG('local_role: ',0,'permission: %s roles: %s' % (repr(permission),repr(roles)))
#user = roles[0]
#roles = roles[1:]
if xml.xpath('local-name()') == self.local_permission_tag:
object.manage_setLocalPermissions(permission, roles)
return conflict_list
security.declareProtected(Permissions.ModifyPortalContent, 'editDocument')
def editDocument(self, object=None, **kw):
"""
This is the default editDocument method. This method
can easily be overwritten.
"""
object._edit(**kw)
security.declareProtected(Permissions.ModifyPortalContent, 'getProperty')
def getProperty(self, object, kw):
"""
This is the default getProperty method. This method
can easily be overwritten.
"""
return object.getProperty(kw)
def nodeToString(self, node):
"""
return an xml string corresponding to the node
"""
return etree.tostring(node, encoding='utf-8', pretty_print=True)
def getGidFromObject(self, object):
"""
return the Gid composed with the object informations
"""
return object.getId()
# def getGidFromXML(self, xml, namespace, gid_from_xml_list):
# """
# return the Gid composed with xml informations
# """
# gid = xml.xpath('string(.//syncml:id)')
# if gid in gid_from_xml_list or gid == ' ':
# return False
# return gid