Changeset 3992

Timestamp:

05/30/09 15:46:14 (3 years ago)

Author:

MichaelTempest

Message:

Item1674: Add support for protecting custom XML-like markup.

(Thanks to Crawford for suggesting the API)

Location:

trunk/WysiwygPlugin/lib/Foswiki/Plugins

Files:

• WysiwygPlugin.pm (modified) (4 diffs)
• WysiwygPlugin/TML2HTML.pm (modified) (4 diffs)

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

@@ -35 +35 @@
 
 use vars qw( $html2tml $tml2html $recursionBlock $imgMap );
-use vars qw( %TWikiCompatibility @refs );
+use vars qw( %TWikiCompatibility @refs %xmltag %xmltagPlugin);
 
 our $SHORTDESCRIPTION  = 'Translator framework for Wysiwyg editors';
@@ -434 +434 @@
 
         if ( $web && $web ne $opts->{web} ) {
-            print STDERR "$orig -> $web+$topic$anchor\n";    #debug
+
+            #print STDERR "$orig -> $web+$topic$anchor\n";    #debug
             return $web . '.' . $topic . $anchor;
         }
@@ -548 +549 @@
 }
 
+=pod
+
+---++ ObjectMethod addXMLTag($tag, \&fn)
+
+Instruct WysiwygPlugin to "lift out" the named tag 
+and pass it to &fn for processing.
+&fn may modify the text of the tag.
+&fn should return 0 is the tag is to be re-embedded immediately,
+or 1 if it is to be re-embedded after all processing is complete.
+The text passed (by reference) to &fn includes the 
+=<tag> ... </tag>= brackets.
+
+A plugin may call this function more than once 
+e.g. to change the processing function for a tag.
+However, only the *original plugin* may change the processing
+for a tag.
+
+=cut
+
+sub addXMLTag {
+    my ( $tag, $fn ) = @_;
+
+    my $plugin = caller;
+    $plugin =~ s/^Foswiki::Plugins:://;
+
+    return if not defined $tag;
+
+    if (   ( not exists $xmltag{$tag} and not exists $xmltagPlugin{$tag} )
+        or ( $xmltagPlugin{$tag} eq $plugin ) )
+    {
+
+        # This is either a plugin adding a new tag
+        # or a plugin adding a tag it had previously added before.
+        # A plugin is allowed to add a tag that it had added before
+        # and the new function replaces the old.
+        #
+        $fn = sub { 1 }
+          unless $fn;    # Default function
+
+        $xmltag{$tag}       = $fn;
+        $xmltagPlugin{$tag} = $plugin;
+    }
+    else {
+
+        # DON'T replace the existing processing for this tag
+        printf STDERR "WysiwygPlugin::addXMLTag: "
+          . "$plugin cannot add XML tag $tag, "
+          . "that tag was already registered by $xmltagPlugin{$tag}\n";
+    }
+}
+
 sub TranslateTML2HTML {
     my ( $text, $web, $topic ) = @_;
@@ -563 +615 @@
             getViewUrl      => \&getViewUrl,
             expandVarsInURL => \&expandVarsInURL,
+            xmltag          => \%xmltag,
         }
     );

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

@@ -246 +246 @@
     $text = $this->_takeOutSets($text);
 
+    $text = $this->_takeOutCustomTags($text);
+
     $text =~ s/\\\n/ /g;
     $text =~ s/\t/   /g;
@@ -595 +597 @@
 }
 
+sub _takeOutCustomTags {
+    my ( $this, $text ) = @_;
+
+    # Take out custom XML tags
+    sub _takeOutCustomXmlProcess {
+        my ( $this, $state, $scoop ) = @_;
+        return $this->_liftOut( $scoop, 'PROTECTED' );
+    }
+    my $xmltags = $this->{opts}->{xmltag};
+    for my $tag ( sort keys %$xmltags ) {
+        $text = _takeOutXml( $this, $text, $tag, \&_takeOutCustomXmlProcess );
+    }
+
+    # Take out other custom tags here
+
+    return $text;
+}
+
 sub _takeOutBlocks {
-    my ( $this, $intext, $tag ) = @_;
-    die unless $tag;
+    # my ( $this, $intext, $tag ) = @_;
+
+    sub _takeOutBlocksProcess {
+        my ( $this, $state, $scoop ) = @_;
+        my $placeholder = $state->{tag} . $state->{n};
+        $this->{removed}->{$placeholder} = {
+            params => _parseParams( $state->{tagParams} ),
+            text   => $scoop,
+        };
+        return $TT0 . $placeholder . $TT0;
+    }
+
+    return _takeOutXml( @_, \&_takeOutBlocksProcess );
+}
+
+sub _takeOutXml {
+    my ( $this, $intext, $tag, $fn ) = @_;
+    die       unless $tag;
+    die       unless $fn;
     return '' unless $intext;
     return $intext unless ( $intext =~ m/<$tag\b/ );
 
-    my $open  = qr/<$tag\b[^>]*>/i;
-    my $close = qr/<\/$tag>/i;
-    my $out   = '';
-    my $depth = 0;
+    my $openNoCapture    = qr/<$tag\b[^>]*>/i;
+    my $openCaptureAttrs = qr/<$tag\b([^>]*)>/i;
+    my $close            = qr/<\/$tag>/i;
+    my $out              = '';
+    my $depth            = 0;
     my $scoop;
-    my $tagParams;
-    my $n = 0;
-
-    foreach my $chunk ( split /($open|$close)/, $intext ) {
+
+    # &$fn may rely on the existence of these fields, 
+        # and may add more fields, if needed
+    my %state = ( tag => $tag, n => 0, tagParams => undef );
+
+    foreach my $chunk ( split /($openNoCapture|$close)/, $intext ) {
         next unless defined($chunk);
-        if ( $chunk =~ m/<$tag\b([^>]*)>/ ) {
+        if ( $chunk =~ m/$openCaptureAttrs/ ) {
             unless ( $depth++ ) {
-                $tagParams = $1;
-                $scoop     = '';
+                $state{tagParams} = $1;
+                $scoop = '';
                 next;
             }
@@ -620 +660 @@
         elsif ( $depth && $chunk =~ m/$close/ ) {
             unless ( --$depth ) {
-                my $placeholder = $tag . $n;
-                $this->{removed}->{$placeholder} = {
-                    params => _parseParams($tagParams),
-                    text   => $scoop,
-                };
-                $chunk = $TT0 . $placeholder . $TT0;
-                $n++;
+                $chunk = $fn->( $this, \%state, $scoop );
+                $state{n}++;
             }
         }
@@ -643 +678 @@
         #     $scoop .= "</$tag>\n";
         # }
-        my $placeholder = $tag . $n;
-        $this->{removed}->{$placeholder} = {
-            params => _parseParams($tagParams),
-            text   => $scoop,
-        };
-        $out .= $TT0 . $placeholder . $TT0;
+        $out .= $fn->( $this, \%state, $scoop );
     }
 
     # Filter spurious tags without matching open/close
-    $out =~ s/$open/&lt;$tag$1&gt;/g;
+    $out =~ s/$openCaptureAttrs/&lt;$tag$1&gt;/g;
     $out =~ s/$close/&lt;\/$tag&gt;/g;
     $out =~ s/<($tag\s+\/)>/&lt;$1&gt;/g;