Changeset 8111

Timestamp:

07/10/10 14:53:09 (23 months ago)

Author:

MichaelTempest

Message:

Item2074: Some TML is simply not editable in the WYSIWYG editor at present, such as <sticky> inside a <literal> block. There is also the WYSIWYG_EXCLUDE preference that disables the WYSIWYG editor when the topic contains certain TML.

However, nothing stops the user from opening a topic in the WYSIWYG editor, clicking WikiText, entering some TML that would have prevented the use of the WYSIWYG editor in the first place, and then clicking WYSIWYG. This can corrupt the topic.

To guard against that, the TML2HTML rest handler now detects TML that is not WYSIWYG-editable and protects all of the TML. To explain why, it adds a warning at the top of the HTML. This warning is automatically removed when converting back to TML.

Location:

trunk/WysiwygPlugin

Files:

• lib/Foswiki/Plugins/WysiwygPlugin.pm (modified) (3 diffs)
• lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML/Node.pm (modified) (1 diff)
• lib/Foswiki/Plugins/WysiwygPlugin/TML2HTML.pm (modified) (1 diff)
• test/unit/WysiwygPlugin/TranslatorTests.pm (modified) (3 diffs)

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

@@ -101 +101 @@
 
     #my ($text, $exclusions) = @_;
+    my $disabled = wysiwygEditingDisabledForThisContent($_[0], $_[1]);
+    return $disabled if $disabled;
+
+    # Check that the topic text can be converted to HTML. This is an
+    # *expensive* process, to be avoided if possible (hence all the
+    # earlier checks)
+    my $impossible = wysiwygEditingNotPossibleForThisContent( $_[0] );
+    return $impossible if $impossible;
+
+    return 0;
+}
+
+sub wysiwygEditingDisabledForThisContent {
+    #my ($text, $exclusions) = @_;
 
     my $exclusions = $_[1];
@@ -161 +175 @@
                 print STDERR "WYSIWYG_DEBUG: <sticky> inside <$tag>\n"
                   if (WHY);
-                return "<sticky> inside <$tag>";
+                return "&lt;sticky&gt; inside &lt;$tag&gt;";
             }
         }
@@ -182 +196 @@
                 print STDERR "WYSIWYG_DEBUG: <verbatim> inside <$tag>\n"
                   if (WHY);
-                return "<verbatim> inside <$tag>";
+                return "&lt;verbatim&gt; inside &lt;$tag&gt;";
             }
         }
     }
 
-    # Look for combinations of literal and other markup that cause
-    # problems together
-    for my $tag ( keys %xmltag ) {
-        while ( $text =~ /<$tag\b[^>]*>(.*?)<\/$tag>/gsi ) {
-            my $inner = $1;
-            if ( $inner =~ /<literal\b[^>]*>/i ) {
-                print STDERR "WYSIWYG_DEBUG: <literal> inside <$tag>\n"
-                  if (WHY);
-                return "<literal> inside <$tag>";
-            }
-        }
-    }
-
-    # Check that the topic text can be converted to HTML. This is an
-    # *expensive* process, to be avoided if possible (hence all the
-    # earlier checks)
+    return 0;
+}
+
+sub wysiwygEditingNotPossibleForThisContent {
     eval {
         require Foswiki::Plugins::WysiwygPlugin::Handlers;

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

@@ -1557 +1557 @@
     my ( $this, $options ) = @_;
 
+    if ( $this->hasClass('WYSIWYG_WARNING') ) {
+        return ( 0, '' );
+    }
+
     if ( $this->hasClass('TMLverbatim') ) {
         return $this->_verbatim( 'verbatim', $options );

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

@@ -100 +100 @@
     return '' unless $content;
 
-    $content =~ s/[$TT0$TT1$TT2]/?/go;
-
-    # Render TML constructs to tagged HTML
-    $content = $this->_getRenderedVersion($content);
-
-    # Substitute back in protected elements
-    $content = $this->_dropBack($content);
-
-    if ( $content =~ /[$TT0$TT1$TT2]/o ) {
-
-        # There should never be any of these in the text at this point.
-        # If there are, then the conversion failed.
-        die("Invalid characters in HTML after conversion")
-          if $options->{dieOnError};
-
-        # Encode the original TML as verbatim-style HTML,
-        # so that the user has uncorrupted TML, at least.
-        my $originalContent = $_[1];
-        $originalContent =~ s/[$TT0$TT1$TT2]/?/go;
-        $originalContent = _protectVerbatimChars($originalContent);
-        $content =
-          CGI::div( { class => 'WYSIWYG_PROTECTED' }, $originalContent );
+    my $disabled =
+      Foswiki::Plugins::WysiwygPlugin::wysiwygEditingDisabledForThisContent(
+        $content);
+    if ($disabled) {
+
+      # encode the content verbatim-style, so that the user has uncorrupted HTML
+        $content =~ s/[$TT0$TT1$TT2]/?/go;
+        $content = CGI::div(
+            { class => 'WYSIWYG_WARNING foswikiBroadcastMessage' },
+            Foswiki::Func::renderText(
+                Foswiki::Func::expandCommonVariables( <<"WARNING" ) ) )
+*%MAKETEXT{"Conversion to HTML for WYSIWYG editing is disabled because of the topic content."}%*
+
+%MAKETEXT{"This is why the conversion is disabled:"}% $disabled
+
+%MAKETEXT{"(This message will be removed automatically)"}%
+WARNING
+          . CGI::div( { class => 'WYSIWYG_PROTECTED' },
+            _protectVerbatimChars($content) );
+    }
+    else {
+
+        # Convert TML to HTML for wysiwyg editing
+
+        $content =~ s/[$TT0$TT1$TT2]/?/go;
+
+        # Render TML constructs to tagged HTML
+        $content = $this->_getRenderedVersion($content);
+
+        # Substitute back in protected elements
+        $content = $this->_dropBack($content);
+
+        if ( $content =~ /[$TT0$TT1$TT2]/o ) {
+
+            # There should never be any of these in the text at this point.
+            # If there are, then the conversion failed.
+            die("Invalid characters in HTML after conversion")
+              if $options->{dieOnError};
+
+            # Encode the original TML as verbatim-style HTML,
+            # so that the user has uncorrupted TML, at least.
+            my $originalContent = $_[1];
+            $originalContent =~ s/[$TT0$TT1$TT2]/?/go;
+            $originalContent = _protectVerbatimChars($originalContent);
+            $content =
+              CGI::div( { class => 'WYSIWYG_PROTECTED' }, $originalContent );
+        }
     }
 

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

@@ -2017 +2017 @@
     },
     {
-        exec => $ROUNDTRIP | $CANNOTWYSIWYG,
+        exec => $ROUNDTRIP,
         name => 'verbatimInsideLiteralItem1980',
         tml  => <<'GLUED',
@@ -2048 +2048 @@
     },
     {
-        exec => $ROUNDTRIP | $CANNOTWYSIWYG,
+        exec => $ROUNDTRIP,
         name => 'stickyInsideLiteral',
         tml  => <<'GLUED',
@@ -2619 +2619 @@
     else {
         $this->assert_tml_equals( $finaltml, $tx, $args->{name} );
-        $this->assert( !$notEditable,
+        if ($html =~ /WYSIWYG_WARNING/) {
+            # The HTML contains a warning message saying that this TML 
+            # cannot be edited as HTML, and all of the TML is protected
+            # as if the whole topic were in a <sticky> block
+        }
+        else {
+            # This TML really is editable in the WYSIWYG editor
+            $this->assert( !$notEditable,
 "$args->{name} TML is wysiwyg-editable, but notWysiwygEditable() reports: $notEditable"
-        );
+            );
+        }
     }