Ticket #5769: 5769_3.patch

_source/plugins/entities/plugin.js

@@ -5 +5 @@
 
 (function()
 {
-        var entities =
-
-                // Base HTML entities.
-                'nbsp,gt,lt,quot,' +
+        // Base HTML entities.
+        var htmlbase = 'nbsp,gt,lt,quot';
 
+        var entities =
                 // Latin-1 Entities
                 'iexcl,cent,pound,curren,yen,brvbar,sect,uml,copy,ordf,laquo,' +
                 'not,shy,reg,macr,deg,plusmn,sup2,sup3,acute,micro,para,middot,' +
@@ -46 +45 @@
                 'omicron,pi,rho,sigmaf,sigma,tau,upsilon,phi,chi,psi,omega,thetasym,' +
                 'upsih,piv';
 
-        function buildTable( entities )
+        /**
+         * Create a mapping table between one character and it's entity form from a list of entity names.
+         * @param reverse {Boolean} Whether create a reverse map from the entity string form to actual character.
+         */
+        function buildTable( entities, reverse )
         {
                 var table = {},
                         regex = [];
@@ -63 +66 @@
 
                 entities = entities.replace( /\b(nbsp|shy|gt|lt|amp)(?:,|$)/g, function( match, entity )
                         {
-                                table[ specialTable[ entity ] ] = '&' + entity + ';';
-                                regex.push( specialTable[ entity ] );
+                                var org = reverse ? '&' + entity + ';' : specialTable[ entity ],
+                                        result = reverse ? specialTable[ entity ] : '&' + entity + ';';
+
+                                table[ org ] = result;
+                                regex.push( org );
                                 return '';
                         });
 
-                // Transforms the entities string into an array.
-                entities = entities.split( ',' );
+                if ( !reverse )
+                {
+                        // Transforms the entities string into an array.
+                        entities = entities.split( ',' );
 
-                // Put all entities inside a DOM element, transforming them to their
-                // final chars.
-                var div = document.createElement( 'div' ),
-                        chars;
-                div.innerHTML = '&' + entities.join( ';&' ) + ';';
-                chars = div.innerHTML;
-                div = null;
+                        // Put all entities inside a DOM element, transforming them to their
+                        // final chars.
+                        var div = document.createElement( 'div' ),
+                                chars;
+                        div.innerHTML = '&' + entities.join( ';&' ) + ';';
+                        chars = div.innerHTML;
+                        div = null;
 
-                // Add all chars to the table.
-                for ( var i = 0 ; i < chars.length ; i++ )
-                {
-                        var charAt = chars.charAt( i );
-                        table[ charAt ] = '&' + entities[ i ] + ';';
-                        regex.push( charAt );
-                }
+                        // Add all chars to the table.
+                        for ( var i = 0 ; i < chars.length ; i++ )
+                        {
+                                var charAt = chars.charAt( i );
+                                table[ charAt ] = '&' + entities[ i ] + ';';
+                                regex.push( charAt );
+                        }
+                }
 
-                table.regex = regex.join( '' );
+                table.regex = regex.join( reverse ? '|' : '' );
 
                 return table;
         }
@@ -98 +107 @@
                 {
                         var config = editor.config;
 
-                        if ( !config.entities )
-                                return;
-
                         var dataProcessor = editor.dataProcessor,
                                 htmlFilter = dataProcessor && dataProcessor.htmlFilter;
 
                         if ( htmlFilter )
                         {
-                                var selectedEntities = entities;
+                                // Mandatory HTML base entities.
+                                var selectedEntities = htmlbase;
 
-                                if ( config.entities_latin )
-                                        selectedEntities += ',' + latin;
+                                if ( config.entities )
+                                {
+                                        selectedEntities += ',' + entities;
+                                        if ( config.entities_latin )
+                                                selectedEntities += ',' + latin;
 
-                                if ( config.entities_greek )
-                                        selectedEntities += ',' + greek;
+                                        if ( config.entities_greek )
+                                                selectedEntities += ',' + greek;
 
-                                if ( config.entities_additional )
-                                        selectedEntities += ',' + config.entities_additional;
+                                        if ( config.entities_additional )
+                                                selectedEntities += ',' + config.entities_additional;
+                                }
 
                                 var entitiesTable = buildTable( selectedEntities );
 
@@ -123 +134 @@
                                 var entitiesRegex = '[' + entitiesTable.regex + ']';
                                 delete entitiesTable.regex;
 
-                                if ( config.entities_processNumerical )
+                                if ( config.entities && config.entities_processNumerical )
                                         entitiesRegex = '[^ -~]|' + entitiesRegex ;
 
                                 entitiesRegex = new RegExp( entitiesRegex, 'g' );
 
+                                function getEntity( character )
+                                {
+                                        return config.entities_processNumerical == 'force' || !entitiesTable[ character ] ?
+                                                   '&#' + character.charCodeAt(0) + ';'
+                                                        : entitiesTable[ character ];
+                                }
+
+                                // Decode entities that the browsers has transformed
+                                // at first place.
+                                var baseEntitiesTable = buildTable( [ htmlbase, 'shy' ].join( ',' ) , true ),
+                                        baseEntitiesRegex = new RegExp( baseEntitiesTable.regex, 'g' );
+
                                 function getChar( character )
                                 {
-                                        return entitiesTable[ character ] || ( '&#' + character.charCodeAt(0) + ';' );
+                                        return baseEntitiesTable[ character ];
                                 }
 
                                 htmlFilter.addRules(
                                         {
                                                 text : function( text )
                                                 {
-                                                        return text.replace( entitiesRegex, getChar );
+                                                        return text.replace( baseEntitiesRegex, getChar )
+                                                                        .replace( entitiesRegex, getEntity );
                                                 }
                                         });
                         }
@@ -179 +203 @@
 
 /**
  * Whether to convert all remaining characters, not comprised in the ASCII
- * character table, to their relative numeric representation of HTML entity.
+ * character table, to their relative decimal numeric representation of HTML entity.
+ * When specified as the value 'force', it will simply convert all entities into the above form.
  * For example, the phrase "This is Chinese: &#27721;&#35821;." is outputted
  * as "This is Chinese: &amp;#27721;&amp;#35821;."
  * @type Boolean
+ * @type Boolean|String
  * @default false
  * @example
  * config.entities_processNumerical = true;
+ * config.entities_processNumerical = 'force';          //Convert from "&nbsp;" into "&#160;";
  */
 CKEDITOR.config.entities_processNumerical = false;