-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
filter.js
2584 lines (2244 loc) · 82.5 KB
/
filter.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-2019, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
( function() {
'use strict';
var DTD = CKEDITOR.dtd,
// processElement flag - means that element has been somehow modified.
FILTER_ELEMENT_MODIFIED = 1,
// processElement flag - meaning explained in CKEDITOR.FILTER_SKIP_TREE doc.
FILTER_SKIP_TREE = 2,
copy = CKEDITOR.tools.copy,
trim = CKEDITOR.tools.trim,
TEST_VALUE = 'cke-test',
enterModeTags = [ '', 'p', 'br', 'div' ];
/**
* A flag indicating that the current element and all its ancestors
* should not be filtered.
*
* See {@link CKEDITOR.filter#addElementCallback} for more details.
*
* @since 4.4.0
* @readonly
* @property {Number} [=2]
* @member CKEDITOR
*/
CKEDITOR.FILTER_SKIP_TREE = FILTER_SKIP_TREE;
/**
* Highly configurable class which implements input data filtering mechanisms
* and core functions used for the activation of editor features.
*
* A filter instance is always available under the {@link CKEDITOR.editor#filter}
* property and is used by the editor in its core features like filtering input data,
* applying data transformations, validating whether a feature may be enabled for
* the current setup. It may be configured in two ways:
*
* * By the user, with the {@link CKEDITOR.config#allowedContent} setting.
* * Automatically, by loaded features (toolbar items, commands, etc.).
*
* In both cases additional allowed content rules may be added by
* setting the {@link CKEDITOR.config#extraAllowedContent}
* configuration option.
*
* **Note**: Filter rules will be extended with the following elements
* depending on the {@link CKEDITOR.config#enterMode} and
* {@link CKEDITOR.config#shiftEnterMode} settings:
*
* * `'p'` – for {@link CKEDITOR#ENTER_P},
* * `'div'` – for {@link CKEDITOR#ENTER_DIV},
* * `'br'` – for {@link CKEDITOR#ENTER_BR}.
*
* **Read more** about Advanced Content Filter in {@glink guide/dev_advanced_content_filter guides}.
*
* A filter may also be used as a standalone instance by passing
* {@link CKEDITOR.filter.allowedContentRules} instead of {@link CKEDITOR.editor}
* to the constructor:
*
* ```javascript
* var filter = new CKEDITOR.filter( 'b' );
*
* filter.check( 'b' ); // -> true
* filter.check( 'i' ); // -> false
* filter.allow( 'i' );
* filter.check( 'i' ); // -> true
* ```
*
* If the filter is only used by a single editor instance, you should pass the editor instance alongside with the rules.
* Passing the editor as the first parameter binds it with the filter so the filter can be removed
* with the {@link CKEDITOR.editor#method-destroy} method to prevent memory leaks.
*
* ```javascript
* // In both cases the filter will be removed during the {@link CKEDITOR.editor#method-destroy} function execution.
* var filter1 = new CKEDITOR.filter( editor );
* var filter2 = new CKEDITOR.filter( editor, 'b' );
* ```
*
* @since 4.1.0
* @class
* @constructor Creates a filter class instance.
* @param {CKEDITOR.editor/CKEDITOR.filter.allowedContentRules} editorOrRules
* @param {CKEDITOR.filter.allowedContentRules} [rules] This parameter is available since 4.11.0.
*/
CKEDITOR.filter = function( editorOrRules, rules ) {
/**
* Whether custom {@link CKEDITOR.config#allowedContent} was set.
*
* This property does not apply to the standalone filter.
*
* @readonly
* @property {Boolean} customConfig
*/
/**
* Array of rules added by the {@link #allow} method (including those
* loaded from {@link CKEDITOR.config#allowedContent} and
* {@link CKEDITOR.config#extraAllowedContent}).
*
* Rules in this array are in unified allowed content rules format.
*
* This property is useful for debugging issues with rules string parsing
* or for checking which rules were automatically added by editor features.
*
* @readonly
*/
this.allowedContent = [];
/**
* Array of rules added by the {@link #disallow} method (including those
* loaded from {@link CKEDITOR.config#disallowedContent}).
*
* Rules in this array are in unified disallowed content rules format.
*
* This property is useful for debugging issues with rules string parsing
* or for checking which rules were automatically added by editor features.
*
* @since 4.4.0
* @readonly
*/
this.disallowedContent = [];
/**
* Array of element callbacks. See {@link #addElementCallback}.
*
* @readonly
* @property {Function[]} [=null]
*/
this.elementCallbacks = null;
/**
* Whether the filter is disabled.
*
* To disable the filter, set {@link CKEDITOR.config#allowedContent} to `true`
* or use the {@link #disable} method.
*
* @readonly
*/
this.disabled = false;
/**
* Editor instance if not a standalone filter.
*
* @readonly
* @property {CKEDITOR.editor} [=null]
*/
this.editor = null;
/**
* Filter's unique id. It can be used to find filter instance in
* {@link CKEDITOR.filter#instances CKEDITOR.filter.instance} object.
*
* @since 4.3.0
* @readonly
* @property {Number} id
*/
this.id = CKEDITOR.tools.getNextNumber();
this._ = {
// Optimized allowed content rules.
allowedRules: {
elements: {},
generic: []
},
// Optimized disallowed content rules.
disallowedRules: {
elements: {},
generic: []
},
// Object: element name => array of transformations groups.
transformations: {},
cachedTests: {},
cachedChecks: {}
};
// Register filter instance.
CKEDITOR.filter.instances[ this.id ] = this;
var editor = this.editor = editorOrRules instanceof CKEDITOR.editor ? editorOrRules : null;
if ( editor && !rules ) {
this.customConfig = true;
var allowedContent = editor.config.allowedContent;
// Disable filter completely by setting config.allowedContent = true.
if ( allowedContent === true ) {
this.disabled = true;
return;
}
if ( !allowedContent )
this.customConfig = false;
this.allow( allowedContent, 'config', 1 );
this.allow( editor.config.extraAllowedContent, 'extra', 1 );
// Enter modes should extend filter rules (ENTER_P adds 'p' rule, etc.).
this.allow( enterModeTags[ editor.enterMode ] + ' ' + enterModeTags[ editor.shiftEnterMode ], 'default', 1 );
this.disallow( editor.config.disallowedContent );
}
// Rules object passed in editorOrRules argument - initialize standalone filter.
else {
this.customConfig = false;
this.allow( rules || editorOrRules, 'default', 1 );
}
};
/**
* Object containing all filter instances stored under their
* {@link #id} properties.
*
* var filter = new CKEDITOR.filter( 'p' );
* filter === CKEDITOR.filter.instances[ filter.id ];
*
* @since 4.3.0
* @static
* @property instances
*/
CKEDITOR.filter.instances = {};
CKEDITOR.filter.prototype = {
/**
* Adds allowed content rules to the filter.
*
* Read about rules formats in {@glink guide/dev_allowed_content_rules Allowed Content Rules guide}.
*
* // Add a basic rule for custom image feature (e.g. 'MyImage' button).
* editor.filter.allow( 'img[!src,alt]', 'MyImage' );
*
* // Add rules for two header styles allowed by 'HeadersCombo'.
* var header1Style = new CKEDITOR.style( { element: 'h1' } ),
* header2Style = new CKEDITOR.style( { element: 'h2' } );
* editor.filter.allow( [ header1Style, header2Style ], 'HeadersCombo' );
*
* @param {CKEDITOR.filter.allowedContentRules} newRules Rule(s) to be added.
* @param {String} [featureName] Name of a feature that allows this content (most often plugin/button/command name).
* @param {Boolean} [overrideCustom] By default this method will reject any rules
* if {@link CKEDITOR.config#allowedContent} is defined to avoid overriding it.
* Pass `true` to force rules addition.
* @returns {Boolean} Whether the rules were accepted.
*/
allow: function( newRules, featureName, overrideCustom ) {
// Check arguments and constraints. Clear cache.
if ( !beforeAddingRule( this, newRules, overrideCustom ) )
return false;
var i, ret;
if ( typeof newRules == 'string' )
newRules = parseRulesString( newRules );
else if ( newRules instanceof CKEDITOR.style ) {
// If style has the cast method defined, use it and abort.
if ( newRules.toAllowedContentRules )
return this.allow( newRules.toAllowedContentRules( this.editor ), featureName, overrideCustom );
newRules = convertStyleToRules( newRules );
} else if ( CKEDITOR.tools.isArray( newRules ) ) {
for ( i = 0; i < newRules.length; ++i )
ret = this.allow( newRules[ i ], featureName, overrideCustom );
return ret; // Return last status.
}
addAndOptimizeRules( this, newRules, featureName, this.allowedContent, this._.allowedRules );
return true;
},
/**
* Applies this filter to passed {@link CKEDITOR.htmlParser.fragment} or {@link CKEDITOR.htmlParser.element}.
* The result of filtering is a DOM tree without disallowed content.
*
* // Create standalone filter passing 'p' and 'b' elements.
* var filter = new CKEDITOR.filter( 'p b' ),
* // Parse HTML string to pseudo DOM structure.
* fragment = CKEDITOR.htmlParser.fragment.fromHtml( '<p><b>foo</b> <i>bar</i></p>' ),
* writer = new CKEDITOR.htmlParser.basicWriter();
*
* filter.applyTo( fragment );
* fragment.writeHtml( writer );
* writer.getHtml(); // -> '<p><b>foo</b> bar</p>'
*
* @param {CKEDITOR.htmlParser.fragment/CKEDITOR.htmlParser.element} fragment Node to be filtered.
* @param {Boolean} [toHtml] Set to `true` if the filter is used together with {@link CKEDITOR.htmlDataProcessor#toHtml}.
* @param {Boolean} [transformOnly] If set to `true` only transformations will be applied. Content
* will not be filtered with allowed content rules.
* @param {Number} [enterMode] Enter mode used by the filter when deciding how to strip disallowed element.
* Defaults to {@link CKEDITOR.editor#activeEnterMode} for a editor's filter or to {@link CKEDITOR#ENTER_P} for standalone filter.
* @returns {Boolean} Whether some part of the `fragment` was removed by the filter.
*/
applyTo: function( fragment, toHtml, transformOnly, enterMode ) {
if ( this.disabled )
return false;
var that = this,
toBeRemoved = [],
protectedRegexs = this.editor && this.editor.config.protectedSource,
processRetVal,
isModified = false,
filterOpts = {
doFilter: !transformOnly,
doTransform: true,
doCallbacks: true,
toHtml: toHtml
};
// Filter all children, skip root (fragment or editable-like wrapper used by data processor).
fragment.forEach( function( el ) {
if ( el.type == CKEDITOR.NODE_ELEMENT ) {
// Do not filter element with data-cke-filter="off" and all their descendants.
if ( el.attributes[ 'data-cke-filter' ] == 'off' )
return false;
// (https://dev.ckeditor.com/ticket/10260) Don't touch elements like spans with data-cke-* attribute since they're
// responsible e.g. for placing markers, bookmarks, odds and stuff.
// We love 'em and we don't wanna lose anything during the filtering.
// '|' is to avoid tricky joints like data-="foo" + cke-="bar". Yes, they're possible.
//
// NOTE: data-cke-* assigned elements are preserved only when filter is used with
// htmlDataProcessor.toHtml because we don't want to protect them when outputting data
// (toDataFormat).
if ( toHtml && el.name == 'span' && ~CKEDITOR.tools.object.keys( el.attributes ).join( '|' ).indexOf( 'data-cke-' ) )
return;
processRetVal = processElement( that, el, toBeRemoved, filterOpts );
if ( processRetVal & FILTER_ELEMENT_MODIFIED )
isModified = true;
else if ( processRetVal & FILTER_SKIP_TREE )
return false;
}
else if ( el.type == CKEDITOR.NODE_COMMENT && el.value.match( /^\{cke_protected\}(?!\{C\})/ ) ) {
if ( !processProtectedElement( that, el, protectedRegexs, filterOpts ) )
toBeRemoved.push( el );
}
}, null, true );
if ( toBeRemoved.length )
isModified = true;
var node, element, check,
toBeChecked = [],
enterTag = enterModeTags[ enterMode || ( this.editor ? this.editor.enterMode : CKEDITOR.ENTER_P ) ],
parentDtd;
// Remove elements in reverse order - from leaves to root, to avoid conflicts.
while ( ( node = toBeRemoved.pop() ) ) {
if ( node.type == CKEDITOR.NODE_ELEMENT )
removeElement( node, enterTag, toBeChecked );
// This is a comment securing rejected element - remove it completely.
else
node.remove();
}
// Check elements that have been marked as possibly invalid.
while ( ( check = toBeChecked.pop() ) ) {
element = check.el;
// Element has been already removed.
if ( !element.parent )
continue;
// Handle custom elements as inline elements (https://dev.ckeditor.com/ticket/12683).
parentDtd = DTD[ element.parent.name ] || DTD.span;
switch ( check.check ) {
// Check if element itself is correct.
case 'it':
// Check if element included in $removeEmpty has no children.
if ( DTD.$removeEmpty[ element.name ] && !element.children.length )
removeElement( element, enterTag, toBeChecked );
// Check if that is invalid element.
else if ( !validateElement( element ) )
removeElement( element, enterTag, toBeChecked );
break;
// Check if element is in correct context. If not - remove element.
case 'el-up':
// Check if e.g. li is a child of body after ul has been removed.
if ( element.parent.type != CKEDITOR.NODE_DOCUMENT_FRAGMENT && !parentDtd[ element.name ] )
removeElement( element, enterTag, toBeChecked );
break;
// Check if element is in correct context. If not - remove parent.
case 'parent-down':
if ( element.parent.type != CKEDITOR.NODE_DOCUMENT_FRAGMENT && !parentDtd[ element.name ] )
removeElement( element.parent, enterTag, toBeChecked );
break;
}
}
return isModified;
},
/**
* Checks whether a {@link CKEDITOR.feature} can be enabled. Unlike {@link #addFeature},
* this method always checks the feature, even when the default configuration
* for {@link CKEDITOR.config#allowedContent} is used.
*
* // TODO example
*
* @param {CKEDITOR.feature} feature The feature to be tested.
* @returns {Boolean} Whether this feature can be enabled.
*/
checkFeature: function( feature ) {
if ( this.disabled )
return true;
if ( !feature )
return true;
// Some features may want to register other features.
// E.g. a button may return a command bound to it.
if ( feature.toFeature )
feature = feature.toFeature( this.editor );
return !feature.requiredContent || this.check( feature.requiredContent );
},
/**
* Disables Advanced Content Filter.
*
* This method is meant to be used by plugins which are not
* compatible with the filter and in other cases in which the filter
* has to be disabled during the initialization phase or runtime.
*
* In other cases the filter can be disabled by setting
* {@link CKEDITOR.config#allowedContent} to `true`.
*/
disable: function() {
this.disabled = true;
},
/**
* Adds disallowed content rules to the filter.
*
* Read about rules formats in the {@glink guide/dev_allowed_content_rules Allowed Content Rules guide}.
*
* // Disallow all styles on the image elements.
* editor.filter.disallow( 'img{*}' );
*
* // Disallow all span and div elements.
* editor.filter.disallow( 'span div' );
*
* @since 4.4.0
* @param {CKEDITOR.filter.disallowedContentRules} newRules Rule(s) to be added.
*/
disallow: function( newRules ) {
// Check arguments and constraints. Clear cache.
// Note: we pass true in the 3rd argument, because disallow() should never
// be blocked by custom configuration.
if ( !beforeAddingRule( this, newRules, true ) )
return false;
if ( typeof newRules == 'string' )
newRules = parseRulesString( newRules );
addAndOptimizeRules( this, newRules, null, this.disallowedContent, this._.disallowedRules );
return true;
},
/**
* Adds an array of {@link CKEDITOR.feature} content forms. All forms
* will then be transformed to the first form which is allowed by the filter.
*
* editor.filter.allow( 'i; span{!font-style}' );
* editor.filter.addContentForms( [
* 'em',
* 'i',
* [ 'span', function( el ) {
* return el.styles[ 'font-style' ] == 'italic';
* } ]
* ] );
* // Now <em> and <span style="font-style:italic"> will be replaced with <i>
* // because this is the first allowed form.
* // <span> is allowed too, but it is the last form and
* // additionaly, the editor cannot transform an element based on
* // the array+function form).
*
* This method is used by the editor to register {@link CKEDITOR.feature#contentForms}
* when adding a feature with {@link #addFeature} or {@link CKEDITOR.editor#addFeature}.
*
* @param {Array} forms The content forms of a feature.
*/
addContentForms: function( forms ) {
if ( this.disabled )
return;
if ( !forms )
return;
var i, form,
transfGroups = [],
preferredForm;
// First, find preferred form - this is, first allowed.
for ( i = 0; i < forms.length && !preferredForm; ++i ) {
form = forms[ i ];
// Check only strings and styles - array format isn't supported by #check().
if ( ( typeof form == 'string' || form instanceof CKEDITOR.style ) && this.check( form ) )
preferredForm = form;
}
// This feature doesn't have preferredForm, so ignore it.
if ( !preferredForm )
return;
for ( i = 0; i < forms.length; ++i )
transfGroups.push( getContentFormTransformationGroup( forms[ i ], preferredForm ) );
this.addTransformations( transfGroups );
},
/**
* Adds a callback which will be executed on every element
* that the filter reaches when filtering, before the element is filtered.
*
* By returning {@link CKEDITOR#FILTER_SKIP_TREE} it is possible to
* skip filtering of the current element and all its ancestors.
*
* editor.filter.addElementCallback( function( el ) {
* if ( el.hasClass( 'protected' ) )
* return CKEDITOR.FILTER_SKIP_TREE;
* } );
*
* **Note:** At this stage the element passed to the callback does not
* contain `attributes`, `classes`, and `styles` properties which are available
* temporarily on later stages of the filtering process. Therefore you need to
* use the pure {@link CKEDITOR.htmlParser.element} interface.
*
* @since 4.4.0
* @param {Function} callback The callback to be executed.
*/
addElementCallback: function( callback ) {
// We want to keep it a falsy value, to speed up finding whether there are any callbacks.
if ( !this.elementCallbacks )
this.elementCallbacks = [];
this.elementCallbacks.push( callback );
},
/**
* Checks whether a feature can be enabled for the HTML restrictions in place
* for the current CKEditor instance, based on the HTML code the feature might
* generate and the minimal HTML code the feature needs to be able to generate.
*
* // TODO example
*
* @param {CKEDITOR.feature} feature
* @returns {Boolean} Whether this feature can be enabled.
*/
addFeature: function( feature ) {
if ( this.disabled )
return true;
if ( !feature )
return true;
// Some features may want to register other features.
// E.g. a button may return a command bound to it.
if ( feature.toFeature )
feature = feature.toFeature( this.editor );
// If default configuration (will be checked inside #allow()),
// then add allowed content rules.
this.allow( feature.allowedContent, feature.name );
this.addTransformations( feature.contentTransformations );
this.addContentForms( feature.contentForms );
// If custom configuration or any DACRs, then check if required content is allowed.
if ( feature.requiredContent && ( this.customConfig || this.disallowedContent.length ) )
return this.check( feature.requiredContent );
return true;
},
/**
* Adds an array of content transformation groups. One group
* may contain many transformation rules, but only the first
* matching rule in a group is executed.
*
* A single transformation rule is an object with four properties:
*
* * `check` (optional) – if set and {@link CKEDITOR.filter} does
* not accept this {@link CKEDITOR.filter.contentRule}, this transformation rule
* will not be executed (it does not *match*). This value is passed
* to {@link #check}.
* * `element` (optional) – this string property tells the filter on which
* element this transformation can be run. It is optional, because
* the element name can be obtained from `check` (if it is a String format)
* or `left` (if it is a {@link CKEDITOR.style} instance).
* * `left` (optional) – a function accepting an element or a {@link CKEDITOR.style}
* instance verifying whether the transformation should be
* executed on this specific element. If it returns `false` or if an element
* does not match this style, this transformation rule does not *match*.
* * `right` – a function accepting an element and {@link CKEDITOR.filter.transformationsTools}
* or a string containing the name of the {@link CKEDITOR.filter.transformationsTools} method
* that should be called on an element.
*
* A shorthand format is also available. A transformation rule can be defined by
* a single string `'check:right'`. The string before `':'` will be used as
* the `check` property and the second part as the `right` property.
*
* Transformation rules can be grouped. The filter will try to apply
* the first rule in a group. If it *matches*, the filter will ignore subsequent rules and
* will move to the next group. If it does not *match*, the next rule will be checked.
*
* Examples:
*
* editor.filter.addTransformations( [
* // First group.
* [
* // First rule. If table{width} is allowed, it
* // executes {@link CKEDITOR.filter.transformationsTools#sizeToStyle} on a table element.
* 'table{width}: sizeToStyle',
* // Second rule should not be executed if the first was.
* 'table[width]: sizeToAttribute'
* ],
* // Second group.
* [
* // This rule will add the foo="1" attribute to all images that
* // do not have it.
* {
* element: 'img',
* left: function( el ) {
* return !el.attributes.foo;
* },
* right: function( el, tools ) {
* el.attributes.foo = '1';
* }
* }
* ]
* ] );
*
* // Case 1:
* // config.allowedContent = 'table{height,width}; tr td'.
* //
* // '<table style="height:100px; width:200px">...</table>' -> '<table style="height:100px; width:200px">...</table>'
* // '<table height="100" width="200">...</table>' -> '<table style="height:100px; width:200px">...</table>'
*
* // Case 2:
* // config.allowedContent = 'table[height,width]; tr td'.
* //
* // '<table style="height:100px; width:200px">...</table>' -> '<table height="100" width="200">...</table>'
* // '<table height="100" width="200">...</table>' -> '<table height="100" width="200"">...</table>'
*
* // Case 3:
* // config.allowedContent = 'table{width,height}[height,width]; tr td'.
* //
* // '<table style="height:100px; width:200px">...</table>' -> '<table style="height:100px; width:200px">...</table>'
* // '<table height="100" width="200">...</table>' -> '<table style="height:100px; width:200px">...</table>'
* //
* // Note: Both forms are allowed (size set by style and by attributes), but only
* // the first transformation is applied — the size is always transformed to a style.
* // This is because only the first transformation matching allowed content rules is applied.
*
* This method is used by the editor to add {@link CKEDITOR.feature#contentTransformations}
* when adding a feature by {@link #addFeature} or {@link CKEDITOR.editor#addFeature}.
*
* @param {Array} transformations
*/
addTransformations: function( transformations ) {
if ( this.disabled )
return;
if ( !transformations )
return;
var optimized = this._.transformations,
group, i;
for ( i = 0; i < transformations.length; ++i ) {
group = optimizeTransformationsGroup( transformations[ i ] );
if ( !optimized[ group.name ] )
optimized[ group.name ] = [];
optimized[ group.name ].push( group.rules );
}
},
/**
* Checks whether the content defined in the `test` argument is allowed
* by this filter.
*
* If `strictCheck` is set to `false` (default value), this method checks
* if all parts of the `test` (styles, attributes, and classes) are
* accepted by the filter. If `strictCheck` is set to `true`, the test
* must also contain the required attributes, styles, and classes.
*
* For example:
*
* // Rule: 'img[!src,alt]'.
* filter.check( 'img[alt]' ); // -> true
* filter.check( 'img[alt]', true, true ); // -> false
*
* Second `check()` call returned `false` because `src` is required.
*
* When an array of rules is passed as the `test` argument, the filter
* returns `true` if at least one of the passed rules is allowed.
*
* For example:
*
* ```js
* // Rule: 'img'
* filter.check( [ 'img', 'div' ] ) // -> true
* filter.check( [ 'p', 'div' ] ) // -> false
* ```
*
* **Note:** The `test` argument is of {@link CKEDITOR.filter.contentRule} type, which is
* a limited version of {@link CKEDITOR.filter.allowedContentRules}. Read more about it
* in the {@link CKEDITOR.filter.contentRule}'s documentation.
*
* @param {CKEDITOR.filter.contentRule/CKEDITOR.filter.contentRule[]} test
* @param {Boolean} [applyTransformations=true] Whether to use registered transformations.
* @param {Boolean} [strictCheck] Whether the filter should check if an element with exactly
* these properties is allowed.
* @returns {Boolean} Returns `true` if the content is allowed.
*/
check: function( test, applyTransformations, strictCheck ) {
if ( this.disabled )
return true;
// If rules are an array, expand it and return the logical OR value of
// the rules.
if ( CKEDITOR.tools.isArray( test ) ) {
for ( var i = test.length ; i-- ; ) {
if ( this.check( test[ i ], applyTransformations, strictCheck ) )
return true;
}
return false;
}
var element, result, cacheKey;
if ( typeof test == 'string' ) {
cacheKey = test + '<' + ( applyTransformations === false ? '0' : '1' ) + ( strictCheck ? '1' : '0' ) + '>';
// Check if result of this check hasn't been already cached.
if ( cacheKey in this._.cachedChecks )
return this._.cachedChecks[ cacheKey ];
// Create test element from string.
element = mockElementFromString( test );
} else {
// Create test element from CKEDITOR.style.
element = mockElementFromStyle( test );
}
// Make a deep copy.
var clone = CKEDITOR.tools.clone( element ),
toBeRemoved = [],
transformations;
// Apply transformations to original element.
// Transformations will be applied to clone by the filter function.
if ( applyTransformations !== false && ( transformations = this._.transformations[ element.name ] ) ) {
for ( i = 0; i < transformations.length; ++i )
applyTransformationsGroup( this, element, transformations[ i ] );
// Transformations could modify styles or classes, so they need to be copied
// to attributes object.
updateAttributes( element );
}
// Filter clone of mocked element.
processElement( this, clone, toBeRemoved, {
doFilter: true,
doTransform: applyTransformations !== false,
skipRequired: !strictCheck,
skipFinalValidation: !strictCheck
} );
// Element has been marked for removal.
if ( toBeRemoved.length > 0 ) {
result = false;
}
else {
// We need to compare class alphabetically, because cloned element is created in such way (#727).
var originClassNames = element.attributes[ 'class' ];
if ( originClassNames ) {
element.attributes[ 'class' ] = element.attributes[ 'class' ].split( ' ' ).sort().join( ' ' );
}
result = CKEDITOR.tools.objectCompare( element.attributes, clone.attributes, true );
if ( originClassNames ) {
element.attributes[ 'class' ] = originClassNames;
}
}
// Cache result of this test - we can build cache only for string tests.
if ( typeof test == 'string' )
this._.cachedChecks[ cacheKey ] = result;
return result;
},
/**
* Returns first enter mode allowed by this filter rules. Modes are checked in `p`, `div`, `br` order.
* If none of tags is allowed this method will return {@link CKEDITOR#ENTER_BR}.
*
* @since 4.3.0
* @param {Number} defaultMode The default mode which will be checked as the first one.
* @param {Boolean} [reverse] Whether to check modes in reverse order (used for shift enter mode).
* @returns {Number} Allowed enter mode.
*/
getAllowedEnterMode: ( function() {
var tagsToCheck = [ 'p', 'div', 'br' ],
enterModes = {
p: CKEDITOR.ENTER_P,
div: CKEDITOR.ENTER_DIV,
br: CKEDITOR.ENTER_BR
};
return function( defaultMode, reverse ) {
// Clone the array first.
var tags = tagsToCheck.slice(),
tag;
// Check the default mode first.
if ( this.check( enterModeTags[ defaultMode ] ) )
return defaultMode;
// If not reverse order, reverse array so we can pop() from it.
if ( !reverse )
tags = tags.reverse();
while ( ( tag = tags.pop() ) ) {
if ( this.check( tag ) )
return enterModes[ tag ];
}
return CKEDITOR.ENTER_BR;
};
} )(),
/**
* Returns a clone of this filter instance.
*
* @since 4.7.3
* @returns {CKEDITOR.filter}
*/
clone: function() {
var ret = new CKEDITOR.filter(),
clone = CKEDITOR.tools.clone;
// Cloning allowed content related things.
ret.allowedContent = clone( this.allowedContent );
ret._.allowedRules = clone( this._.allowedRules );
// Disallowed content rules.
ret.disallowedContent = clone( this.disallowedContent );
ret._.disallowedRules = clone( this._.disallowedRules );
ret._.transformations = clone( this._.transformations );
ret.disabled = this.disabled;
ret.editor = this.editor;
return ret;
},
/**
* Destroys the filter instance and removes it from the global {@link CKEDITOR.filter#instances} object.
*
* @since 4.4.5
*/
destroy: function() {
delete CKEDITOR.filter.instances[ this.id ];
// Deleting reference to filter instance should be enough,
// but since these are big objects it's safe to clean them up too.
delete this._;
delete this.allowedContent;
delete this.disallowedContent;
}
};
function addAndOptimizeRules( that, newRules, featureName, standardizedRules, optimizedRules ) {
var groupName, rule,
rulesToOptimize = [];
for ( groupName in newRules ) {
rule = newRules[ groupName ];
// { 'p h1': true } => { 'p h1': {} }.
if ( typeof rule == 'boolean' )
rule = {};
// { 'p h1': func } => { 'p h1': { match: func } }.
else if ( typeof rule == 'function' )
rule = { match: rule };
// Clone (shallow) rule, because we'll modify it later.
else
rule = copy( rule );
// If this is not an unnamed rule ({ '$1' => { ... } })
// move elements list to property.
if ( groupName.charAt( 0 ) != '$' )
rule.elements = groupName;
if ( featureName )
rule.featureName = featureName.toLowerCase();
standardizeRule( rule );
// Save rule and remember to optimize it.
standardizedRules.push( rule );
rulesToOptimize.push( rule );
}
optimizeRules( optimizedRules, rulesToOptimize );
}
// Apply ACR to an element.
// @param rule
// @param element
// @param status Object containing status of element's filtering.
// @param {Boolean} skipRequired If true don't check if element has all required properties.
function applyAllowedRule( rule, element, status, skipRequired ) {
// This rule doesn't match this element - skip it.
if ( rule.match && !rule.match( element ) )
return;
// If element doesn't have all required styles/attrs/classes
// this rule doesn't match it.
if ( !skipRequired && !hasAllRequired( rule, element ) )
return;
// If this rule doesn't validate properties only mark element as valid.
if ( !rule.propertiesOnly )
status.valid = true;
// Apply rule only when all attrs/styles/classes haven't been marked as valid.
if ( !status.allAttributes )
status.allAttributes = applyAllowedRuleToHash( rule.attributes, element.attributes, status.validAttributes );
if ( !status.allStyles )
status.allStyles = applyAllowedRuleToHash( rule.styles, element.styles, status.validStyles );
if ( !status.allClasses )
status.allClasses = applyAllowedRuleToArray( rule.classes, element.classes, status.validClasses );
}
// Apply itemsRule to items (only classes are kept in array).
// Push accepted items to validItems array.
// Return true when all items are valid.
function applyAllowedRuleToArray( itemsRule, items, validItems ) {
if ( !itemsRule )
return false;
// True means that all elements of array are accepted (the asterix was used for classes).
if ( itemsRule === true )
return true;
for ( var i = 0, l = items.length, item; i < l; ++i ) {
item = items[ i ];
if ( !validItems[ item ] )
validItems[ item ] = itemsRule( item );
}
return false;
}
function applyAllowedRuleToHash( itemsRule, items, validItems ) {
if ( !itemsRule )
return false;
if ( itemsRule === true )
return true;
for ( var name in items ) {
if ( !validItems[ name ] )
validItems[ name ] = itemsRule( name );
}
return false;
}
// Apply DACR rule to an element.
function applyDisallowedRule( rule, element, status ) {
// This rule doesn't match this element - skip it.
if ( rule.match && !rule.match( element ) )
return;
// No properties - it's an element only rule so it disallows entire element.
// Early return is handled in filterElement.
if ( rule.noProperties )
return false;
// Apply rule to attributes, styles and classes. Switch hadInvalid* to true if method returned true.
status.hadInvalidAttribute = applyDisallowedRuleToHash( rule.attributes, element.attributes ) || status.hadInvalidAttribute;
status.hadInvalidStyle = applyDisallowedRuleToHash( rule.styles, element.styles ) || status.hadInvalidStyle;
status.hadInvalidClass = applyDisallowedRuleToArray( rule.classes, element.classes ) || status.hadInvalidClass;
}
// Apply DACR to items (only classes are kept in array).