2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
8 // Regex to scan for at the end of blocks, which are actually placeholders.
\r
9 // Safari transforms the to \xa0. (#4172)
\r
10 var tailNbspRegex = /^[\t\r\n ]*(?: |\xa0)$/;
\r
12 var protectedSourceMarker = '{cke_protected}';
\r
14 // Return the last non-space child node of the block (#4344).
\r
15 function lastNoneSpaceChild( block )
\r
17 var lastIndex = block.children.length,
\r
18 last = block.children[ lastIndex - 1 ];
\r
19 while ( last && last.type == CKEDITOR.NODE_TEXT && !CKEDITOR.tools.trim( last.value ) )
\r
20 last = block.children[ --lastIndex ];
\r
24 function trimFillers( block, fromSource )
\r
26 // If the current node is a block, and if we're converting from source or
\r
27 // we're not in IE then search for and remove any tailing BR node.
\r
29 // Also, any at the end of blocks are fillers, remove them as well.
\r
31 var children = block.children, lastChild = lastNoneSpaceChild( block );
\r
34 if ( ( fromSource || !CKEDITOR.env.ie ) && lastChild.type == CKEDITOR.NODE_ELEMENT && lastChild.name == 'br' )
\r
36 if ( lastChild.type == CKEDITOR.NODE_TEXT && tailNbspRegex.test( lastChild.value ) )
\r
41 function blockNeedsExtension( block, fromSource, extendEmptyBlock )
\r
43 if( !fromSource && ( !extendEmptyBlock ||
\r
44 typeof extendEmptyBlock == 'function' && ( extendEmptyBlock( block ) === false ) ) )
\r
47 // 1. For IE version >=8, empty blocks are displayed correctly themself in wysiwiyg;
\r
48 // 2. For the rest, at least table cell and list item need no filler space.
\r
50 if ( fromSource && CKEDITOR.env.ie &&
\r
51 ( document.documentMode > 7
\r
52 || block.name in CKEDITOR.dtd.tr
\r
53 || block.name in CKEDITOR.dtd.$listItem ) )
\r
56 var lastChild = lastNoneSpaceChild( block );
\r
58 return !lastChild || lastChild &&
\r
59 ( lastChild.type == CKEDITOR.NODE_ELEMENT && lastChild.name == 'br'
\r
60 // Some of the controls in form needs extension too,
\r
61 // to move cursor at the end of the form. (#4791)
\r
62 || block.name == 'form' && lastChild.name == 'input' );
\r
65 function getBlockExtension( isOutput, emptyBlockFiller )
\r
67 return function( node )
\r
69 trimFillers( node, !isOutput );
\r
71 if ( blockNeedsExtension( node, !isOutput, emptyBlockFiller ) )
\r
73 if ( isOutput || CKEDITOR.env.ie )
\r
74 node.add( new CKEDITOR.htmlParser.text( '\xa0' ) );
\r
76 node.add( new CKEDITOR.htmlParser.element( 'br', {} ) );
\r
81 var dtd = CKEDITOR.dtd;
\r
83 // Define orders of table elements.
\r
84 var tableOrder = [ 'caption', 'colgroup', 'col', 'thead', 'tfoot', 'tbody' ];
\r
86 // Find out the list of block-like tags that can contain <br>.
\r
87 var blockLikeTags = CKEDITOR.tools.extend( {}, dtd.$block, dtd.$listItem, dtd.$tableContent );
\r
88 for ( var i in blockLikeTags )
\r
90 if ( ! ( 'br' in dtd[i] ) )
\r
91 delete blockLikeTags[i];
\r
93 // We just avoid filler in <pre> right now.
\r
94 // TODO: Support filler for <pre>, line break is also occupy line height.
\r
95 delete blockLikeTags.pre;
\r
96 var defaultDataFilterRules =
\r
101 // Event attributes (onXYZ) must not be directly set. They can become
\r
102 // active in the editing area (IE|WebKit).
\r
103 [ ( /^on/ ), 'data-cke-pa-on' ]
\r
107 var defaultDataBlockFilterRules = { elements : {} };
\r
109 for ( i in blockLikeTags )
\r
110 defaultDataBlockFilterRules.elements[ i ] = getBlockExtension();
\r
112 var defaultHtmlFilterRules =
\r
116 // Remove the "cke:" namespace prefix.
\r
117 [ ( /^cke:/ ), '' ],
\r
119 // Ignore <?xml:namespace> tags.
\r
120 [ ( /^\?xml:namespace$/ ), '' ]
\r
125 // Attributes saved for changes and protected attributes.
\r
126 [ ( /^data-cke-(saved|pa)-/ ), '' ],
\r
128 // All "data-cke-" attributes are to be ignored.
\r
129 [ ( /^data-cke-.*/ ), '' ],
\r
131 [ 'hidefocus', '' ]
\r
136 $ : function( element )
\r
138 var attribs = element.attributes;
\r
142 // Elements marked as temporary are to be ignored.
\r
143 if ( attribs[ 'data-cke-temp' ] )
\r
146 // Remove duplicated attributes - #3789.
\r
147 var attributeNames = [ 'name', 'href', 'src' ],
\r
148 savedAttributeName;
\r
149 for ( var i = 0 ; i < attributeNames.length ; i++ )
\r
151 savedAttributeName = 'data-cke-saved-' + attributeNames[ i ];
\r
152 savedAttributeName in attribs && ( delete attribs[ attributeNames[ i ] ] );
\r
159 // The contents of table should be in correct order (#4809).
\r
160 table : function( element )
\r
162 var children = element.children;
\r
163 children.sort( function ( node1, node2 )
\r
165 return node1.type == CKEDITOR.NODE_ELEMENT && node2.type == node1.type ?
\r
166 CKEDITOR.tools.indexOf( tableOrder, node1.name ) > CKEDITOR.tools.indexOf( tableOrder, node2.name ) ? 1 : -1 : 0;
\r
170 embed : function( element )
\r
172 var parent = element.parent;
\r
174 // If the <embed> is child of a <object>, copy the width
\r
175 // and height attributes from it.
\r
176 if ( parent && parent.name == 'object' )
\r
178 var parentWidth = parent.attributes.width,
\r
179 parentHeight = parent.attributes.height;
\r
180 parentWidth && ( element.attributes.width = parentWidth );
\r
181 parentHeight && ( element.attributes.height = parentHeight );
\r
184 // Restore param elements into self-closing.
\r
185 param : function( param )
\r
187 param.children = [];
\r
188 param.isEmpty = true;
\r
192 // Remove empty link but not empty anchor.(#3829)
\r
193 a : function( element )
\r
195 if ( !( element.children.length ||
\r
196 element.attributes.name ||
\r
197 element.attributes[ 'data-cke-saved-name' ] ) )
\r
203 // Remove dummy span in webkit.
\r
204 span: function( element )
\r
206 if ( element.attributes[ 'class' ] == 'Apple-style-span' )
\r
207 delete element.name;
\r
210 // Empty <pre> in IE is reported with filler node ( ).
\r
211 pre : function( element ) { CKEDITOR.env.ie && trimFillers( element ); },
\r
213 html : function( element )
\r
215 delete element.attributes.contenteditable;
\r
216 delete element.attributes[ 'class' ];
\r
219 body : function( element )
\r
221 delete element.attributes.spellcheck;
\r
222 delete element.attributes.contenteditable;
\r
225 style : function( element )
\r
227 var child = element.children[ 0 ];
\r
228 child && child.value && ( child.value = CKEDITOR.tools.trim( child.value ));
\r
230 if ( !element.attributes.type )
\r
231 element.attributes.type = 'text/css';
\r
234 title : function( element )
\r
236 var titleText = element.children[ 0 ];
\r
237 titleText && ( titleText.value = element.attributes[ 'data-cke-title' ] || '' );
\r
243 'class' : function( value, element )
\r
245 // Remove all class names starting with "cke_".
\r
246 return CKEDITOR.tools.ltrim( value.replace( /(?:^|\s+)cke_[^\s]*/g, '' ) ) || false;
\r
251 if ( CKEDITOR.env.ie )
\r
253 // IE outputs style attribute in capital letters. We should convert
\r
254 // them back to lower case, while not hurting the values (#5930)
\r
255 defaultHtmlFilterRules.attributes.style = function( value, element )
\r
257 return value.replace( /(^|;)([^\:]+)/g, function( match )
\r
259 return match.toLowerCase();
\r
264 function protectReadOnly( element )
\r
266 var attrs = element.attributes;
\r
268 // We should flag that the element was locked by our code so
\r
269 // it'll be editable by the editor functions (#6046).
\r
270 if ( attrs.contenteditable != "false" )
\r
271 attrs[ 'data-cke-editable' ] = attrs.contenteditable ? 'true' : 1;
\r
273 attrs.contenteditable = "false";
\r
275 function unprotectReadyOnly( element )
\r
277 var attrs = element.attributes;
\r
278 switch( attrs[ 'data-cke-editable' ] )
\r
280 case 'true': attrs.contenteditable = 'true'; break;
\r
281 case '1': delete attrs.contenteditable; break;
\r
284 // Disable form elements editing mode provided by some browers. (#5746)
\r
285 for ( i in { input : 1, textarea : 1 } )
\r
287 defaultDataFilterRules.elements[ i ] = protectReadOnly;
\r
288 defaultHtmlFilterRules.elements[ i ] = unprotectReadyOnly;
\r
291 var protectElementRegex = /<(a|area|img|input)\b([^>]*)>/gi,
\r
292 protectAttributeRegex = /\b(href|src|name)\s*=\s*(?:(?:"[^"]*")|(?:'[^']*')|(?:[^ "'>]+))/gi;
\r
294 var protectElementsRegex = /(?:<style(?=[ >])[^>]*>[\s\S]*<\/style>)|(?:<(:?link|meta|base)[^>]*>)/gi,
\r
295 encodedElementsRegex = /<cke:encoded>([^<]*)<\/cke:encoded>/gi;
\r
297 var protectElementNamesRegex = /(<\/?)((?:object|embed|param|html|body|head|title)[^>]*>)/gi,
\r
298 unprotectElementNamesRegex = /(<\/?)cke:((?:html|body|head|title)[^>]*>)/gi;
\r
300 var protectSelfClosingRegex = /<cke:(param|embed)([^>]*?)\/?>(?!\s*<\/cke:\1)/gi;
\r
302 function protectAttributes( html )
\r
304 return html.replace( protectElementRegex, function( element, tag, attributes )
\r
306 return '<' + tag + attributes.replace( protectAttributeRegex, function( fullAttr, attrName )
\r
308 // We should not rewrite the existed protected attributes, e.g. clipboard content from editor. (#5218)
\r
309 if ( attributes.indexOf( 'data-cke-saved-' + attrName ) == -1 )
\r
310 return ' data-cke-saved-' + fullAttr + ' ' + fullAttr;
\r
317 function protectElements( html )
\r
319 return html.replace( protectElementsRegex, function( match )
\r
321 return '<cke:encoded>' + encodeURIComponent( match ) + '</cke:encoded>';
\r
325 function unprotectElements( html )
\r
327 return html.replace( encodedElementsRegex, function( match, encoded )
\r
329 return decodeURIComponent( encoded );
\r
333 function protectElementsNames( html )
\r
335 return html.replace( protectElementNamesRegex, '$1cke:$2');
\r
338 function unprotectElementNames( html )
\r
340 return html.replace( unprotectElementNamesRegex, '$1$2' );
\r
343 function protectSelfClosingElements( html )
\r
345 return html.replace( protectSelfClosingRegex, '<cke:$1$2></cke:$1>' );
\r
348 function protectPreFormatted( html )
\r
350 return html.replace( /(<pre\b[^>]*>)(\r\n|\n)/g, '$1$2$2' );
\r
353 function protectRealComments( html )
\r
355 return html.replace( /<!--(?!{cke_protected})[\s\S]+?-->/g, function( match )
\r
357 return '<!--' + protectedSourceMarker +
\r
359 encodeURIComponent( match ).replace( /--/g, '%2D%2D' ) +
\r
364 function unprotectRealComments( html )
\r
366 return html.replace( /<!--\{cke_protected\}\{C\}([\s\S]+?)-->/g, function( match, data )
\r
368 return decodeURIComponent( data );
\r
372 function unprotectSource( html, editor )
\r
374 var store = editor._.dataStore;
\r
376 return html.replace( /<!--\{cke_protected\}([\s\S]+?)-->/g, function( match, data )
\r
378 return decodeURIComponent( data );
\r
379 }).replace( /\{cke_protected_(\d+)\}/g, function( match, id )
\r
381 return store && store[ id ] || '';
\r
385 function protectSource( data, editor )
\r
387 var protectedHtml = [],
\r
388 protectRegexes = editor.config.protectedSource,
\r
389 store = editor._.dataStore || ( editor._.dataStore = { id : 1 } ),
\r
390 tempRegex = /<\!--\{cke_temp(comment)?\}(\d*?)-->/g;
\r
394 // Script tags will also be forced to be protected, otherwise
\r
395 // IE will execute them.
\r
396 ( /<script[\s\S]*?<\/script>/gi ),
\r
398 // <noscript> tags (get lost in IE and messed up in FF).
\r
399 /<noscript[\s\S]*?<\/noscript>/gi
\r
401 .concat( protectRegexes );
\r
403 // First of any other protection, we must protect all comments
\r
404 // to avoid loosing them (of course, IE related).
\r
405 // Note that we use a different tag for comments, as we need to
\r
406 // transform them when applying filters.
\r
407 data = data.replace( (/<!--[\s\S]*?-->/g), function( match )
\r
409 return '<!--{cke_tempcomment}' + ( protectedHtml.push( match ) - 1 ) + '-->';
\r
412 for ( var i = 0 ; i < regexes.length ; i++ )
\r
414 data = data.replace( regexes[i], function( match )
\r
416 match = match.replace( tempRegex, // There could be protected source inside another one. (#3869).
\r
417 function( $, isComment, id )
\r
419 return protectedHtml[ id ];
\r
423 // Avoid protecting over protected, e.g. /\{.*?\}/
\r
424 return ( /cke_temp(comment)?/ ).test( match ) ? match
\r
425 : '<!--{cke_temp}' + ( protectedHtml.push( match ) - 1 ) + '-->';
\r
428 data = data.replace( tempRegex, function( $, isComment, id )
\r
430 return '<!--' + protectedSourceMarker +
\r
431 ( isComment ? '{C}' : '' ) +
\r
432 encodeURIComponent( protectedHtml[ id ] ).replace( /--/g, '%2D%2D' ) +
\r
437 // Different protection pattern is used for those that
\r
438 // live in attributes to avoid from being HTML encoded.
\r
439 return data.replace( /(['"]).*?\1/g, function ( match )
\r
441 return match.replace( /<!--\{cke_protected\}([\s\S]+?)-->/g, function( match, data )
\r
443 store[ store.id ] = decodeURIComponent( data );
\r
444 return '{cke_protected_'+ ( store.id++ ) + '}';
\r
449 CKEDITOR.plugins.add( 'htmldataprocessor',
\r
451 requires : [ 'htmlwriter' ],
\r
453 init : function( editor )
\r
455 var dataProcessor = editor.dataProcessor = new CKEDITOR.htmlDataProcessor( editor );
\r
457 dataProcessor.writer.forceSimpleAmpersand = editor.config.forceSimpleAmpersand;
\r
459 dataProcessor.dataFilter.addRules( defaultDataFilterRules );
\r
460 dataProcessor.dataFilter.addRules( defaultDataBlockFilterRules );
\r
461 dataProcessor.htmlFilter.addRules( defaultHtmlFilterRules );
\r
463 var defaultHtmlBlockFilterRules = { elements : {} };
\r
464 for ( i in blockLikeTags )
\r
465 defaultHtmlBlockFilterRules.elements[ i ] = getBlockExtension( true, editor.config.fillEmptyBlocks );
\r
467 dataProcessor.htmlFilter.addRules( defaultHtmlBlockFilterRules );
\r
470 onLoad : function()
\r
472 ! ( 'fillEmptyBlocks' in CKEDITOR.config ) && ( CKEDITOR.config.fillEmptyBlocks = 1 );
\r
476 CKEDITOR.htmlDataProcessor = function( editor )
\r
478 this.editor = editor;
\r
480 this.writer = new CKEDITOR.htmlWriter();
\r
481 this.dataFilter = new CKEDITOR.htmlParser.filter();
\r
482 this.htmlFilter = new CKEDITOR.htmlParser.filter();
\r
485 CKEDITOR.htmlDataProcessor.prototype =
\r
487 toHtml : function( data, fixForBody )
\r
489 // The source data is already HTML, but we need to clean
\r
490 // it up and apply the filter.
\r
492 data = protectSource( data, this.editor );
\r
494 // Before anything, we must protect the URL attributes as the
\r
495 // browser may changing them when setting the innerHTML later in
\r
497 data = protectAttributes( data );
\r
499 // Protect elements than can't be set inside a DIV. E.g. IE removes
\r
500 // style tags from innerHTML. (#3710)
\r
501 data = protectElements( data );
\r
503 // Certain elements has problem to go through DOM operation, protect
\r
504 // them by prefixing 'cke' namespace. (#3591)
\r
505 data = protectElementsNames( data );
\r
507 // All none-IE browsers ignore self-closed custom elements,
\r
508 // protecting them into open-close. (#3591)
\r
509 data = protectSelfClosingElements( data );
\r
511 // Compensate one leading line break after <pre> open as browsers
\r
512 // eat it up. (#5789)
\r
513 data = protectPreFormatted( data );
\r
515 // Call the browser to help us fixing a possibly invalid HTML
\r
517 var div = new CKEDITOR.dom.element( 'div' );
\r
518 // Add fake character to workaround IE comments bug. (#3801)
\r
519 div.setHtml( 'a' + data );
\r
520 data = div.getHtml().substr( 1 );
\r
522 // Unprotect "some" of the protected elements at this point.
\r
523 data = unprotectElementNames( data );
\r
525 data = unprotectElements( data );
\r
527 // Restore the comments that have been protected, in this way they
\r
528 // can be properly filtered.
\r
529 data = unprotectRealComments( data );
\r
531 // Now use our parser to make further fixes to the structure, as
\r
532 // well as apply the filter.
\r
533 var fragment = CKEDITOR.htmlParser.fragment.fromHtml( data, fixForBody ),
\r
534 writer = new CKEDITOR.htmlParser.basicWriter();
\r
536 fragment.writeHtml( writer, this.dataFilter );
\r
537 data = writer.getHtml( true );
\r
539 // Protect the real comments again.
\r
540 data = protectRealComments( data );
\r
545 toDataFormat : function( html, fixForBody )
\r
547 var writer = this.writer,
\r
548 fragment = CKEDITOR.htmlParser.fragment.fromHtml( html, fixForBody );
\r
552 fragment.writeHtml( writer, this.htmlFilter );
\r
554 var data = writer.getHtml( true );
\r
556 // Restore those non-HTML protected source. (#4475,#4880)
\r
557 data = unprotectRealComments( data );
\r
558 data = unprotectSource( data, this.editor );
\r
566 * Whether to force using "&" instead of "&amp;" in elements attributes
\r
567 * values, it's not recommended to change this setting for compliance with the
\r
568 * W3C XHTML 1.0 standards (<a href="http://www.w3.org/TR/xhtml1/#C_12">C.12, XHTML 1.0</a>).
\r
569 * @name CKEDITOR.config.forceSimpleAmpersand
\r
570 * @name CKEDITOR.config.forceSimpleAmpersand
\r
574 * config.forceSimpleAmpersand = false;
\r
578 * Whether a filler text (non-breaking space entity - ) will be inserted into empty block elements in HTML output,
\r
579 * this is used to render block elements properly with line-height; When a function is instead specified,
\r
580 * it'll be passed a {@link CKEDITOR.htmlParser.element} to decide whether adding the filler text
\r
581 * by expecting a boolean return value.
\r
582 * @name CKEDITOR.config.fillEmptyBlocks
\r
587 * config.fillEmptyBlocks = false; // Prevent filler nodes in all empty blocks.
\r
589 * // Prevent filler node only in float cleaners.
\r
590 * config.fillEmptyBlocks = function( element )
\r
592 * if ( element.attributes[ 'class' ].indexOf ( 'clear-both' ) != -1 )
\r