add plugin safe/rebuild info (part 1 of 2)

[ikiwiki.git] / IkiWiki / Plugin / conditional.pm

diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm
index 29223ace24ef419bfb23bdd468a061bdebfdac19..7716fce1b4be7a612a84d71386c11f92adff51b3 100644 (file)
--- a/IkiWiki/Plugin/conditional.pm
+++ b/IkiWiki/Plugin/conditional.pm
@@ -7,21 +7,34 @@ use IkiWiki 2.00;
 use UNIVERSAL;
 
 sub import { #{{{
+       hook(type => "getsetup", id => "conditional", call => \&getsetup);
        hook(type => "preprocess", id => "if", call => \&preprocess_if);
 } # }}}
 
+sub getsetup { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+} #}}}
+
 sub preprocess_if (@) { #{{{
        my %params=@_;
 
-       if (! exists $params{test} || ! exists $params{then}) {
-               return "[[if ".gettext('"test" and "then" parameters are required')."]]";
+       foreach my $param (qw{test then}) {
+               if (! exists $params{$param}) {
+                       error sprintf(gettext('%s parameter is required'), $param);
+               }
        }
 
        my $result=0;
-       # An optimisation to avoid needless looping over every page
-       # and adding of dependencies for simple uses of some of the
-       # tests.
-       if ($params{test} =~ /^(enabled|sourcepage|destpage)\((.*)\)$/) {
+       if ((exists $params{all} && lc $params{all} eq "no") ||
+               # An optimisation to avoid needless looping over every page
+               # and adding of dependencies for simple uses of some of the
+               # tests.
+               $params{test} =~ /^\s*\!?\s*(enabled|sourcepage|destpage|included)\((.*)\)\s*$/) {
+               add_depends($params{page}, "$params{test} and $params{page}");
                $result=pagespec_match($params{page}, $params{test},
                                location => $params{page},
                                sourcepage => $params{page},
@@ -52,7 +65,7 @@ sub preprocess_if (@) { #{{{
                $ret="";
        }
        return IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $ret));
+               IkiWiki::filter($params{page}, $params{destpage}, $ret));
 } # }}}
 
 package IkiWiki::PageSpec;
@@ -62,7 +75,12 @@ sub match_enabled ($$;@) { #{{{
        my $plugin=shift;
        
        # test if the plugin is enabled
-       return UNIVERSAL::can("IkiWiki::Plugin::".$plugin, "import");
+       if (UNIVERSAL::can("IkiWiki::Plugin::".$plugin, "import")) {
+               return IkiWiki::SuccessReason->new("$plugin is enabled");
+       }
+       else {
+               return IkiWiki::FailReason->new("$plugin is not enabled");
+       }
 } #}}}
 
 sub match_sourcepage ($$;@) { #{{{
@@ -70,8 +88,13 @@ sub match_sourcepage ($$;@) { #{{{
        my $glob=shift;
        my %params=@_;
 
-       return unless exists $params{sourcepage};
-       return match_glob($params{sourcepage}, $glob, @_);
+       return IkiWiki::FailReason->new("cannot match sourcepage") unless exists $params{sourcepage};
+       if (match_glob($params{sourcepage}, $glob, @_)) {
+               return IkiWiki::SuccessReason->new("sourcepage matches $glob");
+       }
+       else {
+               return IkiWiki::FailReason->new("sourcepage does not match $glob");
+       }
 } #}}}
 
 sub match_destpage ($$;@) { #{{{
@@ -79,17 +102,27 @@ sub match_destpage ($$;@) { #{{{
        my $glob=shift;
        my %params=@_;
        
-       return unless exists $params{destpage};
-       return match_glob($params{destpage}, $glob, @_);
+       return IkiWiki::FailReason->new("cannot match destpage") unless exists $params{destpage};
+       if (match_glob($params{destpage}, $glob, @_)) {
+               return IkiWiki::SuccessReason->new("destpage matches $glob");
+       }
+       else {
+               return IkiWiki::FailReason->new("destpage does not match $glob");
+       }
 } #}}}
 
-sub match_included ($$;$) { #{{{
+sub match_included ($$;@) { #{{{
        shift;
        shift;
        my %params=@_;
 
-       return unless exists $params{sourcepage} && exists $params{destpage};
-       return $params{sourcepage} ne $params{destpage};
+       return IkiWiki::FailReason->new("cannot match included") unless exists $params{sourcepage} && exists $params{destpage};
+       if ($params{sourcepage} ne $params{destpage}) {
+               return IkiWiki::SuccessReason->new("page $params{sourcepage} is included");
+       }
+       else {
+               return IkiWiki::FailReason->new("page $params{sourcepage} is not included");
+       }
 } #}}}
 
 1