forked from sanyaade-machine-learning/Transana
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PropagateChanges.py
1417 lines (1288 loc) · 83.5 KB
/
PropagateChanges.py
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
# Copyright (C) 2003 - 2015 The Board of Regents of the University of Wisconsin System
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of version 2 of the GNU General Public License as
# published by the Free Software Foundation.
#
# 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.
#
""" A Utility Program to deal with propagating Episode Transcript and Clip Change propagation. """
__author__ = 'David Woods <dwoods@wcer.wisc.edu>'
DEBUG = False
if DEBUG:
print "PropagateChanges DEBUG is ON!!"
# import wxPython
import wx
# import Python's sys module
import sys
# import Transana's Clip object
import Clip
# import Transana's Database interface
import DBInterface
# import Transana's Miscellaneous functions
import Misc
# import Transana's Quote object
import Quote
# import Transana's Constants
import TransanaConstants
# import Transana's Exception definitions
import TransanaExceptions
# import Transana's Global Definitions
import TransanaGlobal
# import Transana's Transcript Object
import Transcript
# import Transana's Transcript Editor
if TransanaConstants.USESRTC:
import TranscriptEditor_RTC
else:
import TranscriptEditor_STC
# Define IDs for the "Update All" and "Skip" buttons on the confirmation form
ID_UPDATEALL = wx.NewId()
ID_SKIP = wx.NewId()
class PropagateObjectChanges(wx.Dialog):
""" This window displays the Propagate Object Changes report form. """
def __init__(self, parent, objType):
# Remember the parent, which should be a ControlObject
self.parent = parent
# If we have a Document ...
if objType == 'Document':
title = _("Document Change Propagation")
reportName = _("Document Change Propagation Report")
emptyList = unicode(_("No quotes were found that include %s."), 'utf8')
emptyListData = "%s" % (self.parent.TranscriptWindow.dlg.editor.GetSelection(),)
cancellationMessage = _("Document Change Propagation was cancelled. Therefore, no Quotes were updated.")
# If we have an Episode Transcript ...
elif objType == 'Episode':
title = _("Episode Transcript Change Propagation")
reportName = _("Episode Transcript Change Propagation Report")
emptyList = unicode(_("No clips were found that include %s."), 'utf8')
emptyListData = Misc.time_in_ms_to_str(self.parent.TranscriptWindow.dlg.editor.get_selected_time_range()[0])
cancellationMessage = _("Episode Transcript Change Propagation was cancelled. Therefore, no Clips were updated.")
# Define the main Frame for the Propagate Changes report Window
wx.Dialog.__init__(self, self.parent.MenuWindow, -1, title, size = (710,650), style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.NO_FULL_REPAINT_ON_RESIZE)
# Set the background to White
# self.SetBackgroundColour(wx.WHITE)
# To look right, the Mac needs the Small Window Variant.
if "__WXMAC__" in wx.PlatformInfo:
self.SetWindowVariant(wx.WINDOW_VARIANT_SMALL)
# Create a Sizer for the form
box = wx.BoxSizer(wx.VERTICAL)
# Create a label for the Memo section
txtMemo = wx.StaticText(self, -1, reportName)
# Put the label in the Memo Sizer, with a little padding
box.Add(txtMemo, 0, wx.ALL, 6)
# Add a TextCtrl for the Report text. This is read only, as it is filled programmatically.
self.memo = wx.TextCtrl(self, -1, style = wx.TE_MULTILINE | wx.TE_WORDWRAP | wx.TE_READONLY)
# Put the Memo control in the Memo Sizer
box.Add(self.memo, 1, wx.EXPAND | wx.ALL, 6)
# Create a sizer for the buttons
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
# Put an expandable point in the button sizer so everything else can be right justified
btnSizer.Add((1, 1), 1, wx.EXPAND)
# Add an OK button
btnOK = wx.Button(self, wx.ID_OK, _("OK"))
# Put the OK button on the button sizer
btnSizer.Add(btnOK, 0, wx.ALIGN_RIGHT | wx.LEFT | wx.RIGHT | wx.BOTTOM, 6)
# Add a Help button
btnHelp = wx.Button(self, -1, _("Help"))
# Link the Help button to the OnHelp method
btnHelp.Bind(wx.EVT_BUTTON, self.OnHelp)
# Add the Help button to the Button sizer
btnSizer.Add(btnHelp, 0, wx.ALIGN_RIGHT | wx.LEFT | wx.RIGHT | wx.BOTTOM, 6)
# Add the button sizer to the main sizer
box.Add(btnSizer, 0, wx.EXPAND)
# Attach the Form's Main Sizer to the form
self.SetSizer(box)
# Set AutoLayout on
self.SetAutoLayout(True)
# Lay out the form
self.Layout()
# Set the minimum size for the form.
self.SetSizeHints(minW = 600, minH = 440)
# Center the form on the screen
self.CentreOnScreen()
# Clear the Report of contents
self.memo.Clear()
# We need to lock the data items that we can up front to prevent record lock problems.
# If User 1 started a propagation process, then User 2 locked an object, the object would get the
# propagation changes from User 1 and User 2 would lose work. We have to prevent that by locking
# the records up front rather than later as I was doing.
# I think the old model failed because the record locks were issued inside the Transaction. This solves the problem.
lockedObjects = {}
unlockedObjects = {}
# If we have a Document ...
if objType == 'Document':
# Determine the current selection in the current Document.
insertionPoint = self.parent.TranscriptWindow.dlg.editor.GetInsertionPoint()
positionInfo = self.parent.TranscriptWindow.dlg.editor.GetSelection()
if positionInfo == (-2, -2):
emptyListData = "%s" % insertionPoint
# request clips that include the current transcript cursor position
objList = DBInterface.list_of_quotes_by_document(self.parent.TranscriptWindow.dlg.editor.TranscriptObj.number, textPos = insertionPoint, textSel=positionInfo)
# Iterate through the list of Quotes, loading the objects, locking what can be locked, and noting what cannot
# be locked.
for obj in objList:
dataObj = Quote.Quote(num = obj['QuoteNum'])
try:
dataObj.lock_record()
unlockedObjects[dataObj.number] = dataObj
except:
lockedObjects[dataObj.number] = dataObj
# If we have an Episode Transcript ...
elif objType == 'Episode':
# Determine the time code preceding the cursor position in the Transcript. (DON'T USE the video positions, which
# may not have been updated if you are in Edit mode!)
positionInfo = self.parent.TranscriptWindow.dlg.editor.get_selected_time_range()[0]
# request clips that include the current transcript cursor position
objList = DBInterface.list_of_clips_by_episode(self.parent.TranscriptWindow.dlg.editor.TranscriptObj.episode_num, positionInfo)
# But unfortunately, this does not produce a COMPLETE Clip List in some cases.
# If a time code that starts a clip is deleted, the previous list may not contain that clip.
# Therefore we need to look for more clips.
# Let's get a time just before the END of the clip.
positionInfo2 = self.parent.TranscriptWindow.dlg.editor.get_selected_time_range()[1] - 10
# request clips that include the end time code based on cursor position
objList2 = DBInterface.list_of_clips_by_episode(self.parent.TranscriptWindow.dlg.editor.TranscriptObj.episode_num, positionInfo2)
# Iterate through the list ...
for clip in objList2:
# ... looking for clips that were NOT included in the earlier list ...
if clip not in objList:
# ... and appending them to the list.
objList.append(clip)
# This still misses clips that have had BOTH time codes removed, but I can't figure out how to fix that. It shouldn't happen very often.
# Iterate through the list of Clips, loading the objects, locking what can be locked, and noting what cannot
# be locked.
for obj in objList:
dataObj = Clip.Clip(obj['ClipNum'])
try:
dataObj.lock_record()
unlockedObjects[dataObj.number] = dataObj
except:
lockedObjects[dataObj.number] = dataObj
# If no data objects are returned ...
if len(objList) == 0:
# ... inform the user by adding a message to the report
self.memo.AppendText(emptyList % emptyListData)
else:
# Let's start a database Transaction
# First, let's get a database cursor
dbCursor = DBInterface.get_db().cursor()
dbCursor.execute('BEGIN')
# Initially, the user has not indicated that s/he wants to update ALL the objects.
acceptAll = False
# Initialize Results to ID-SKIP. If no objects are found, it's the same as if the user pressed "Skip".
results = ID_SKIP
# Iterate through the Object List ...
for obj in objList:
# Let's load the object
# If we have a Document ...
if objType == 'Document':
recordLockedPrompt = unicode(_('ERROR: Quote "%s" in Collection "%s" is locked and cannot be updated.'), 'utf8')
# If the Quote was NOT locked when we started ...
if unlockedObjects.has_key(obj['QuoteNum']):
# ... get the Quote for the list entry ...
tempObj = unlockedObjects[obj['QuoteNum']]
# ... set the Transcript selection to match the Quote's text ...
self.parent.TranscriptWindow.dlg.editor.SetSelection(tempObj.start_char, tempObj.end_char)
# ... and get the NEW text matching the Quote's position values.
text = self.parent.TranscriptWindow.dlg.editor.GetFormattedSelection('XML', selectionOnly=True)
# Start Exception handling.
try:
# If the user hasn't signal that they want to update all Quotes ...
if not acceptAll:
# ... create the Accept Quote Transcript Changes form ...
acceptChanges = AcceptObjectTranscriptChanges(self, objType, tempObj.number, 0, text, helpString="Propagate Transcript Changes")
# ... and display it, capturing the user feedback.
results = acceptChanges.GetResults()
# Close (and Destroy) the form
acceptChanges.Destroy()
# If the user wants to update all Quotes ...
if results == ID_UPDATEALL:
# ... then changing this variable will prevent the need for further user intervention.
acceptAll = True
# If the user presses "Update" (OK) or has pressed "Update All" ...
if acceptAll or (results == wx.ID_OK):
# Lock the Quote (will raise an exception of you can't)
# tempObj.lock_record()
# substitute the new text for the old text
tempObj.text = text
# Save the Quote
tempObj.db_save(use_transactions=False)
# Finally, indicate success in the Report
self.memo.AppendText(_("Text updated for Quote"))
# If the user indicates we should skip ONE Quote ...
elif results == ID_SKIP:
# ... indicate that in the report and don't do anything else.
self.memo.AppendText(_("Text change skipped for Quote"))
# If the user indicates we should CANCEL Text propagation ...
elif results == wx.ID_CANCEL:
# ... indicate that in the report. The rest of Cancel is implemented later, after we've added
# the full Quote information to the report.
self.memo.AppendText(_("Transcript propagation cancelled at Quote"))
# unlock the Quote, regardless of how it was treated
tempObj.unlock_record()
# If a RecordLocked Exception is raised ... THIS SHOULD NOT HAPPEN ANY MORE!!
except TransanaExceptions.RecordLockedError:
# ... indicate that in the report.
self.memo.AppendText(_("ERROR: Record lock error for Quote"))
# If a SaveError exception is raised (I don't know how this might happen!)
except TransanaExceptions.SaveError, e:
# build the prompt for the user ...
prompt = unicode(_('ERROR: Save error "%s" for Quote'), 'utf8')
# ... and report the error in the report.
self.memo.AppendText(prompt % e.reason)
# unlock the data object
tempObj.unlock_record()
# We need to build the prompt for the Quote information, which is added to ALL of the above prompts
prompt = unicode(_('in Collection'), 'utf8')
# Add the quote data to the report.
self.memo.AppendText(' "%s" %s "%s". (%s - %s)\n\n' % (tempObj.id, prompt, tempObj.collection_id, tempObj.start_char, tempObj.end_char))
# If the user pressed "Cancel" ...
if results == wx.ID_CANCEL:
# ... we should STOP processing QUOTES!
break
# If we have an Episode Transcript ...
elif objType == 'Episode':
recordLockedPrompt = unicode(_('ERROR: Clip "%s" in Collection "%s" is locked and cannot be updated.'), 'utf8')
# If the Clip was NOT locked when we started ...
if unlockedObjects.has_key(obj['ClipNum']):
tempObj = unlockedObjects[obj['ClipNum']]
# If the clip has only one Transcript ...
if len(tempObj.transcripts) == 1:
# ... then give the Clip Transcript the Clip's start and stop times. (They only get assigned for multi-transcript clips!)
# (NOTE: Legacy Clips from Transana before version 2.30 require this.)
tempObj.transcripts[0].clip_start = tempObj.clip_start
tempObj.transcripts[0].clip_stop = tempObj.clip_stop
# For every transcript if each clip ...
for clipTranscript in tempObj.transcripts:
# Get the text from the Episode Transcript that matches the Clip TRANSCRIPT's start and stop times. (NOT JUST THE CLIP'S!!)
# The return values include the Episode Transcript's time code boundaries, in case they've changed since the
# clip was created, as well as the NEW text.
(start, end, text) = self.parent.TranscriptWindow.dlg.editor.GetTextBetweenTimeCodes(clipTranscript.clip_start, clipTranscript.clip_stop)
# Check the start and end times to make sure neither has changed. THEY MUST MATCH EXACTLY or we won't propagate to that clip.
# Also check that the Clip's originating Transcript Number matches the current Episode Transcripts's number, that is,
# that this clip was indeed taken from THIS transcript. The one exception to this rule is if the clip has been orphaned,
# which will probably only be known if the data has been through export/import since the clips was orphaned.
if (start == clipTranscript.clip_start) and \
(end == clipTranscript.clip_stop) and \
((clipTranscript.source_transcript == self.parent.TranscriptWindow.dlg.editor.TranscriptObj.number) or \
(clipTranscript.source_transcript == 0)):
# Start Exception handling.
try:
# If the user hasn't signal that they want to update all clips ...
if not acceptAll:
# ... create the Accept Clip Transcript Changes form ...
acceptClipChanges = AcceptObjectTranscriptChanges(self, objType, tempObj.number, tempObj.transcripts.index(clipTranscript), text, helpString="Propagate Transcript Changes")
# ... and display it, capturing the user feedback.
results = acceptClipChanges.GetResults()
# Close (and Destroy) the form
acceptClipChanges.Destroy()
# If the user wants to update all Clips ...
if results == ID_UPDATEALL:
# ... then changing this variable will prevent the need for further user intervention.
acceptAll = True
# If the user presses "Update" (OK) or has pressed "Update All" ...
if acceptAll or (results == wx.ID_OK):
# Lock the Clip (will raise an exception of you can't)
# clipTranscript.lock_record()
# substitute the new text for the old text
clipTranscript.text = text
# Save the Clip
clipTranscript.db_save()
# unlock the clip
# clipTranscript.unlock_record()
# Finally, indicate success in the Report
self.memo.AppendText(_("Transcript updated for Clip"))
# If the user indicates we should skip ONE clip ...
elif results == ID_SKIP:
# ... indicate that in the report and don't do anything else.
self.memo.AppendText(_("Transcript change skipped for Clip"))
# If the user indicates we should CANCEL Transcript propagation ...
elif results == wx.ID_CANCEL:
# ... indicate that in the report. The rest of Cancel is implemented later, after we've added
# the full Clip information to the report.
self.memo.AppendText(_("Transcript propagation cancelled at Clip"))
# If a RecordLocked Exception is raised ...
except TransanaExceptions.RecordLockedError:
# ... indicate that in the report.
self.memo.AppendText(recordLockedPrompt)
# If a SaveError exception is raised (I don't know how this might happen!)
except TransanaExceptions.SaveError, e:
# build the prompt for the user ...
prompt = unicode(_('ERROR: Save error "%s" for Clip'), 'utf8')
# ... and report the error in the report.
self.memo.AppendText(prompt % e.reason)
# unlock the clip
# clipTranscript.unlock_record()
# If a clip has Time Code boundary or Transcript Source issues ...
else:
# If the time code boundaries are okay ...
if (clipTranscript.source_transcript != self.parent.TranscriptWindow.dlg.editor.TranscriptObj.number) or \
(clipTranscript.source_transcript == 0):
# ... then we have a Transcript Source error to add to the report.
self.memo.AppendText(_("SKIP: A different transcript was used to create clip"))
# Otherwise ...
else:
# ... we have a Time Code Boundary problem to report to the user.
self.memo.AppendText(_("ERROR: Clip boundaries don't match transcript time codes for clip"))
# If either of these errors occurs, it's the same as if the user pressed "Skip".
results = ID_SKIP
# We need to build the prompt for the Clip information, which is added to ALL of the above prompts
prompt = unicode(_('in Collection'), 'utf8')
# Add the clip data to the report.
self.memo.AppendText(' "%s" %s "%s". (%s - %s)\n\n' % (tempObj.id, prompt, tempObj.collection_id, Misc.time_in_ms_to_str(clipTranscript.clip_start), Misc.time_in_ms_to_str(clipTranscript.clip_stop)))
# If the user pressed "Cancel" ...
if results == wx.ID_CANCEL:
# ... we should STOP processing TRANSCRIPTS!
break
# If the user pressed "Cancel" ...
if results == wx.ID_CANCEL:
# ... we should STOP processing CLIPS too!
break
tempObj.unlock_record()
# If the user pressed Cancel ...
if results == wx.ID_CANCEL:
# ... undo Clip Transcript changes in the database ...
dbCursor.execute("ROLLBACK")
# ... and inform the user that the changes were cancelled. To avoid confusion, clear the report information already generated.
self.memo.Clear()
self.memo.AppendText(cancellationMessage)
# Get each locked object ...
for dataObj in unlockedObjects.values():
# if dataObj._isLocked:
# ... unlock the record
dataObj.unlock_record()
# If the user pressed anything except Cancel ...
else:
# Get each locked object ...
for dataObj in lockedObjects.values():
# ... indicate that in the report.
prompt = recordLockedPrompt
self.memo.AppendText(prompt % (dataObj.id, dataObj.GetNodeString(False)) + '\n\n')
# ... commit the changes to the database
dbCursor.execute("COMMIT")
# Update the contents of the memo
self.memo.Update()
# Finally, we can show the dialog so the user can see the report!
self.ShowModal()
def OnHelp(self, event):
""" Method to use when the Help Button is pressed """
# Locate the Menu Window ...
if TransanaGlobal.menuWindow != None:
# .. and use that to get to the standard Help Call method.
TransanaGlobal.menuWindow.ControlObject.Help("Propagate Transcript Changes")
class PropagateClipChanges(wx.Dialog):
""" This window displays the Propagate Quote and Clip Changes report form. """
def __init__(self, parent, objType, originalObj, sourceTranscriptIndex, newText, newObjID=None, newKeywordList=None):
# If we are dealing with a Quote ...
if objType == 'Quote':
title = _("Quote Change Propagation")
reportTitle = _("Quote Change Propagation Report")
emptyListPrompt = unicode(_("No Quotes were found that match %s."), 'utf8')
# There's no Clip to update with Quotes!
CurrentClipToUpdate = 0
# If we are dealing with a Clip ...
elif objType == 'Clip':
# If changes get propagated to the currently loaded clip, the data can get stale, which can cause problems.
# So if we have a Clip loaded in the main interface, it shares a name with the clip data being propagated,
# and it's not the CURRENT clip ...
if isinstance(parent.ControlObject.currentObj, Clip.Clip) and \
(originalObj.id == parent.ControlObject.currentObj.id) and \
(originalObj.number != parent.ControlObject.currentObj.number):
# ... not the clip's number so the data can be updated at the end of this process
CurrentClipToUpdate = parent.ControlObject.currentObj.number
# If we don't meet those criteria ...
else:
# ... then we don't need to update the current clip.
CurrentClipToUpdate = 0
title = _("Clip Change Propagation")
reportTitle = _("Clip Change Propagation Report")
emptyListPrompt = unicode(_("No Clips were found that match %s."), 'utf8')
# Define the main Frame for the Propagate Changes report Window
wx.Dialog.__init__(self, parent, -1, title, size = (710,650), style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER|wx.NO_FULL_REPAINT_ON_RESIZE)
# Set the background to White
# self.SetBackgroundColour(wx.WHITE)
# To look right, the Mac needs the Small Window Variant.
if "__WXMAC__" in wx.PlatformInfo:
self.SetWindowVariant(wx.WINDOW_VARIANT_SMALL)
# Create a Sizer for the form
box = wx.BoxSizer(wx.VERTICAL)
# Create a label for the Memo section
txtMemo = wx.StaticText(self, -1, reportTitle)
# Put the label in the Memo Sizer, with a little padding
box.Add(txtMemo, 0, wx.ALL, 6)
# Add a TextCtrl for the Report text. This is read only, as it is filled programmatically.
self.memo = wx.TextCtrl(self, -1, style = wx.TE_MULTILINE | wx.TE_WORDWRAP | wx.TE_READONLY)
# Put the Memo control in the Memo Sizer
box.Add(self.memo, 1, wx.EXPAND | wx.ALL, 6)
# Create a sizer for the buttons
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
# Put an expandable point in the button sizer so everything else can be right justified
btnSizer.Add((1, 1), 1, wx.EXPAND)
# Add an OK button
btnOK = wx.Button(self, wx.ID_OK, _("OK"))
# Put the OK button on the button sizer
btnSizer.Add(btnOK, 0, wx.ALIGN_RIGHT | wx.LEFT | wx.RIGHT | wx.BOTTOM, 6)
# Add a Help button
btnHelp = wx.Button(self, -1, _("Help"))
# Link the Help button to the OnHelp method
btnHelp.Bind(wx.EVT_BUTTON, self.OnHelp)
# Add the Help button to the Button sizer
btnSizer.Add(btnHelp, 0, wx.ALIGN_RIGHT | wx.LEFT | wx.RIGHT | wx.BOTTOM, 6)
# Add the button sizer to the main sizer
box.Add(btnSizer, 0, wx.EXPAND)
# Attach the Form's Main Sizer to the form
self.SetSizer(box)
# Set AutoLayout on
self.SetAutoLayout(True)
# Lay out the form
self.Layout()
# Set the minimum size for the form.
self.SetSizeHints(minW = 600, minH = 440)
# Center the form on the screen
self.CentreOnScreen()
# Clear the Report of contents
self.memo.Clear()
# If no Object ID is passed in ...
if newObjID == None:
# ... then use the original Object ID. It hasn't changed.
newObjID = originalObj.id
# If no new keyword list is passed in ...
if newKeywordList == None:
# ... then use the original keyword list. It hasn't changed.
newKeywordList = originalObj.keyword_list
# ***************************************************
# Could this code be optimized by leaving the newKeywordList == None and skipping Keyword Processing if there is none to do?
# ***************************************************
# We need to lock the data items that we can up front to prevent record lock problems.
# If User 1 started a propagation process, then User 2 locked an object, the object would get the
# propagation changes from User 1 and User 2 would lose work. We have to prevent that by locking
# the records up front rather than later as I was doing.
# I think the old model failed because the record locks were issued inside the Transaction. This solves the problem.
lockedObjects = {}
unlockedObjects = {}
if objType == 'Quote':
# Initialize the quoteList
# Request quotes that are copies of the current quote
objList = DBInterface.list_of_quote_copies(originalObj.id, originalObj.source_document_num,
originalObj.start_char, originalObj.end_char)
# If the original quote is returned in the list of copies ...
if (originalObj.number, originalObj.collection_num, originalObj.id, originalObj.source_document_num) in objList:
# ... then remove it from the list. It's already been updated!
objList.remove((originalObj.number, originalObj.collection_num, originalObj.id, originalObj.source_document_num))
# Iterate through the list of Quotes, loading the objects, locking what can be locked, and noting what cannot
# be locked.
for obj in objList:
dataObj = Quote.Quote(num = obj[0])
try:
dataObj.lock_record()
unlockedObjects[dataObj.number] = dataObj
except:
lockedObjects[dataObj.number] = dataObj
elif objType == 'Clip':
# If we are passed a Transcript Index ...
if sourceTranscriptIndex > -1:
# ... we pass that index on to the Clip List ...
objListTranscriptIndex = sourceTranscriptIndex
# Request clips that are copies of the current clip
objList = DBInterface.list_of_clip_copies(originalObj.id, originalObj.transcripts[objListTranscriptIndex].source_transcript, originalObj.transcripts[objListTranscriptIndex].clip_start, originalObj.transcripts[objListTranscriptIndex].clip_stop)
# ... otherwise we have to handle requests from multiple transcripts ...
else:
# Initialize the objList
objList = []
# Iterate through all the transcripts from the original clip
for objListTranscriptIndex in range(len(originalObj.transcripts)):
# Request clips that are copies of the current clip for the indicated transcript
tempobjList = DBInterface.list_of_clip_copies(originalObj.id, originalObj.transcripts[objListTranscriptIndex].source_transcript, originalObj.transcripts[objListTranscriptIndex].clip_start, originalObj.transcripts[objListTranscriptIndex].clip_stop)
# Iterate through the clips in this list
for objListData in tempobjList:
needToAdd = True
for objListData2 in objList:
if objListData[:3] == objListData2[:3]:
needToAdd = False
break
if needToAdd:
objList.append(objListData)
# If we have NO Transcript Index ...
if sourceTranscriptIndex == -1:
# ... then we need to iterate through the clips in the clip list to find instances of Originating Clip that need to be removed
for (num, colnum, clid, trnum) in objList:
# If the original clip is returned in the list of copies ...
if (originalObj.number == num) and \
(originalObj.collection_num == colnum) and \
(originalObj.id == clid):
# ... then remove it from the list. It's already been updated!
objList.remove((num, colnum, clid, trnum))
# If we HAVE a Transcript Index ...
else:
# If the original clip is returned in the list of copies ...
if (originalObj.number, originalObj.collection_num, originalObj.id, originalObj.transcripts[sourceTranscriptIndex].number) in objList:
# ... then remove it from the list. It's already been updated!
objList.remove((originalObj.number, originalObj.collection_num, originalObj.id, originalObj.transcripts[sourceTranscriptIndex].number))
# Iterate through the list of Clips, loading the objects, locking what can be locked, and noting what cannot
# be locked.
for obj in objList:
dataObj = Clip.Clip(obj[0])
try:
dataObj.lock_record()
unlockedObjects[dataObj.number] = dataObj
except:
lockedObjects[dataObj.number] = dataObj
# If no objects are returned ...
if len(objList) == 0:
# ... inform the user ...
prompt = emptyListPrompt
# ... by adding a message to the report
self.memo.AppendText(prompt % originalObj.id)
# If there are data objects to process ...
else:
# Let's start a database Transaction
# First, let's get a database cursor
dbCursor = DBInterface.get_db().cursor()
dbCursor.execute('BEGIN')
# We need to track MU Messages to be sent. This way, if the CANCEL button is pressed, we can skip the messages!
messageCache = []
# Initially, the user has not indicated that s/he wants to update ALL the clips.
acceptAll = False
# Initialize Results to ID-SKIP. If no data objects are found, it's the same as if the user pressed "Skip".
results = ID_SKIP
# If the user cancels, we may need to undo some of the changes that get made to the system!
undoData = []
# Iterate through the Object List ...
for obj in objList:
# Start Exception handling.
try:
if objType == 'Quote':
recordLockedPrompt = unicode(_('ERROR: Quote "%s" in Collection "%s" is locked and cannot be updated.'), 'utf8')
saveErrorPrompt = unicode(_('ERROR: Save error "%s" for Quote "%s" in Collection "%s"'), 'utf8')
cancelMessageText = _("Quote Change Propagation was cancelled. Therefore, no Quotes were updated.")
# If the Quote was NOT locked when we started ...
if unlockedObjects.has_key(obj[0]):
# Load the current Quote
dataObj = unlockedObjects[obj[0]]
# Let's remember the original Object ID.
oldDataID = dataObj.id
# If the user hasn't signal that they want to update all Quotes ...
if (not acceptAll):
# ... create the Accept Quote Changes form WITH KEYWORDS ...
acceptQuoteChanges = AcceptObjectTranscriptChanges(self, 'Document', obj[0], -1, newText, newKeywordList, helpString="Propagate Clip Changes")
# ... and display it, capturing the user feedback.
results = acceptQuoteChanges.GetResults()
# Close (and Destroy) the form
acceptQuoteChanges.Destroy()
# If the user wants to update all Clips ...
if results == ID_UPDATEALL:
# ... then changing this variable will prevent the need for further user intervention.
acceptAll = True
# If the user presses "Update" (OK) or has pressed "Update All" ...
if acceptAll or (results == wx.ID_OK):
# update the Quote ID
dataObj.id = newObjID
# substitute the new transcript text for the old text
dataObj.text = newText
# Clear the old keywords from the Quote
dataObj.clear_keywords()
# Iterate through all the keywords in the NEW keyword list
for clipKeyword in newKeywordList:
# ... add it as a non-example keyword
dataObj.add_keyword(clipKeyword.keywordGroup, clipKeyword.keyword)
# Save the Quote
dataObj.db_save(use_transactions=False)
# Finally, indicate success in the Report
prompt = unicode(_('Quote "%s" in Collection "%s" has been updated.'), 'utf8')
# Add the message to the report
self.memo.AppendText(prompt % (oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# If the user indicates we should skip ONE clip ...
elif results == ID_SKIP:
# ... indicate that in the report and don't do anything else.
prompt = unicode(_('Quote change has been skipped for Quote "%s" in Collection "%s".'), 'utf8')
self.memo.AppendText(prompt % (oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# If the user indicates we should CANCEL Quote propagation ...
elif results == wx.ID_CANCEL:
# ... indicate that in the report. The rest of Cancel is implemented later, after we've added
# the full Quote information to the report.
self.memo.AppendText(_("Quote change propagation has been cancelled."))
# ... we should STOP processing Quotes! So stop iterating!
break
# unlock the Quote, regardless of how it is processed
dataObj.unlock_record()
elif objType == 'Clip':
recordLockedPrompt = unicode(_('ERROR: Clip "%s" in Collection "%s" is locked and cannot be updated.'), 'utf8')
saveErrorPrompt = unicode(_('ERROR: Save error "%s" for Clip "%s" in Collection "%s"'), 'utf8')
cancelMessageText = _("Clip Change Propagation was cancelled. Therefore, no clips were updated.")
# If the Clip was NOT locked when we started ...
if unlockedObjects.has_key(obj[0]):
# ... load the current clip
dataObj = unlockedObjects[obj[0]]
# Let's remember the original Object ID.
oldDataID = dataObj.id
# If we have a Transcript Index ...
if sourceTranscriptIndex > -1:
# We need the appropriate transcript's INDEX. Initialize to -1
trIndex = -1
# Interate through transcripts ...
for tr in dataObj.transcripts:
# ... if the transcript's number is the one we're looking for (matches the SourceTranscript) ...
if tr.number == obj[3]:
# ... remember the INDEX for the Transcript, so we know which one to update.
trIndex = {dataObj.transcripts.index(tr) : newText}
break
# If we don't have a Transcript Index, we need to create a dictionary of transcripts!
else:
# Initialize a dictionary
trIndex = {}
# The trick here is to make sure that ALL COMBINATIONS of transcripts of same and different sizes get
# detected and processed. If we update a clip with just transcripts 2 and 3, we need to be sure that
# clips with transcripts 1 and 3 as well as 2 and 4 get caught and processed.
# Loop through all dataObj transcripts
for x in range(len(dataObj.transcripts)):
# Loop through all newText transcripts
for y in range(len(newText)):
# If both transcripts come from the same source transcript, we have a match.
if dataObj.transcripts[x].source_transcript == newText[y].source_transcript:
# We need to record the matches for processing.
trIndex[x] = newText[y].text
# Once we've found the match, no need to keep looking within newText.
break
# For each key in the transcripts dictionary ...
for key in trIndex.keys():
# If the user hasn't signal that they want to update all clips AND we've found an eligible transcript (index != -1) ...
if (not acceptAll) and (trIndex != -1):
# See if we're looking at single transcript situations OR the first transcript in a list ...
if (sourceTranscriptIndex > -1) or (key == 0):
# ... create the Accept Clip Transcript Changes form WITH KEYWORDS ...
acceptClipChanges = AcceptObjectTranscriptChanges(self, 'Episode', obj[0], key, trIndex[key], newKeywordList, helpString="Propagate Clip Changes")
# If it's not a single or the first, ...
else:
# ... LEAVE THE KEYWORDS OFF!
acceptClipChanges = AcceptObjectTranscriptChanges(self, 'Episode', obj[0], key, trIndex[key], helpString="Propagate Clip Changes")
# ... and display it, capturing the user feedback.
results = acceptClipChanges.GetResults()
# Close (and Destroy) the form
acceptClipChanges.Destroy()
# If the user wants to update all Clips ...
if results == ID_UPDATEALL:
# ... then changing this variable will prevent the need for further user intervention.
acceptAll = True
# If the user presses "Update" (OK) or has pressed "Update All" ...
if acceptAll or (results == wx.ID_OK):
# Get a list of Keyword Examples for the current clip. We don't want to lose this information in the propagation.
keywordExamples = DBInterface.list_all_keyword_examples_for_a_clip(obj[0])
# update the Clip ID
dataObj.id = newObjID
# substitute the new transcript text for the old text
dataObj.transcripts[key].text = trIndex[key]
if (sourceTranscriptIndex > -1) or (key == 0):
# Clear the old keywords from the clip
dataObj.clear_keywords()
# Iterate through all the clips in the NEW keyword list
for clipKeyword in newKeywordList:
# If the keyword is also in the Keyword Examples list ...
if (clipKeyword.keywordGroup, clipKeyword.keyword, dataObj.number, originalObj.id) in keywordExamples:
# ... add it as an example keyword
dataObj.add_keyword(clipKeyword.keywordGroup, clipKeyword.keyword, example=1)
# If it's NOT an example ...
else:
# ... add it as a non-example keyword
dataObj.add_keyword(clipKeyword.keywordGroup, clipKeyword.keyword)
# We don't want Keyword Example clips to get lost because of propagation.
# Therefore, iterate through the Keyword Examples list
for kw in keywordExamples:
# Check to see if the keyword is already added to the clip above. If NOT ...
if not dataObj.has_keyword(kw[0], kw[1]):
# ... add the keyword as an example keyword
dataObj.add_keyword(kw[0], kw[1], example=1)
# This will be unexpected by the user, so let's add a note to the user about this.
prompt = unicode(_('Clip "%s" in collection "%s" retained keyword "%s : %s" because it is a keyword example.'), 'utf8') + u'\n\n'
# Add the prompt to the memo to communicate this to the user.
self.memo.AppendText(prompt % (oldDataID, dataObj.GetNodeString(False), kw[0], kw[1]))
# Save the Clip
dataObj.db_save(use_transactions=False)
# Finally, indicate success in the Report
prompt = unicode(_('Transcript %d of clip "%s" in collection "%s" has been updated.'), 'utf8')
# Add the message to the report
self.memo.AppendText(prompt % (key + 1, oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# If the user indicates we should skip ONE clip ...
elif results == ID_SKIP:
# ... indicate that in the report and don't do anything else.
prompt = unicode(_('Clip change has been skipped for transcript %d of clip "%s" in collection "%s".'), 'utf8')
self.memo.AppendText(prompt % (key + 1, oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# If the user indicates we should CANCEL Clip propagation ...
elif results == wx.ID_CANCEL:
# ... indicate that in the report. The rest of Cancel is implemented later, after we've added
# the full Clip information to the report.
self.memo.AppendText(_("Clip change propagation has been cancelled."))
# ... we should STOP processing Clips! So stop iterating!
break
# unlock the clip, regardless of how it is processed
dataObj.unlock_record()
# Initialize the Chat Message
msg = ""
# If the Data Object ID has changed, we need to update instances of the Object ID
if oldDataID != dataObj.id:
# If we have a Clip ...
if objType == 'Clip':
# Iterate through all the Keyowrd Examples for this clip ...
for (kwg, kw, clipNumber, clipID) in keywordExamples:
# Build the keyword Example Node List for the OLD Clip ID
nodeList = (_('Keywords'), kwg, kw, originalObj.id)
# Select the Keyword Example Node
exampleNode = parent.tree.select_Node(nodeList, 'KeywordExampleNode')
# Update the Keyword Example Node to the NEW Clip ID
parent.tree.SetItemText(exampleNode, dataObj.id)
# Add a Keyword Example record to the Undo list in case the user Cancels.
undoData.append(('KWE', dataObj.number, dataObj.episode_num, dataObj.id, originalObj.id, kwg, kw))
# If we're in the Multi-User mode, we need to send a message about the change
if not TransanaConstants.singleUserVersion:
# Begin constructing the message with the old and new names for the node
msg = " >|< %s >|< %s" % (originalObj.id, dataObj.id)
# Get the full Node Branch by climbing it to two levels above the root
while (parent.tree.GetItemParent(parent.tree.GetItemParent(exampleNode)) != parent.tree.GetRootItem()):
# Update the selected node indicator
exampleNode = parent.tree.GetItemParent(exampleNode)
# Prepend the new Node's name on the Message with the appropriate seperator
msg = ' >|< ' + parent.tree.GetItemText(exampleNode) + msg
# The first parameter is the Node Type. The second one is the UNTRANSLATED root node.
# This must be untranslated to avoid problems in mixed-language environments.
# Prepend these on the Messsage
msg = "KeywordExampleNode >|< Keywords" + msg
if DEBUG:
print 'Message to send = "RN %s"' % msg
# Cache the Rename Node message for later processing
if TransanaGlobal.chatWindow != None:
messageCache.append("RN %s" % msg)
# now build the Node List for the Data Object itself. First get the Node data from the Data Object ...
dataNodeData = dataObj.GetNodeData(False)
# ... then add the Collections Root and the original Object ID to make the full Node List.
nodeList = (_("Collections"),) + dataNodeData + (originalObj.id,)
if objType == 'Quote':
# Rename the Tree node
parent.tree.rename_Node(nodeList, 'QuoteNode', dataObj.id)
msg = "QuoteNode"
# Add a Data Object record to the Undo list in case the user Cancels.
undoData.append((objType, dataObj.number, dataObj.source_document_num, dataObj.id, originalObj.id, dataNodeData))
elif objType == 'Clip':
# Rename the Tree node
parent.tree.rename_Node(nodeList, 'ClipNode', dataObj.id)
msg = "ClipNode"
# Add a Data Object record to the Undo list in case the user Cancels.
undoData.append((objType, dataObj.number, dataObj.episode_num, dataObj.id, originalObj.id, dataNodeData))
# If we're in the Multi-User mode, we need to send a message about the change
if not TransanaConstants.singleUserVersion:
# The first parameter is the Node Type. The second one is the UNTRANSLATED root node.
# This must be untranslated to avoid problems in mixed-language environments.
# Prepend these on the Messsage
msg += " >|< Collections >|< "
for node in nodeList[1:]:
# Prepend the new Node's name on the Message with the appropriate seperator
msg += node + ' >|< '
# Begin constructing the message with the old and new names for the node
msg += dataObj.id
if DEBUG:
print 'Message to send = "RN %s"' % msg.encode('latin1')
print
# Cache the Rename Node message for later processing
if TransanaGlobal.chatWindow != None:
messageCache.append("RN %s" % msg)
# See if the Keyword visualization needs to be updated.
parent.ControlObject.UpdateKeywordVisualization()
# Now let's communicate with other Transana instances if we're in Multi-user mode
if not TransanaConstants.singleUserVersion:
if objType == 'Quote':
# Build the message to update Keyword Visualizations.
msg = '%s %d %d' % (objType, dataObj.number, dataObj.source_document_num)
elif objType == 'Clip':
# Build the message to update Keyword Visualizations.
msg = '%s %d %d' % (objType, dataObj.number, dataObj.episode_num)
if DEBUG:
print 'Message to send = "UKL %s"' % msg
if TransanaGlobal.chatWindow != None:
# Cache the Update Keyword messages for later processing
messageCache.append("UKL %s" % msg)
messageCache.append("UKV %s" % msg)
# If a RecordLocked Exception is raised ...
except TransanaExceptions.RecordLockedError, e:
# ... indicate that in the report.
prompt = recordLockedPrompt
self.memo.AppendText(prompt % (oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# If a SaveError exception is raised -- Duplicate Object ID error, for example
except TransanaExceptions.SaveError, e:
# build the prompt for the user ...
prompt = saveErrorPrompt
# ... and report the error in the report.
self.memo.AppendText(prompt % (e.reason, oldDataID, dataObj.GetNodeString(False)) + '\n\n')
# unlock the data object
dataObj.unlock_record()
except:
if DEBUG:
import traceback
traceback.print_exc(file=sys.stdout)
# If the user pressed "Cancel" ...
if results == wx.ID_CANCEL:
# ... we should STOP processing Clips! So stop iterating!
break
# If the user pressed Cancel ...
if results == wx.ID_CANCEL:
# ... undo Data Object changes in the database ...
dbCursor.execute("ROLLBACK")
# If the user presses Cancel, we have to reverse the changes that have already been made to the
# user interface (local and MU). This probably isn't a great model (change, then undo if Cancelled),
# but cancel should be rare.
# So first, iterate through the Undo list to see what records need to be undone.
for undoRec in undoData:
# If the record is a Quote or a Clip record ...
if undoRec[0] in ['Quote', 'Clip']:
# ... assemble the node list based on the values in the Undo record
nodeList = (_("Collections"),) + undoRec[5] + (undoRec[3],)
if undoRec[0] == 'Quote':
# Rename the correct Tree node
parent.tree.rename_Node(nodeList, 'QuoteNode', undoRec[4])
msg = "QuoteNode"
elif undoRec[0] == 'Clip':
# Rename the correct Tree node
parent.tree.rename_Node(nodeList, 'ClipNode', undoRec[4])
msg = "ClipNode"
# If we're in the Multi-User mode, we need to send a message about the change
if not TransanaConstants.singleUserVersion:
# The first parameter is the Node Type. The second one is the UNTRANSLATED root node.
# This must be untranslated to avoid problems in mixed-language environments.
# Prepend these on the Messsage
msg += " >|< Collections >|< "
for node in nodeList[1:]:
# Prepend the new Node's name on the Message with the appropriate seperator
msg += node + ' >|< '
# Begin constructing the message with the old and new names for the node
msg += undoRec[4]
if DEBUG:
print 'Message to send = "RN %s"' % msg.encode('latin1')
print
# Cache the Rename Node message for later processing
if TransanaGlobal.chatWindow != None:
messageCache.append("RN %s" % msg)
# If the record is a Keyword Example record ...
elif undoRec[0] == 'KWE':
# .. Build the Keyword Example Node List for the OLD Clip ID
nodeList = (_('Keywords'), undoRec[5], undoRec[6], undoRec[3])
# Select the Keyword Example Node
exampleNode = parent.tree.select_Node(nodeList, 'KeywordExampleNode')
# Update the Keyword Example Node to the NEW Clip ID
parent.tree.SetItemText(exampleNode, undoRec[4])
# If we're in the Multi-User mode, we need to send a message about the change
if not TransanaConstants.singleUserVersion:
# Begin constructing the message with the old and new names for the node
msg = " >|< %s >|< %s" % (undoRec[2], undoRec[3])
# Get the full Node Branch by climbing it to two levels above the root
while (parent.tree.GetItemParent(parent.tree.GetItemParent(exampleNode)) != parent.tree.GetRootItem()):
# Update the selected node indicator
exampleNode = parent.tree.GetItemParent(exampleNode)
# Prepend the new Node's name on the Message with the appropriate seperator
msg = ' >|< ' + parent.tree.GetItemText(exampleNode) + msg
# The first parameter is the Node Type. The second one is the UNTRANSLATED root node.
# This must be untranslated to avoid problems in mixed-language environments.
# Prepend these on the Messsage
msg = "KeywordExampleNode >|< Keywords" + msg
if DEBUG:
print 'Message to send = "RN %s"' % msg
# Cache the Rename Node message for later processing
if TransanaGlobal.chatWindow != None:
messageCache.append("RN %s" % msg)
# Now let's communicate with other Transana instances if we're in Multi-user mode
if not TransanaConstants.singleUserVersion:
# Build the message to update Keyword Visualizations.
msg = '%s %d' % (objType, undoRec[1])
if DEBUG:
print 'Message to send = "UKL %s"' % msg
if TransanaGlobal.chatWindow != None:
# Cache the Update Keywords messages for later processing
messageCache.append("UKL %s" % msg)
messageCache.append("UKV %s %s" % (msg, undoRec[2]))
# ... and inform the user that the changes were cancelled. To avoid confusion, clear the report information already generated.
self.memo.Clear()
self.memo.AppendText(cancelMessageText)