/
plugin.js
1315 lines (1139 loc) · 39.3 KB
/
plugin.js
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
/**
* @license Copyright (c) 2003-2014, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or http://ckeditor.com/license
*/
/**
* @fileOverview Undo/Redo system for saving a shapshot for document modification
* and other recordable changes.
*/
'use strict';
( function() {
var keystrokes = [ CKEDITOR.CTRL + 90 /*Z*/, CKEDITOR.CTRL + 89 /*Y*/, CKEDITOR.CTRL + CKEDITOR.SHIFT + 90 /*Z*/ ],
backspaceOrDelete = { 8: 1, 46: 1 };
CKEDITOR.plugins.add( 'undo', {
// jscs:disable maximumLineLength
lang: 'af,ar,bg,bn,bs,ca,cs,cy,da,de,el,en,en-au,en-ca,en-gb,eo,es,et,eu,fa,fi,fo,fr,fr-ca,gl,gu,he,hi,hr,hu,id,is,it,ja,ka,km,ko,ku,lt,lv,mk,mn,ms,nb,nl,no,pl,pt,pt-br,ro,ru,si,sk,sl,sq,sr,sr-latn,sv,th,tr,tt,ug,uk,vi,zh,zh-cn', // %REMOVE_LINE_CORE%
// jscs:enable maximumLineLength
icons: 'redo,redo-rtl,undo,undo-rtl', // %REMOVE_LINE_CORE%
hidpi: true, // %REMOVE_LINE_CORE%
init: function( editor ) {
var undoManager = editor.undoManager = new UndoManager( editor ),
editingHandler = undoManager.editingHandler = new NativeEditingHandler( undoManager );
var undoCommand = editor.addCommand( 'undo', {
exec: function() {
if ( undoManager.undo() ) {
editor.selectionChange();
this.fire( 'afterUndo' );
}
},
startDisabled: true,
canUndo: false
} );
var redoCommand = editor.addCommand( 'redo', {
exec: function() {
if ( undoManager.redo() ) {
editor.selectionChange();
this.fire( 'afterRedo' );
}
},
startDisabled: true,
canUndo: false
} );
editor.setKeystroke( [
[ keystrokes[ 0 ], 'undo' ],
[ keystrokes[ 1 ], 'redo' ],
[ keystrokes[ 2 ], 'redo' ]
] );
undoManager.onChange = function() {
undoCommand.setState( undoManager.undoable() ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED );
redoCommand.setState( undoManager.redoable() ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED );
};
function recordCommand( event ) {
// If the command hasn't been marked to not support undo.
if ( undoManager.enabled && event.data.command.canUndo !== false )
undoManager.save();
}
// We'll save snapshots before and after executing a command.
editor.on( 'beforeCommandExec', recordCommand );
editor.on( 'afterCommandExec', recordCommand );
// Save snapshots before doing custom changes.
editor.on( 'saveSnapshot', function( evt ) {
undoManager.save( evt.data && evt.data.contentOnly );
} );
// Event manager listeners should be attached on contentDom.
editor.on( 'contentDom', editingHandler.attachListeners, editingHandler );
editor.on( 'instanceReady', function() {
// Saves initial snapshot.
editor.fire( 'saveSnapshot' );
} );
// Always save an undo snapshot - the previous mode might have
// changed editor contents.
editor.on( 'beforeModeUnload', function() {
editor.mode == 'wysiwyg' && undoManager.save( true );
} );
function toggleUndoManager() {
undoManager.enabled = editor.readOnly ? false : editor.mode == 'wysiwyg';
undoManager.onChange();
}
// Make the undo manager available only in wysiwyg mode.
editor.on( 'mode', toggleUndoManager );
// Disable undo manager when in read-only mode.
editor.on( 'readOnly', toggleUndoManager );
if ( editor.ui.addButton ) {
editor.ui.addButton( 'Undo', {
label: editor.lang.undo.undo,
command: 'undo',
toolbar: 'undo,10'
} );
editor.ui.addButton( 'Redo', {
label: editor.lang.undo.redo,
command: 'redo',
toolbar: 'undo,20'
} );
}
/**
* Resets the undo stack.
*
* @member CKEDITOR.editor
*/
editor.resetUndo = function() {
// Reset the undo stack.
undoManager.reset();
// Create the first image.
editor.fire( 'saveSnapshot' );
};
/**
* Amends the top of the undo stack (last undo image) with the current DOM changes.
*
* function() {
* editor.fire( 'saveSnapshot' );
* editor.document.body.append(...);
* // Makes new changes following the last undo snapshot a part of it.
* editor.fire( 'updateSnapshot' );
* ..
* }
*
* @event updateSnapshot
* @member CKEDITOR.editor
* @param {CKEDITOR.editor} editor This editor instance.
*/
editor.on( 'updateSnapshot', function() {
if ( undoManager.currentImage )
undoManager.update();
} );
/**
* Locks the undo manager to prevent any save/update operations.
*
* It is convenient to lock the undo manager before performing DOM operations
* that should not be recored (e.g. auto paragraphing).
*
* See {@link CKEDITOR.plugins.undo.UndoManager#lock} for more details.
*
* **Note:** In order to unlock the undo manager, {@link #unlockSnapshot} has to be fired
* the same number of times that `lockSnapshot` has been fired.
*
* @since 4.0
* @event lockSnapshot
* @member CKEDITOR.editor
* @param {CKEDITOR.editor} editor This editor instance.
* @param data
* @param {Boolean} [data.dontUpdate] When set to `true`, the last snapshot will not be updated
* with the current content and selection. Read more in the {@link CKEDITOR.plugins.undo.UndoManager#lock} method.
* @param {Boolean} [data.forceUpdate] When set to `true`, the last snapshot will always be updated
* with the current content and selection. Read more in the {@link CKEDITOR.plugins.undo.UndoManager#lock} method.
*/
editor.on( 'lockSnapshot', function( evt ) {
var data = evt.data;
undoManager.lock( data && data.dontUpdate, data && data.forceUpdate );
} );
/**
* Unlocks the undo manager and updates the latest snapshot.
*
* @since 4.0
* @event unlockSnapshot
* @member CKEDITOR.editor
* @param {CKEDITOR.editor} editor This editor instance.
*/
editor.on( 'unlockSnapshot', undoManager.unlock, undoManager );
}
} );
CKEDITOR.plugins.undo = {};
/**
* Main logic for the Redo/Undo feature.
*
* @private
* @class CKEDITOR.plugins.undo.UndoManager
* @constructor Creates an UndoManager class instance.
* @param {CKEDITOR.editor} editor
*/
var UndoManager = CKEDITOR.plugins.undo.UndoManager = function( editor ) {
/**
* An array storing the number of key presses, count in a row. Use {@link #keyGroups} members as index.
*
* **Note:** The keystroke count will be reset after reaching the limit of characters per snapshot.
*
* @since 4.4.4
*/
this.strokesRecorded = [ 0, 0 ];
/**
* When the `locked` property is not `null`, the undo manager is locked, so
* operations like `save` or `update` are forbidden.
*
* The manager can be locked and unlocked by the {@link #lock} and {@link #unlock}
* methods, respectively.
*
* @readonly
* @property {Object} [locked=null]
*/
this.locked = null;
/**
* Contains the previously processed key group, based on {@link #keyGroups}.
* `-1` means an unknown group.
*
* @since 4.4.4
* @readonly
* @property {Number} [previousKeyGroup=-1]
*/
this.previousKeyGroup = -1;
/**
* Maximum number of snapshots in the stack. Configurable via {@link CKEDITOR.config#undoStackSize}.
*
* @readonly
* @property {Number} [limit]
*/
this.limit = editor.config.undoStackSize || 20;
/**
* Maximum number of characters typed/deleted in one undo step.
*
* @since 4.4.5
* @readonly
*/
this.strokesLimit = 25;
this.editor = editor;
// Reset the undo stack.
this.reset();
};
UndoManager.prototype = {
/**
* Handles keystroke support for the undo manager. It is called on `keyup` event for
* keystrokes that can change the editor content.
*
* @param {Number} keyCode The key code.
* @param {Boolean} [strokesPerSnapshotExceeded] When set to `true` the method will
* behave as strokes limit was exceeded regardless of {@link #strokesRecorded} value.
*/
type: function( keyCode, strokesPerSnapshotExceeded ) {
var keyGroup = UndoManager.getKeyGroup( keyCode ),
// Count of keystrokes in current a row.
// Note if strokesPerSnapshotExceeded will be exceeded, it'll be restarted.
strokesRecorded = this.strokesRecorded[ keyGroup ] + 1;
strokesPerSnapshotExceeded =
( strokesPerSnapshotExceeded || strokesRecorded >= this.strokesLimit );
if ( !this.typing )
onTypingStart( this );
if ( strokesPerSnapshotExceeded ) {
// Reset the count of strokes, so it'll be later assigned to this.strokesRecorded.
strokesRecorded = 0;
this.editor.fire( 'saveSnapshot' );
} else {
// Fire change event.
this.editor.fire( 'change' );
}
// Store recorded strokes count.
this.strokesRecorded[ keyGroup ] = strokesRecorded;
// This prop will tell in next itaration what kind of group was processed previously.
this.previousKeyGroup = keyGroup;
},
/**
* Whether the new `keyCode` belongs to different group than the previous one ({@link #previousKeyGroup}).
*
* @since 4.4.5
* @param {Number} keyCode
* @returns {Boolean}
*/
keyGroupChanged: function( keyCode ) {
return UndoManager.getKeyGroup( keyCode ) != this.previousKeyGroup;
},
/**
* Resets the undo stack.
*/
reset: function() {
// Stack for all the undo and redo snapshots, they're always created/removed
// in consistency.
this.snapshots = [];
// Current snapshot history index.
this.index = -1;
this.currentImage = null;
this.hasUndo = false;
this.hasRedo = false;
this.locked = null;
this.resetType();
},
/**
* Resets all typing variables.
*
* @see #type
*/
resetType: function() {
this.strokesRecorded = [ 0, 0 ];
this.typing = false;
this.previousKeyGroup = -1;
},
/**
* Refreshes the state of the {@link CKEDITOR.plugins.undo.UndoManager undo manager}
* as well as the state of the `undo` and `redo` commands.
*/
refreshState: function() {
// These lines can be handled within onChange() too.
this.hasUndo = !!this.getNextImage( true );
this.hasRedo = !!this.getNextImage( false );
// Reset typing
this.resetType();
this.onChange();
},
/**
* Saves a snapshot of the document image for later retrieval.
*
* @param {Boolean} onContentOnly If set to `true`, the snapshot will be saved only if the content has changed.
* @param {CKEDITOR.plugins.undo.Image} image An optional image to save. If skipped, current editor will be used.
* @param {Boolean} autoFireChange If set to `false`, will not trigger the {@link CKEDITOR.editor#change} event to editor.
*/
save: function( onContentOnly, image, autoFireChange ) {
var editor = this.editor;
// Do not change snapshots stack when locked, editor is not ready,
// editable is not ready or when editor is in mode difference than 'wysiwyg'.
if ( this.locked || editor.status != 'ready' || editor.mode != 'wysiwyg' )
return false;
var editable = editor.editable();
if ( !editable || editable.status != 'ready' )
return false;
var snapshots = this.snapshots;
// Get a content image.
if ( !image )
image = new Image( editor );
// Do nothing if it was not possible to retrieve an image.
if ( image.contents === false )
return false;
// Check if this is a duplicate. In such case, do nothing.
if ( this.currentImage ) {
if ( image.equalsContent( this.currentImage ) ) {
if ( onContentOnly )
return false;
if ( image.equalsSelection( this.currentImage ) )
return false;
} else if ( autoFireChange !== false ) {
editor.fire( 'change' );
}
}
// Drop future snapshots.
snapshots.splice( this.index + 1, snapshots.length - this.index - 1 );
// If we have reached the limit, remove the oldest one.
if ( snapshots.length == this.limit )
snapshots.shift();
// Add the new image, updating the current index.
this.index = snapshots.push( image ) - 1;
this.currentImage = image;
if ( autoFireChange !== false )
this.refreshState();
return true;
},
/**
* Sets editor content/selection to the one stored in `image`.
*
* @param {CKEDITOR.plugins.undo.Image} image
*/
restoreImage: function( image ) {
// Bring editor focused to restore selection.
var editor = this.editor,
sel;
if ( image.bookmarks ) {
editor.focus();
// Retrieve the selection beforehand. (#8324)
sel = editor.getSelection();
}
// Start transaction - do not allow any mutations to the
// snapshots stack done when selecting bookmarks (much probably
// by selectionChange listener).
this.locked = { level: 999 };
this.editor.loadSnapshot( image.contents );
if ( image.bookmarks )
sel.selectBookmarks( image.bookmarks );
else if ( CKEDITOR.env.ie ) {
// IE BUG: If I don't set the selection to *somewhere* after setting
// document contents, then IE would create an empty paragraph at the bottom
// the next time the document is modified.
var $range = this.editor.document.getBody().$.createTextRange();
$range.collapse( true );
$range.select();
}
this.locked = null;
this.index = image.index;
this.currentImage = this.snapshots[ this.index ];
// Update current image with the actual editor
// content, since actualy content may differ from
// the original snapshot due to dom change. (#4622)
this.update();
this.refreshState();
editor.fire( 'change' );
},
/**
* Gets the closest available image.
*
* @param {Boolean} isUndo If `true`, it will return the previous image.
* @returns {CKEDITOR.plugins.undo.Image} Next image or `null`.
*/
getNextImage: function( isUndo ) {
var snapshots = this.snapshots,
currentImage = this.currentImage,
image, i;
if ( currentImage ) {
if ( isUndo ) {
for ( i = this.index - 1; i >= 0; i-- ) {
image = snapshots[ i ];
if ( !currentImage.equalsContent( image ) ) {
image.index = i;
return image;
}
}
} else {
for ( i = this.index + 1; i < snapshots.length; i++ ) {
image = snapshots[ i ];
if ( !currentImage.equalsContent( image ) ) {
image.index = i;
return image;
}
}
}
}
return null;
},
/**
* Checks the current redo state.
*
* @returns {Boolean} Whether the document has a previous state to retrieve.
*/
redoable: function() {
return this.enabled && this.hasRedo;
},
/**
* Checks the current undo state.
*
* @returns {Boolean} Whether the document has a future state to restore.
*/
undoable: function() {
return this.enabled && this.hasUndo;
},
/**
* Performs an undo operation on current index.
*/
undo: function() {
if ( this.undoable() ) {
this.save( true );
var image = this.getNextImage( true );
if ( image )
return this.restoreImage( image ), true;
}
return false;
},
/**
* Performs a redo operation on current index.
*/
redo: function() {
if ( this.redoable() ) {
// Try to save. If no changes have been made, the redo stack
// will not change, so it will still be redoable.
this.save( true );
// If instead we had changes, we can't redo anymore.
if ( this.redoable() ) {
var image = this.getNextImage( false );
if ( image )
return this.restoreImage( image ), true;
}
}
return false;
},
/**
* Updates the last snapshot of the undo stack with the current editor content.
*
* @param {CKEDITOR.plugins.undo.Image} [newImage] The image which will replace the current one.
* If it is not set, it defaults to the image taken from the editor.
*/
update: function( newImage ) {
// Do not change snapshots stack is locked.
if ( this.locked )
return;
if ( !newImage )
newImage = new Image( this.editor );
var i = this.index,
snapshots = this.snapshots;
// Find all previous snapshots made for the same content (which differ
// only by selection) and replace all of them with the current image.
while ( i > 0 && this.currentImage.equalsContent( snapshots[ i - 1 ] ) )
i -= 1;
snapshots.splice( i, this.index - i + 1, newImage );
this.index = i;
this.currentImage = newImage;
},
/**
* Amends the last snapshot and changes its selection (only in case when content
* is equal between these two).
*
* @since 4.4.4
* @param {CKEDITOR.plugins.undo.Image} newSnapshot New snapshot with new selection.
* @returns {Boolean} Returns `true` if selection was amended.
*/
updateSelection: function( newSnapshot ) {
if ( !this.snapshots.length )
return false;
var snapshots = this.snapshots,
lastImage = snapshots[ snapshots.length - 1 ];
if ( lastImage.equalsContent( newSnapshot ) ) {
if ( !lastImage.equalsSelection( newSnapshot ) ) {
snapshots[ snapshots.length - 1 ] = newSnapshot;
this.currentImage = newSnapshot;
return true;
}
}
return false;
},
/**
* Locks the snapshot stack to prevent any save/update operations and when necessary,
* updates the tip of the snapshot stack with the DOM changes introduced during the
* locked period, after the {@link #unlock} method is called.
*
* It is mainly used to ensure any DOM operations that should not be recorded
* (e.g. auto paragraphing) are not added to the stack.
*
* **Note:** For every `lock` call you must call {@link #unlock} once to unlock the undo manager.
*
* @since 4.0
* @param {Boolean} [dontUpdate] When set to `true`, the last snapshot will not be updated
* with current content and selection. By default, if undo manager was up to date when the lock started,
* the last snapshot will be updated to the current state when unlocking. This means that all changes
* done during the lock will be merged into the previous snapshot or the next one. Use this option to gain
* more control over this behavior. For example, it is possible to group changes done during the lock into
* a separate snapshot.
* @param {Boolean} [forceUpdate] When set to `true`, the last snapshot will always be updated with the
* current content and selection regardless of the current state of the undo manager.
* When not set, the last snapshot will be updated only if the undo manager was up to date when locking.
* Additionally, this option makes it possible to lock the snapshot when the editor is not in the `wysiwyg` mode,
* because when it is passed, the snapshots will not need to be compared.
*/
lock: function( dontUpdate, forceUpdate ) {
if ( !this.locked ) {
if ( dontUpdate )
this.locked = { level: 1 };
else {
var update = null;
if ( forceUpdate )
update = true;
else {
// Make a contents image. Don't include bookmarks, because:
// * we don't compare them,
// * there's a chance that DOM has been changed since
// locked (e.g. fake) selection was made, so createBookmark2 could fail.
// http://dev.ckeditor.com/ticket/11027#comment:3
var imageBefore = new Image( this.editor, true );
// If current editor content matches the tip of snapshot stack,
// the stack tip must be updated by unlock, to include any changes made
// during this period.
if ( this.currentImage && this.currentImage.equalsContent( imageBefore ) )
update = imageBefore;
}
this.locked = { update: update, level: 1 };
}
// Increase the level of lock.
} else {
this.locked.level++;
}
},
/**
* Unlocks the snapshot stack and checks to amend the last snapshot.
*
* See {@link #lock} for more details.
*
* @since 4.0
*/
unlock: function() {
if ( this.locked ) {
// Decrease level of lock and check if equals 0, what means that undoM is completely unlocked.
if ( !--this.locked.level ) {
var update = this.locked.update;
this.locked = null;
// forceUpdate was passed to lock().
if ( update === true )
this.update();
// update is instance of Image.
else if ( update ) {
var newImage = new Image( this.editor, true );
if ( !update.equalsContent( newImage ) )
this.update();
}
}
}
}
};
/**
* Codes for navigation keys like Arrows, Page Up/Down, etc.
* Used by the {@link #isNavigationKey} method.
*
* @since 4.4.5
* @readonly
* @static
*/
UndoManager.navigationKeyCodes = {
37: 1, 38: 1, 39: 1, 40: 1, // Arrows.
36: 1, 35: 1, // Home, end.
33: 1, 34: 1 // Pgup, pgdn.
};
/**
* Key groups identifier mapping. Used for accessing members in
* {@link #strokesRecorded}.
*
* * `FUNCTIONAL` – identifier for the Backspace / Delete key.
* * `PRINTABLE` – identifier for printable keys.
*
* Example usage:
*
* undoManager.strokesRecorded[ undoManager.keyGroups.FUNCTIONAL ];
*
* @since 4.4.5
* @readonly
* @static
*/
UndoManager.keyGroups = {
PRINTABLE: 0,
FUNCTIONAL: 1
};
/**
* Checks whether a key is one of navigation keys (Arrows, Page Up/Down, etc.).
* See also the {@link #navigationKeyCodes} property.
*
* @since 4.4.5
* @static
* @param {Number} keyCode
* @returns {Boolean}
*/
UndoManager.isNavigationKey = function( keyCode ) {
return !!UndoManager.navigationKeyCodes[ keyCode ];
};
/**
* Returns the group to which passed `keyCode` belongs.
*
* @since 4.4.5
* @static
* @param {Number} keyCode
* @returns {Number}
*/
UndoManager.getKeyGroup = function( keyCode ) {
var keyGroups = UndoManager.keyGroups;
return backspaceOrDelete[ keyCode ] ? keyGroups.FUNCTIONAL : keyGroups.PRINTABLE;
};
/**
* @since 4.4.5
* @static
* @param {Number} keyGroup
* @returns {Number}
*/
UndoManager.getOppositeKeyGroup = function( keyGroup ) {
var keyGroups = UndoManager.keyGroups;
return ( keyGroup == keyGroups.FUNCTIONAL ? keyGroups.PRINTABLE : keyGroups.FUNCTIONAL );
};
/**
* Whether in this environment and for specified `keyCode` we need to use workaround
* for functional (backspace, delete) keys not firing `keypress` event on Internet Explorer.
*
* @since 4.4.5
* @static
* @param {Number} keyCode
* @returns {Boolean}
*/
UndoManager.ieFunctionalKeysBug = function( keyCode ) {
return CKEDITOR.env.ie && UndoManager.getKeyGroup( keyCode ) == UndoManager.keyGroups.FUNCTIONAL;
};
// Helper method called when undoManager.typing val was changed to true.
function onTypingStart( undoManager ) {
// It's safe to now indicate typing state.
undoManager.typing = true;
// Manually mark snapshot as available.
undoManager.hasUndo = true;
undoManager.hasRedo = false;
undoManager.onChange();
}
/**
* Contains a snapshot of the editor content and selection at a given point in time.
*
* @private
* @class CKEDITOR.plugins.undo.Image
* @constructor Creates an Image class instance.
* @param {CKEDITOR.editor} editor The editor instance on which the image is created.
* @param {Boolean} [contentsOnly] If set to `true`, the image will only contain content without the selection.
*/
var Image = CKEDITOR.plugins.undo.Image = function( editor, contentsOnly ) {
this.editor = editor;
editor.fire( 'beforeUndoImage' );
var contents = editor.getSnapshot();
// In IE, we need to remove the expando attributes.
if ( CKEDITOR.env.ie && contents )
contents = contents.replace( /\s+data-cke-expando=".*?"/g, '' );
this.contents = contents;
if ( !contentsOnly ) {
var selection = contents && editor.getSelection();
this.bookmarks = selection && selection.createBookmarks2( true );
}
editor.fire( 'afterUndoImage' );
};
// Attributes that browser may changing them when setting via innerHTML.
var protectedAttrs = /\b(?:href|src|name)="[^"]*?"/gi;
Image.prototype = {
/**
* @param {CKEDITOR.plugins.undo.Image} otherImage Image to compare to.
* @returns {Boolean} Returns `true` if content in `otherImage` is the same.
*/
equalsContent: function( otherImage ) {
var thisContents = this.contents,
otherContents = otherImage.contents;
// For IE7 and IE QM: Comparing only the protected attribute values but not the original ones.(#4522)
if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.quirks ) ) {
thisContents = thisContents.replace( protectedAttrs, '' );
otherContents = otherContents.replace( protectedAttrs, '' );
}
if ( thisContents != otherContents )
return false;
return true;
},
/**
* @param {CKEDITOR.plugins.undo.Image} otherImage Image to compare to.
* @returns {Boolean} Returns `true` if selection in `otherImage` is the same.
*/
equalsSelection: function( otherImage ) {
var bookmarksA = this.bookmarks,
bookmarksB = otherImage.bookmarks;
if ( bookmarksA || bookmarksB ) {
if ( !bookmarksA || !bookmarksB || bookmarksA.length != bookmarksB.length )
return false;
for ( var i = 0; i < bookmarksA.length; i++ ) {
var bookmarkA = bookmarksA[ i ],
bookmarkB = bookmarksB[ i ];
if ( bookmarkA.startOffset != bookmarkB.startOffset || bookmarkA.endOffset != bookmarkB.endOffset ||
!CKEDITOR.tools.arrayCompare( bookmarkA.start, bookmarkB.start ) ||
!CKEDITOR.tools.arrayCompare( bookmarkA.end, bookmarkB.end ) ) {
return false;
}
}
}
return true;
}
/**
* Editor content.
*
* @readonly
* @property {String} contents
*/
/**
* Bookmarks representing the selection in an image.
*
* @readonly
* @property {Object[]} bookmarks Array of bookmark2 objects, see {@link CKEDITOR.dom.range#createBookmark2} for definition.
*/
};
/**
* A class encapsulating all native event listeners which have to be used in
* order to handle undo manager integration for native editing actions (excluding drag and drop and paste support
* handled by the Clipboard plugin).
*
* @since 4.4.4
* @private
* @class CKEDITOR.plugins.undo.NativeEditingHandler
* @member CKEDITOR.plugins.undo Undo manager owning the handler.
* @constructor
* @param {CKEDITOR.plugins.undo.UndoManager} undoManager
*/
var NativeEditingHandler = CKEDITOR.plugins.undo.NativeEditingHandler = function( undoManager ) {
// We'll use keyboard + input events to determine if snapshot should be created.
// Since `input` event is fired before `keyup`. We can tell in `keyup` event if input occured.
// That will tell us if any printable data was inserted.
// On `input` event we'll increase input fired counter for proper key code.
// Eventually it might be canceled by paste/drop using `ignoreInputEvent` flag.
// Order of events can be found in http://www.w3.org/TR/DOM-Level-3-Events/
/**
* An undo manager instance owning the editing handler.
*
* @property {CKEDITOR.plugins.undo.UndoManager} undoManager
*/
this.undoManager = undoManager;
/**
* See {@link #ignoreInputEventListener}.
*
* @since 4.4.5
* @private
*/
this.ignoreInputEvent = false;
/**
* A stack of pressed keys.
*
* @since 4.4.5
* @property {CKEDITOR.plugins.undo.KeyEventsStack} keyEventsStack
*/
this.keyEventsStack = new KeyEventsStack();
/**
* An image of the editor during the `keydown` event (therefore without DOM modification).
*
* @property {CKEDITOR.plugins.undo.Image} lastKeydownImage
*/
this.lastKeydownImage = null;
};
NativeEditingHandler.prototype = {
/**
* The `keydown` event listener.
*
* @param {CKEDITOR.dom.event} evt
*/
onKeydown: function( evt ) {
// Block undo/redo keystrokes when at the bottom/top of the undo stack (#11126 and #11677).
if ( CKEDITOR.tools.indexOf( keystrokes, evt.data.getKeystroke() ) > -1 ) {
evt.data.preventDefault();
return;
}
// Cleaning tab functional keys.
this.keyEventsStack.cleanUp( evt );
var keyCode = evt.data.getKey(),
undoManager = this.undoManager;
// Gets last record for provided keyCode. If not found will create one.
var last = this.keyEventsStack.getLast( keyCode );
if ( !last ) {
this.keyEventsStack.push( keyCode );
}
// We need to store an image which will be used in case of key group
// change.
this.lastKeydownImage = new Image( undoManager.editor );
if ( UndoManager.isNavigationKey( keyCode ) || this.undoManager.keyGroupChanged( keyCode ) ) {
if ( undoManager.strokesRecorded[ 0 ] || undoManager.strokesRecorded[ 1 ] ) {
// We already have image, so we'd like to reuse it.
undoManager.save( false, this.lastKeydownImage );
undoManager.resetType();
}
}
},
/**
* The `input` event listener.
*/
onInput: function() {
// Input event is ignored if paste/drop event were fired before.
if ( this.ignoreInputEvent ) {
// Reset flag - ignore only once.
this.ignoreInputEvent = false;
return;
}
var lastInput = this.keyEventsStack.getLast();
// Nothing in key events stack, but input event called. Interesting...
// That's because on Android order of events is buggy and also keyCode is set to 0.
if ( !lastInput ) {
lastInput = this.keyEventsStack.push( 0 );
}
// Increment inputs counter for provided key code.
this.keyEventsStack.increment( lastInput.keyCode );
// Exceeded limit.
if ( this.keyEventsStack.getTotalInputs() >= this.undoManager.strokesLimit ) {
this.undoManager.type( lastInput.keyCode, true );
this.keyEventsStack.resetInputs();
}
},
/**
* The `keyup` event listener.
*
* @param {CKEDITOR.dom.event} evt
*/
onKeyup: function( evt ) {
var undoManager = this.undoManager,
keyCode = evt.data.getKey(),
totalInputs = this.keyEventsStack.getTotalInputs();
// Remove record from stack for provided key code.
this.keyEventsStack.remove( keyCode );
// Second part of the workaround for IEs functional keys bug. We need to check whether something has really
// changed because we blindly mocked the keypress event.
// Also we need to be aware that lastKeydownImage might not be available (#12327).
if ( UndoManager.ieFunctionalKeysBug( keyCode ) && this.lastKeydownImage &&
this.lastKeydownImage.equalsContent( new Image( undoManager.editor, true ) ) ) {