JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.5
[ckeditor.git] / _source / plugins / htmldataprocessor / plugin.js
index d783d66..f9b5dea 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -11,6 +11,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
        var protectedSourceMarker = '{cke_protected}';\r
 \r
+       // Return the last non-space child node of the block (#4344).\r
+       function lastNoneSpaceChild( block )\r
+       {\r
+               var lastIndex = block.children.length,\r
+                       last = block.children[ lastIndex - 1 ];\r
+               while (  last && last.type == CKEDITOR.NODE_TEXT && !CKEDITOR.tools.trim( last.value ) )\r
+                       last = block.children[ --lastIndex ];\r
+               return last;\r
+       }\r
+\r
        function trimFillers( block, fromSource )\r
        {\r
                // If the current node is a block, and if we're converting from source or\r
@@ -18,8 +28,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                //\r
                // Also, any   at the end of blocks are fillers, remove them as well.\r
                // (#2886)\r
-               var children = block.children;\r
-               var lastChild = children[ children.length - 1 ];\r
+               var children = block.children, lastChild = lastNoneSpaceChild( block );\r
                if ( lastChild )\r
                {\r
                        if ( ( fromSource || !CKEDITOR.env.ie ) && lastChild.type == CKEDITOR.NODE_ELEMENT && lastChild.name == 'br' )\r
@@ -29,34 +38,44 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                }\r
        }\r
 \r
-       function blockNeedsExtension( block )\r
+       function blockNeedsExtension( block, fromSource, extendEmptyBlock )\r
        {\r
-               if ( block.children.length < 1 )\r
-                       return true;\r
-\r
-               var lastChild = block.children[ block.children.length - 1 ];\r
-               return lastChild.type == CKEDITOR.NODE_ELEMENT && lastChild.name == 'br';\r
+               if( !fromSource && ( !extendEmptyBlock ||\r
+                       typeof extendEmptyBlock == 'function' && ( extendEmptyBlock( block ) === false ) ) )\r
+                       return false;\r
+\r
+        // 1. For IE version >=8,  empty blocks are displayed correctly themself in wysiwiyg;\r
+        // 2. For the rest, at least table cell and list item need no filler space.\r
+        // (#6248)\r
+        if ( fromSource && CKEDITOR.env.ie &&\r
+                ( document.documentMode > 7\r
+                || block.name in CKEDITOR.dtd.tr\r
+                || block.name in CKEDITOR.dtd.$listItem ) )\r
+            return false;\r
+\r
+               var lastChild = lastNoneSpaceChild( block );\r
+\r
+               return !lastChild || lastChild &&\r
+                               ( lastChild.type == CKEDITOR.NODE_ELEMENT && lastChild.name == 'br'\r
+                               // Some of the controls in form needs extension too,\r
+                               // to move cursor at the end of the form. (#4791)\r
+                               || block.name == 'form' && lastChild.name == 'input' );\r
        }\r
 \r
-       function extendBlockForDisplay( block )\r
+       function getBlockExtension( isOutput, emptyBlockFiller )\r
        {\r
-               trimFillers( block, true );\r
-\r
-               if ( blockNeedsExtension( block ) )\r
+               return function( node )\r
                {\r
-                       if ( CKEDITOR.env.ie )\r
-                               block.add( new CKEDITOR.htmlParser.text( '\xa0' ) );\r
-                       else\r
-                               block.add( new CKEDITOR.htmlParser.element( 'br', {} ) );\r
-               }\r
-       }\r
-\r
-       function extendBlockForOutput( block )\r
-       {\r
-               trimFillers( block );\r
+                       trimFillers( node, !isOutput );\r
 \r
-               if ( blockNeedsExtension( block ) )\r
-                       block.add( new CKEDITOR.htmlParser.text( '\xa0' ) );\r
+                       if ( blockNeedsExtension( node, !isOutput, emptyBlockFiller ) )\r
+                       {\r
+                               if ( isOutput || CKEDITOR.env.ie )\r
+                                       node.add( new CKEDITOR.htmlParser.text( '\xa0' ) );\r
+                               else\r
+                                       node.add( new CKEDITOR.htmlParser.element( 'br', {} ) );\r
+                       }\r
+               };\r
        }\r
 \r
        var dtd = CKEDITOR.dtd;\r
@@ -73,18 +92,19 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        delete blockLikeTags.pre;\r
        var defaultDataFilterRules =\r
        {\r
+               elements : {},\r
                attributeNames :\r
                [\r
                        // Event attributes (onXYZ) must not be directly set. They can become\r
                        // active in the editing area (IE|WebKit).\r
-                       [ ( /^on/ ), '_cke_pa_on' ]\r
+                       [ ( /^on/ ), 'data-cke-pa-on' ]\r
                ]\r
        };\r
 \r
        var defaultDataBlockFilterRules = { elements : {} };\r
 \r
        for ( i in blockLikeTags )\r
-               defaultDataBlockFilterRules.elements[ i ] = extendBlockForDisplay;\r
+               defaultDataBlockFilterRules.elements[ i ] = getBlockExtension();\r
 \r
        var defaultHtmlFilterRules =\r
                {\r
@@ -100,29 +120,37 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        attributeNames :\r
                        [\r
                                // Attributes saved for changes and protected attributes.\r
-                               [ ( /^_cke_(saved|pa)_/ ), '' ],\r
+                               [ ( /^data-cke-(saved|pa)-/ ), '' ],\r
+\r
+                               // All "data-cke" attributes are to be ignored.\r
+                               [ ( /^data-cke.*/ ), '' ],\r
 \r
-                               // All "_cke" attributes are to be ignored.\r
-                               [ ( /^_cke.*/ ), '' ]\r
+                               [ 'hidefocus', '' ]\r
                        ],\r
 \r
                        elements :\r
                        {\r
                                $ : function( element )\r
                                {\r
-                                       // Remove duplicated attributes - #3789.\r
                                        var attribs = element.attributes;\r
 \r
                                        if ( attribs )\r
                                        {\r
+                                               // Elements marked as temporary are to be ignored.\r
+                                               if ( attribs[ 'data-cke-temp' ] )\r
+                                                       return false;\r
+\r
+                                               // Remove duplicated attributes - #3789.\r
                                                var attributeNames = [ 'name', 'href', 'src' ],\r
                                                        savedAttributeName;\r
                                                for ( var i = 0 ; i < attributeNames.length ; i++ )\r
                                                {\r
-                                                       savedAttributeName = '_cke_saved_' + attributeNames[ i ];\r
+                                                       savedAttributeName = 'data-cke-saved-' + attributeNames[ i ];\r
                                                        savedAttributeName in attribs && ( delete attribs[ attributeNames[ i ] ] );\r
                                                }\r
                                        }\r
+\r
+                                       return element;\r
                                },\r
 \r
                                embed : function( element )\r
@@ -152,10 +180,44 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                {\r
                                        if ( !( element.children.length ||\r
                                                        element.attributes.name ||\r
-                                                       element.attributes._cke_saved_name ) )\r
+                                                       element.attributes[ 'data-cke-saved-name' ] ) )\r
                                        {\r
                                                return false;\r
                                        }\r
+                               },\r
+\r
+                               // Remove dummy span in webkit.\r
+                               span: function( element )\r
+                               {\r
+                                       if ( element.attributes[ 'class' ] == 'Apple-style-span' )\r
+                                               delete element.name;\r
+                               },\r
+\r
+                               html : function( element )\r
+                               {\r
+                                       delete element.attributes.contenteditable;\r
+                                       delete element.attributes[ 'class' ];\r
+                               },\r
+\r
+                               body : function( element )\r
+                               {\r
+                                       delete element.attributes.spellcheck;\r
+                                       delete element.attributes.contenteditable;\r
+                               },\r
+\r
+                               style : function( element )\r
+                               {\r
+                                       var child = element.children[ 0 ];\r
+                                       child && child.value && ( child.value = CKEDITOR.tools.trim( child.value ));\r
+\r
+                                       if ( !element.attributes.type )\r
+                                               element.attributes.type = 'text/css';\r
+                               },\r
+\r
+                               title : function( element )\r
+                               {\r
+                                       var titleText = element.children[ 0 ];\r
+                                       titleText && ( titleText.value = element.attributes[ 'data-cke-title' ] || '' );\r
                                }\r
                        },\r
 \r
@@ -170,18 +232,22 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                        comment : function( contents )\r
                        {\r
+                               // If this is a comment for protected source.\r
                                if ( contents.substr( 0, protectedSourceMarker.length ) == protectedSourceMarker )\r
-                                       return new CKEDITOR.htmlParser.cdata( decodeURIComponent( contents.substr( protectedSourceMarker.length ) ) );\r
+                               {\r
+                                       // Remove the extra marker for real comments from it.\r
+                                       if ( contents.substr( protectedSourceMarker.length, 3 ) == '{C}' )\r
+                                               contents = contents.substr( protectedSourceMarker.length + 3 );\r
+                                       else\r
+                                               contents = contents.substr( protectedSourceMarker.length );\r
+\r
+                                       return new CKEDITOR.htmlParser.cdata( decodeURIComponent( contents ) );\r
+                               }\r
 \r
                                return contents;\r
                        }\r
                };\r
 \r
-       var defaultHtmlBlockFilterRules = { elements : {} };\r
-\r
-       for ( i in blockLikeTags )\r
-               defaultHtmlBlockFilterRules.elements[ i ] = extendBlockForOutput;\r
-\r
        if ( CKEDITOR.env.ie )\r
        {\r
                // IE outputs style attribute in capital letters. We should convert\r
@@ -192,71 +258,130 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                };\r
        }\r
 \r
-       var protectAttributeRegex = /<(?:a|area|img|input).*?\s((?:href|src|name)\s*=\s*(?:(?:"[^"]*")|(?:'[^']*')|(?:[^ "'>]+)))/gi;\r
+       function protectReadOnly( element )\r
+       {\r
+               element.attributes.contenteditable = "false";\r
+       }\r
+       function unprotectReadyOnly( element )\r
+       {\r
+               delete element.attributes.contenteditable;\r
+       }\r
+       // Disable form elements editing mode provided by some browers. (#5746)\r
+       for ( i in { input : 1, textarea : 1 } )\r
+       {\r
+               defaultDataFilterRules.elements[ i ] = protectReadOnly;\r
+               defaultHtmlFilterRules.elements[ i ] = unprotectReadyOnly;\r
+       }\r
+\r
+       var protectAttributeRegex = /<((?:a|area|img|input)\b[\s\S]*?\s)((href|src|name)\s*=\s*(?:(?:"[^"]*")|(?:'[^']*')|(?:[^ "'>]+)))([^>]*)>/gi,\r
+               findSavedSrcRegex = /\sdata-cke-saved-src\s*=/;\r
+\r
+       var protectElementsRegex = /(?:<style(?=[ >])[^>]*>[\s\S]*<\/style>)|(?:<(:?link|meta|base)[^>]*>)/gi,\r
+               encodedElementsRegex = /<cke:encoded>([^<]*)<\/cke:encoded>/gi;\r
+\r
+       var protectElementNamesRegex = /(<\/?)((?:object|embed|param|html|body|head|title)[^>]*>)/gi,\r
+               unprotectElementNamesRegex = /(<\/?)cke:((?:html|body|head|title)[^>]*>)/gi;\r
+\r
+       var protectSelfClosingRegex = /<cke:(param|embed)([^>]*?)\/?>(?!\s*<\/cke:\1)/gi;\r
 \r
        function protectAttributes( html )\r
        {\r
-               return html.replace( protectAttributeRegex, '$& _cke_saved_$1' );\r
+               return html.replace( protectAttributeRegex, function( tag, beginning, fullAttr, attrName, end )\r
+                       {\r
+                               // We should not rewrite the _cke_saved_src attribute (#5218)\r
+                               if ( attrName == 'src' && findSavedSrcRegex.test( tag ) )\r
+                                       return tag;\r
+                               else\r
+                                       return '<' + beginning + fullAttr + ' data-cke-saved-' + fullAttr + end + '>';\r
+                       });\r
        }\r
 \r
-       var protectStyleTagsRegex = /<(style)(?=[ >])[^>]*>[^<]*<\/\1>/gi;\r
-       var encodedTagsRegex = /<cke:encoded>([^<]*)<\/cke:encoded>/gi;\r
-       var protectElementNamesRegex = /(<\/?)((?:object|embed|param).*?>)/gi;\r
-       var protectSelfClosingRegex = /<cke:param(.*?)\/>/gi;\r
-\r
-       function protectStyleTagsMatch( match )\r
+       function protectElements( html )\r
        {\r
-               return '<cke:encoded>' + encodeURIComponent( match ) + '</cke:encoded>';\r
+               return html.replace( protectElementsRegex, function( match )\r
+                       {\r
+                               return '<cke:encoded>' + encodeURIComponent( match ) + '</cke:encoded>';\r
+                       });\r
        }\r
 \r
-       function protectStyleTags( html )\r
+       function unprotectElements( html )\r
        {\r
-               return html.replace( protectStyleTagsRegex, protectStyleTagsMatch );\r
+               return html.replace( encodedElementsRegex, function( match, encoded )\r
+                       {\r
+                               return decodeURIComponent( encoded );\r
+                       });\r
        }\r
+\r
        function protectElementsNames( html )\r
        {\r
                return html.replace( protectElementNamesRegex, '$1cke:$2');\r
        }\r
+\r
+       function unprotectElementNames( html )\r
+       {\r
+               return html.replace( unprotectElementNamesRegex, '$1$2' );\r
+       }\r
+\r
        function protectSelfClosingElements( html )\r
        {\r
-               return html.replace( protectSelfClosingRegex, '<cke:param$1></cke:param>' );\r
+               return html.replace( protectSelfClosingRegex, '<cke:$1$2></cke:$1>' );\r
        }\r
 \r
-       function unprotectEncodedTagsMatch( match, encoded )\r
+       function protectPreFormatted( html )\r
        {\r
-               return decodeURIComponent( encoded );\r
+               return html.replace( /(<pre\b[^>]*>)(\r\n|\n)/g, '$1$2$2' );\r
        }\r
 \r
-       function unprotectEncodedTags( html )\r
+       function protectRealComments( html )\r
        {\r
-               return html.replace( encodedTagsRegex, unprotectEncodedTagsMatch );\r
+               return html.replace( /<!--(?!{cke_protected})[\s\S]+?-->/g, function( match )\r
+                       {\r
+                               return '<!--' + protectedSourceMarker +\r
+                                               '{C}' +\r
+                                               encodeURIComponent( match ).replace( /--/g, '%2D%2D' ) +\r
+                                               '-->';\r
+                       });\r
+       }\r
+\r
+       function unprotectRealComments( html )\r
+       {\r
+               return html.replace( /<!--\{cke_protected\}\{C\}([\s\S]+?)-->/g, function( match, data )\r
+                       {\r
+                               return decodeURIComponent( data );\r
+                       });\r
        }\r
 \r
        function protectSource( data, protectRegexes )\r
        {\r
                var protectedHtml = [],\r
-                       tempRegex = /<\!--\{cke_temp\}(\d*?)-->/g;\r
+                       tempRegex = /<\!--\{cke_temp(comment)?\}(\d*?)-->/g;\r
+\r
                var regexes =\r
                        [\r
-                               // First of any other protection, we must protect all comments\r
-                               // to avoid loosing them (of course, IE related).\r
-                               (/<!--[\s\S]*?-->/g),\r
-\r
                                // Script tags will also be forced to be protected, otherwise\r
                                // IE will execute them.\r
-                               /<script[\s\S]*?<\/script>/gi,\r
+                               ( /<script[\s\S]*?<\/script>/gi ),\r
 \r
                                // <noscript> tags (get lost in IE and messed up in FF).\r
                                /<noscript[\s\S]*?<\/noscript>/gi\r
                        ]\r
                        .concat( protectRegexes );\r
 \r
+               // First of any other protection, we must protect all comments\r
+               // to avoid loosing them (of course, IE related).\r
+               // Note that we use a different tag for comments, as we need to\r
+               // transform them when applying filters.\r
+               data = data.replace( (/<!--[\s\S]*?-->/g), function( match )\r
+                       {\r
+                               return  '<!--{cke_tempcomment}' + ( protectedHtml.push( match ) - 1 ) + '-->';\r
+                       });\r
+\r
                for ( var i = 0 ; i < regexes.length ; i++ )\r
                {\r
                        data = data.replace( regexes[i], function( match )\r
                                {\r
                                        match = match.replace( tempRegex,               // There could be protected source inside another one. (#3869).\r
-                                               function( $, id )\r
+                                               function( $, isComment, id )\r
                                                {\r
                                                        return protectedHtml[ id ];\r
                                                }\r
@@ -264,9 +389,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                        return  '<!--{cke_temp}' + ( protectedHtml.push( match ) - 1 ) + '-->';\r
                                });\r
                }\r
-               data = data.replace( tempRegex, function( $, id )\r
+               data = data.replace( tempRegex, function( $, isComment, id )\r
                        {\r
                                return '<!--' + protectedSourceMarker +\r
+                                               ( isComment ? '{C}' : '' ) +\r
                                                encodeURIComponent( protectedHtml[ id ] ).replace( /--/g, '%2D%2D' ) +\r
                                                '-->';\r
                        }\r
@@ -287,7 +413,17 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        dataProcessor.dataFilter.addRules( defaultDataFilterRules );\r
                        dataProcessor.dataFilter.addRules( defaultDataBlockFilterRules );\r
                        dataProcessor.htmlFilter.addRules( defaultHtmlFilterRules );\r
+\r
+                       var defaultHtmlBlockFilterRules = { elements : {} };\r
+                       for ( i in blockLikeTags )\r
+                               defaultHtmlBlockFilterRules.elements[ i ] = getBlockExtension( true, editor.config.fillEmptyBlocks );\r
+\r
                        dataProcessor.htmlFilter.addRules( defaultHtmlBlockFilterRules );\r
+               },\r
+\r
+               onLoad : function()\r
+               {\r
+                       ! ( 'fillEmptyBlocks' in CKEDITOR.config ) && ( CKEDITOR.config.fillEmptyBlocks = 1 );\r
                }\r
        });\r
 \r
@@ -314,27 +450,37 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        // the code.\r
                        data = protectAttributes( data );\r
 \r
-                       // IE remvoes style tags from innerHTML. (#3710).\r
-                       if ( CKEDITOR.env.ie )\r
-                               data = protectStyleTags( data );\r
+                       // Protect elements than can't be set inside a DIV. E.g. IE removes\r
+                       // style tags from innerHTML. (#3710)\r
+                       data = protectElements( data );\r
 \r
                        // Certain elements has problem to go through DOM operation, protect\r
-                       // them by prefixing 'cke' namespace.(#3591)\r
+                       // them by prefixing 'cke' namespace. (#3591)\r
                        data = protectElementsNames( data );\r
 \r
                        // All none-IE browsers ignore self-closed custom elements,\r
-                       // protecting them into open-close.(#3591)\r
+                       // protecting them into open-close. (#3591)\r
                        data = protectSelfClosingElements( data );\r
 \r
+                       // Compensate one leading line break after <pre> open as browsers\r
+                       // eat it up. (#5789)\r
+                       data = protectPreFormatted( data );\r
+\r
                        // Call the browser to help us fixing a possibly invalid HTML\r
                        // structure.\r
-                       var div = document.createElement( 'div' );\r
+                       var div = new CKEDITOR.dom.element( 'div' );\r
                        // Add fake character to workaround IE comments bug. (#3801)\r
-                       div.innerHTML = 'a' + data;\r
-                       data = div.innerHTML.substr( 1 );\r
+                       div.setHtml( 'a' + data );\r
+                       data = div.getHtml().substr( 1 );\r
+\r
+                       // Unprotect "some" of the protected elements at this point.\r
+                       data = unprotectElementNames( data );\r
+\r
+                       data = unprotectElements( data );\r
 \r
-                       if ( CKEDITOR.env.ie )\r
-                               data = unprotectEncodedTags( data );\r
+                       // Restore the comments that have been protected, in this way they\r
+                       // can be properly filtered.\r
+                       data = unprotectRealComments( data );\r
 \r
                        // Now use our parser to make further fixes to the structure, as\r
                        // well as apply the filter.\r
@@ -342,8 +488,12 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                writer = new CKEDITOR.htmlParser.basicWriter();\r
 \r
                        fragment.writeHtml( writer, this.dataFilter );\r
+                       data = writer.getHtml( true );\r
 \r
-                       return writer.getHtml( true );\r
+                       // Protect the real comments again.\r
+                       data = protectRealComments( data );\r
+\r
+                       return data;\r
                },\r
 \r
                toDataFormat : function( html, fixForBody )\r
@@ -362,12 +512,32 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
 /**\r
  * Whether to force using "&" instead of "&amp;amp;" in elements attributes\r
- * values. It's not recommended to change this setting for compliance with the\r
- * W3C XHTML 1.0 standards\r
- * (<a href="http://www.w3.org/TR/xhtml1/#C_12">C.12, XHTML 1.0</a>).\r
+ * values, it's not recommended to change this setting for compliance with the\r
+ * W3C XHTML 1.0 standards (<a href="http://www.w3.org/TR/xhtml1/#C_12">C.12, XHTML 1.0</a>).\r
+ * @name CKEDITOR.config.forceSimpleAmpersand\r
+ * @name CKEDITOR.config.forceSimpleAmpersand\r
  * @type Boolean\r
  * @default false\r
  * @example\r
  * config.forceSimpleAmpersand = false;\r
  */\r
-CKEDITOR.config.forceSimpleAmpersand = false;\r
+\r
+/**\r
+ * Whether a filler text (non-breaking space entity - &nbsp;) will be inserted into empty block elements in HTML output,\r
+ * this is used to render block elements properly with line-height; When a function is instead specified,\r
+ * it'll be passed a {@link CKEDITOR.htmlParser.element} to decide whether adding the filler text\r
+ * by expecting a boolean return value.\r
+ * @name CKEDITOR.config.fillEmptyBlocks\r
+ * @since 3.5\r
+ * @type Boolean\r
+ * @default true\r
+ * @example\r
+ * config.fillEmptyBlocks = false;     // Prevent filler nodes in all empty blocks.\r
+ *\r
+ * // Prevent filler node only in float cleaners.\r
+ * config.fillEmptyBlocks = function( element )\r
+ * {\r
+ *     if ( element.attributes[ 'class' ].indexOf ( 'clear-both' ) != -1 )\r
+ *             return false;\r
+ * }\r
+ */\r