Changeset 3396

Timestamp:

04/10/09 10:37:08 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1394: fixed colour handling

Location:

trunk/WysiwygPlugin

Files:

• data/System/WysiwygPlugin.txt (modified) (1 diff)
• lib/Foswiki/Plugins/WysiwygPlugin/Constants.pm (modified) (5 diffs)
• lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML/Node.pm (modified) (3 diffs)
• lib/Foswiki/Plugins/WysiwygPlugin/TML2HTML.pm (modified) (2 diffs)
• test/unit/WysiwygPlugin/TranslatorTests.pm (modified) (1 diff)
• test/unit/WysiwygPlugin/WysiwygPluginTests.pm (modified) (2 diffs)

trunk/WysiwygPlugin/data/System/WysiwygPlugin.txt

@@ -166 +166 @@
 |  Plugin Version: | %$VERSION% |
 |  Change History: | |
+|  10 Apr 2009 | Foswikitask:Item1394: fixed colour handling |
 |  03 Dec 2008 | Foswikitask:Item6041: fixed empty bullet list problem. Foswiki version |
 |  22 Oct 2008 | Fixed TWikibug:Item5961 (emphasis), TWikibug:Item6089 (backslash in verbatim) |

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/Constants.pm

@@ -4 +4 @@
 
 use strict;
-
-our ( %ALWAYS_BLOCK, $ALWAYS_BLOCK_S, $STARTWW, $ENDWW, $PROTOCOL );
 
 # HTML elements that are strictly block type, as defined by
@@ -11 +9 @@
 # Block type elements do not require
 # <br /> to be generated for newlines on the boundary - see WC::isInline.
-%ALWAYS_BLOCK = map { $_ => 1 }
+our %ALWAYS_BLOCK = map { $_ => 1 }
   qw( ADDRESS BLOCKQUOTE CENTER DIR DIV DL FIELDSET FORM H1 H2 H3 H4 H5 H6
   HR ISINDEX MENU NOFRAMES NOSCRIPT OL P PRE TABLE UL );
-$ALWAYS_BLOCK_S = join( '|', keys %ALWAYS_BLOCK );
-
-$STARTWW  = qr/^|(?<=[ \t\n\(\!])/om;
-$ENDWW    = qr/$|(?=[ \t\n\,\.\;\:\!\?\)])/om;
-$PROTOCOL = qr/^(file|ftp|gopher|https?|irc|news|nntp|telnet|mailto):/;
-
-our (%KNOWN_COLOUR);
-
-# Colours with colour settings in DefaultPreferences. WTF does Foswiki see
-# fit to *redefine* the standard colors? e.g. ORANGE below is *not* orange.
-# For goodness sakes!
-%KNOWN_COLOUR = (
+our $ALWAYS_BLOCK_S = join( '|', keys %ALWAYS_BLOCK );
+
+our $STARTWW  = qr/^|(?<=[ \t\n\(\!])/om;
+our $ENDWW    = qr/$|(?=[ \t\n\,\.\;\:\!\?\)])/om;
+our $PROTOCOL = qr/^(file|ftp|gopher|https?|irc|news|nntp|telnet|mailto):/;
+
+# Colours with colour settings in DefaultPreferences.
+our @TML_COLOURS = (
+    'BLACK',  'MAROON', 'PURPLE', 'PINK',       'RED',   'ORANGE',
+    'YELLOW', 'LIME',   'AQUA',   'AQUAMARINE', 'GREEN', 'OLIVE',
+    'BROWN',  'NAVY',   'TEAL',   'BLUE',       'GRAY',  'SILVER',
+    'WHITE',
+);
+
+# Map of possible colours back to TML %COLOUR%...%ENDCOLOR%
+our %HTML2TML_COLOURMAP = (
     BLACK      => 'BLACK',
     '#000000'  => 'BLACK',
@@ -32 +34 @@
     PURPLE     => 'PURPLE',
     '#800080'  => 'PURPLE',
-    PINK       => 'PINK',
+    FUCHSIA    => 'PINK',
     '#FF00FF'  => 'PINK',
     RED        => 'RED',
@@ -38 +40 @@
     ORANGE     => 'ORANGE',
     '#FF6600'  => 'ORANGE',
-    '#FFA500'  => 'ORANGE',    # HTML standard
     YELLOW     => 'YELLOW',
     '#FFFF00'  => 'YELLOW',
@@ -52 +53 @@
     BROWN      => 'BROWN',
     '#996633'  => 'BROWN',
-    '#A52A2A'  => 'BROWN',     # HTML standard
     NAVY       => 'NAVY',
     '#000080'  => 'NAVY',

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML/Node.pm

@@ -1281 +1281 @@
 
     # Try to convert font tags into %COLOUR%..%ENDCOLOR%
-    # First extract the colour
+
+    # First extract the colour from a style= param, if we can.
     my $colour;
-    if ( $atts{style} ) {
-        my $style = $atts{style};
-        if ( $style =~ s/(^|\s|;)color\s*:\s*([^\s;]+);?//i ) {
-            $colour = $2;
-            delete $atts{style} if $style =~ /^[\s;]*$/;
-        }
-    }
-    if ( $atts{color} ) {
+    if ( defined $atts{style}
+        && $atts{style} =~ s/(^|\s|;)color\s*:\s*(#?\w+)\s*(;|$)// )
+    {
+        $colour = $2;
+    }
+
+    # override it with a color= param, if there is one.
+    if ( defined $atts{color} ) {
         $colour = $atts{color};
-        delete $atts{color};
-    }
-
-    # The presence of the class forces it to be converted to a
-    # Foswiki variable
-    if ( !_removeClass( \%atts, 'WYSIWYG_COLOUR' ) ) {
-        delete $atts{class};
-        if (   scalar( keys %atts ) > 0
-            || !$colour
-            || $colour !~ /^([a-z]+|#[0-9A-Fa-f]{6})$/i )
-        {
-            return ( 0, undef );
-        }
-    }
-
-    # OK, just the colour
-    $colour = $WC::KNOWN_COLOUR{ uc($colour) };
-    if ( !$colour ) {
-
-        # Not a recognised colour
-        return ( 0, undef );
-    }
-    my ( $f, $kids ) = $this->_flatten($options);
-    return ( $f, '%' . uc($colour) . '%' . $kids . '%ENDCOLOR%' );
+    }
+
+    # The presence of the WYSIWYG_COLOR class _forces_ the tag to be
+    # converted to a Foswiki colour macro, as long as the colour is
+    # recognised.
+    if ( hasClass( \%atts, 'WYSIWYG_COLOR' ) ) {
+        my $percentColour = $WC::HTML2TML_COLOURMAP{ uc($colour) };
+        if ( defined $percentColour ) {
+
+            # All other font information will be lost.
+            my ( $f, $kids ) = $this->_flatten($options);
+            return ( $f, '%' . $percentColour . '%' . $kids . '%ENDCOLOR%' );
+        }
+    }
+
+    # May still be able to convert if there is no other font information.
+    delete $atts{class} if defined $atts{class} && $atts{class} =~ /^\s*$/;
+    delete $atts{style} if defined $atts{style} && $atts{style} =~ /^[\s;]*$/;
+    delete $atts{color} if defined $atts{color};
+    if ( defined $colour && !scalar keys %atts ) {
+        my $percentColour = $WC::HTML2TML_COLOURMAP{ uc($colour) };
+        if ( defined $percentColour ) {
+            my ( $f, $kids ) = $this->_flatten($options);
+            return ( $f, '%' . $percentColour . '%' . $kids . '%ENDCOLOR%' );
+        }
+    }
+
+    # Either the colour can't be mapped, or we can't do the conversion
+    # without loss of information
+    return ( 0, undef );
 }
 
@@ -1456 +1463 @@
     }
 
-    # Remove all other classes
-    delete $atts{class};
+    # If we have WYSIWYG_COLOR and the colour can be mapped, then convert
+    # to a macro.
+    if ( _removeClass( \%atts, 'WYSIWYG_COLOR' ) ) {
+        my $colour;
+        if ( $atts{style} ) {
+            my $style = $atts{style};
+            if ( $style =~ s/(^|\s|;)color\s*:\s*(#?\w+)\s*(;|$)// ) {
+                $colour = $2;
+            }
+        }
+        my $percentColour = $WC::HTML2TML_COLOURMAP{ uc($colour) };
+        if ( defined $percentColour ) {
+            my ( $f, $kids ) = $this->_flatten($options);
+            return ( $f, '%' . $percentColour . '%' . $kids . '%ENDCOLOR%' );
+        }
+    }
+
+    # Remove all other (non foswiki) classes
+    if ( defined $atts{class} && $atts{class} !~ /foswiki/ ) {
+        delete $atts{class};
+    }
 
     if ( $options & $WC::VERY_CLEAN ) {
 
-        # remove style attribute if cleaning aggressively. Have to do this
-        # because Foswiki generates these.
-        delete $atts{style} if defined $atts{style};
+        # remove style attribute if cleaning aggressively.
+        #        delete $atts{style} if defined $atts{style};
     }
 
@@ -1495 +1520 @@
     return ( 0, undef )
       unless $this->_isConvertableTable( $options | $WC::NO_BLOCK_TML,
-              \@table );
+        \@table );
 
     my $maxrow = 0;

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/TML2HTML.pm

@@ -260 +260 @@
 
     # Handle colour tags specially (hack, hack, hackity-HACK!)
-    my $colourMatch = join( '|', grep( /^[A-Z]/, keys %WC::KNOWN_COLOUR ) );
-    while ( $text =~
-        s#%($colourMatch)%(.*?)%ENDCOLOR%#<font color="\L$1\E">$2</font>#og )
-    {
-    }
+    my $colourMatch = join( '|', grep( /^[A-Z]/, @WC::TML_COLOURS ) );
+    $text =~ s#%($colourMatch)%(.*?)%ENDCOLOR%#
+      _getNamedColour($1, $2)#oge;
 
     # Convert Foswiki tags to spans outside protected text
@@ -508 +506 @@
 }
 
+sub _getNamedColour {
+    my ( $name, $t ) = @_;
+    my $epr = Foswiki::Func::getPreferencesValue($name);
+
+    # Match <font color="x" and style="color:x"
+    if (
+        defined $epr
+        && (   $epr =~ /color=["'](#?\w+)['"]/
+            || $epr =~ /color\s*:\s*(#?\w+)/ )
+      )
+    {
+        return "<span class='WYSIWYG_COLOR' style='color:$1'>$t</span>";
+    }
+
+    # Can't map to a 'real' colour; leave the variables
+    return '%' . $name . '%' . $t . '%ENDCOLOR%';
+}
+
 sub _addClass {
     if ( $_[0] ) {

trunk/WysiwygPlugin/test/unit/WysiwygPlugin/TranslatorTests.pm

@@ -1557 +1557 @@
         exec => $HTML2TML,
         html => <<HERE,
-<font color="red" class="WYSIWYG_COLOUR">red</font>
+<font color="red" class="WYSIWYG_COLOR">red</font>
 <font style="color:green">green</font>
 <font style="border:1;color:blue">blue</font>
-<font class="WYSIWYG_COLOUR" style="border:1;color:yellow">yellow</font>
+<font class="WYSIWYG_COLOR" style="border:1;color:yellow">yellow</font>
 <font color="brown">brown</font>
 HERE

trunk/WysiwygPlugin/test/unit/WysiwygPlugin/WysiwygPluginTests.pm

@@ -162 +162 @@
     # Strip ASCII header
     $this->assert_matches( qr/Content-Type: *text\/plain; *charset=UTF-8/i,
-                           $out,
-                           anal($out) );
+        $out, anal($out) );
     $out =~ s/^.*?\r\n\r\n//s;
 
@@ -217 +216 @@
     # Strip ASCII header
     $this->assert_matches( qr/Content-Type: *text\/plain; *charset=UTF-8/,
-                           $out,
-        anal($out) );
+        $out, anal($out) );
     $out =~ s/^.*?\r\n\r\n//s;