remove unnecessary and troublesome filter calls

This better defines what the filter hook is passed, to only be the raw,
complete text of a page. Not some snippet, or data read in from an
unrelated template.

Several plugins that filtered text that originates from an (already
filtered) page were modified not to do that. Note that this was not
done very consistently before; other plugins that receive text from a
page called preprocess on it w/o first calling filter.

The template plugin gets text from elsewhere, and was also changed not to
filter it. That leads to one known regression -- the embed plugin cannot
be used to embed stuff in templates now. But that plugin is deprecated
anyway.

Later we may want to increase the coverage of what is filtered. Perhaps
a good goal would be to allow writing a filter plugin that filters
out unwanted words, from any input. We're not there yet; not only
does the template plugin load unfiltered text from its templates now,
but so can the table plugin, and other plugins that use templates (like
inline!). I think we can cross that bridge when we come to it. If I wanted
such a censoring plugin, I'd probably make it use a sanitize hook instead,
for the better coverage.

For now I am concentrating on the needs of the two non-deprecated users
of filter. This should fix bugs/po_vs_templates, and it probably fixes
an obscure bug around txt's use of filter for robots.txt.

diff --git a/IkiWiki/Plugin/color.pm b/IkiWiki/Plugin/color.pm
index d550dd9f4b42ba7759b44b9571f0bc959e026423..9bb2359ce6f45f9ba452ad400aa48fc2c204584e 100644 (file)
--- a/IkiWiki/Plugin/color.pm
+++ b/IkiWiki/Plugin/color.pm
@@ -61,12 +61,11 @@ sub replace_preserved_style ($) {
 sub preprocess (@) {
        my %params = @_;
 
-       # Preprocess the text to expand any preprocessor directives
-       # embedded inside it.
-       $params{text} = IkiWiki::preprocess($params{page}, $params{destpage},
-                               IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
-
-       return preserve_style($params{foreground}, $params{background}, $params{text});
+       return preserve_style($params{foreground}, $params{background},
+               # Preprocess the text to expand any preprocessor directives
+               # embedded inside it.
+               IkiWiki::preprocess($params{page}, $params{destpage},
+                       $params{text}));
 }
 
 sub format (@) {

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index d34951570da77d1f9a423b874d362bd1b800aec8..64eb7fb093fce0d8dbb1d8437f829f5c4aa31b6d 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -142,8 +142,6 @@ sub preprocess {
        }
        $content =~ s/\\"/"/g;
 
-       $content = IkiWiki::filter($page, $params{destpage}, $content);
-
        if ($config{comments_allowdirectives}) {
                $content = IkiWiki::preprocess($page, $params{destpage},
                        $content);

diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm
index 8a57961491942438864c87a6ff1662b7d60a6439..026078b3ccf6751c26418d329a62f715b1bb5252 100644 (file)
--- a/IkiWiki/Plugin/conditional.pm
+++ b/IkiWiki/Plugin/conditional.pm
@@ -59,8 +59,7 @@ sub preprocess_if (@) {
        else {
                $ret="";
        }
-       return IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $params{destpage}, $ret));
+       return IkiWiki::preprocess($params{page}, $params{destpage}, $ret);
 }
 
 package IkiWiki::PageSpec;

diff --git a/IkiWiki/Plugin/cutpaste.pm b/IkiWiki/Plugin/cutpaste.pm
index 01e9ce043c90f2eb059f7abc6eb8093de717fb18..4a88171685b8d94cfaced062a9547ea8c3e6d401 100644 (file)
--- a/IkiWiki/Plugin/cutpaste.pm
+++ b/IkiWiki/Plugin/cutpaste.pm
@@ -50,8 +50,8 @@ sub preprocess_copy (@) {
        $savedtext{$params{page}} = {} if not exists $savedtext{$params{"page"}};
        $savedtext{$params{page}}->{$params{id}} = $params{text};
 
-       return IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $params{destpage}, $params{text})) if defined wantarray;
+       return IkiWiki::preprocess($params{page}, $params{destpage}, $params{text})
+               if defined wantarray;
 }
 
 sub preprocess_paste (@) {
@@ -70,8 +70,8 @@ sub preprocess_paste (@) {
                error sprintf(gettext('no text was copied in this page with id %s'), $params{id});
        }
 
-       return IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $params{destpage}, $savedtext{$params{page}}->{$params{id}}));
+       return IkiWiki::preprocess($params{page}, $params{destpage},
+               $savedtext{$params{page}}->{$params{id}});
 }
 
 1;

diff --git a/IkiWiki/Plugin/more.pm b/IkiWiki/Plugin/more.pm
index 266c8e1d0937dc9aefc677d536cc26a8d18e66c7..80e339a1be7c876e05820ba2da3e444d97770345 100644 (file)
--- a/IkiWiki/Plugin/more.pm
+++ b/IkiWiki/Plugin/more.pm
@@ -33,9 +33,9 @@ sub preprocess (@) {
                                anchor => "more");
        }
        else {
-               $params{text}=IkiWiki::preprocess($params{page}, $params{destpage},
-                       IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
-               return "<a name=\"more\"></a>\n\n".$params{text};
+               return "<a name=\"more\"></a>\n\n".
+                       IkiWiki::preprocess($params{page}, $params{destpage},
+                               $params{text});
        }
 }
 

diff --git a/IkiWiki/Plugin/sidebar.pm b/IkiWiki/Plugin/sidebar.pm
index 2d495db2cc0d02e1bc1abbc3653627374a8179ba..c1146b7b4394c7203f452ef36606c5a51242ea14 100644 (file)
--- a/IkiWiki/Plugin/sidebar.pm
+++ b/IkiWiki/Plugin/sidebar.pm
@@ -47,8 +47,7 @@ sub preprocess (@) {
                $pagesidebar{$page}=
                        IkiWiki::htmlize($page, $page, $type,
                        IkiWiki::linkify($page, $page,
-                       IkiWiki::preprocess($page, $page,
-                       IkiWiki::filter($page, $page, $params{content}))));
+                       IkiWiki::preprocess($page, $page, $params{content})));
        }
 
        return "";

diff --git a/IkiWiki/Plugin/template.pm b/IkiWiki/Plugin/template.pm
index b8c2f05b29ab4492453a91b16dff76f8d1521228..db26bfe315a254ddc8bdafef07abf83c4a819deb 100644 (file)
--- a/IkiWiki/Plugin/template.pm
+++ b/IkiWiki/Plugin/template.pm
@@ -53,8 +53,7 @@ sub preprocess (@) {
 
        foreach my $param (keys %params) {
                my $value=IkiWiki::preprocess($params{page}, $params{destpage},
-                         IkiWiki::filter($params{page}, $params{destpage},
-                         $params{$param}), $scan);
+                         $params{$param}, $scan);
                if ($template->query(name => $param)) {
                        my $htmlvalue=IkiWiki::htmlize($params{page}, $params{destpage},
                                        pagetype($pagesources{$params{page}}),
@@ -69,8 +68,7 @@ sub preprocess (@) {
        }
 
        return IkiWiki::preprocess($params{page}, $params{destpage},
-              IkiWiki::filter($params{page}, $params{destpage},
-              $template->output), $scan);
+              $template->output, $scan);
 }
 
 1

diff --git a/IkiWiki/Plugin/toggle.pm b/IkiWiki/Plugin/toggle.pm
index 3319421d923d56c3489b7374edb912be7493027b..20967d3fd79e85fb5f0e677b0a7d76eb6e7ac38f 100644 (file)
--- a/IkiWiki/Plugin/toggle.pm
+++ b/IkiWiki/Plugin/toggle.pm
@@ -50,8 +50,7 @@ sub preprocess_toggleable (@) {
 
        # Preprocess the text to expand any preprocessor directives
        # embedded inside it.
-       $params{text}=IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
+       $params{text}=IkiWiki::preprocess($params{page}, $params{destpage}, $params{text});
        
        my $id=genid($params{page}, $params{id});
        my $class=(lc($params{open}) ne "yes") ? "toggleable" : "toggleable-open";

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index bb80123423453c5d01a558569f48924e05fbba55..2e3902388f5c7bba8cc7d57fc39d288d8b2e4faf 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -198,8 +198,8 @@ value is ignored.
 
        hook(type => "filter", id => "foo", call => \&filter);
 
-Runs on the raw source of a page, before anything else touches it, and can
-make arbitrary changes. The function is passed named parameters "page",
+Runs on the full raw source of a page, before anything else touches it, and
+can make arbitrary changes. The function is passed named parameters "page",
 "destpage", and "content". It should return the filtered content.
 
 ### preprocess