* Make all templates have a footer div to ease themeing. Required template
[ikiwiki.git] / IkiWiki / Plugin / conditional.pm
index 293fbc1914597ef2364e81ad4978c381bf812f76..6c14361f7d2b39df373d0e7fda25bab8946fa23f 100644 (file)
@@ -3,12 +3,9 @@ package IkiWiki::Plugin::conditional;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
 use UNIVERSAL;
 
-# Globals used to pass information into the PageSpec functions.
-our ($sourcepage, $destpage);
-
 sub import { #{{{
        hook(type => "preprocess", id => "if", call => \&preprocess_if);
 } # }}}
@@ -16,32 +13,37 @@ sub import { #{{{
 sub preprocess_if (@) { #{{{
        my %params=@_;
 
-       if (! exists $params{test} || ! exists $params{then}) {
-               return "[[if requires \"test\" and \"then\" parameters]]";
+       foreach my $param (qw{test then}) {
+               if (! exists $params{$param}) {
+                       return "[[if ".sprintf(gettext('%s parameter is required'), $param)."]]";
+               }
        }
 
        my $result=0;
-       $sourcepage=$params{page};
-       $destpage=$params{destpage};
-       # 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)\((.*)\)$/) {
-               $result=eval "IkiWiki::PageSpec::match_$1(undef, ".
-                       IkiWiki::safequote($2).")";
+       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} =~ /^(enabled|sourcepage|destpage)\((.*)\)$/) {
+               add_depends($params{page}, "$params{test} and $params{page}");
+               $result=pagespec_match($params{page}, $params{test},
+                               location => $params{page},
+                               sourcepage => $params{page},
+                               destpage => $params{destpage});
        }
        else {
                add_depends($params{page}, $params{test});
 
                foreach my $page (keys %pagesources) {
-                       if (pagespec_match($page, $params{test}, $params{page})) {
+                       if (pagespec_match($page, $params{test}, 
+                                       location => $params{page},
+                                       sourcepage => $params{page},
+                                       destpage => $params{destpage})) {
                                $result=1;
                                last;
                        }
                }
        }
-       $sourcepage="";
-       $destpage="";
 
        my $ret;
        if ($result) {
@@ -59,32 +61,59 @@ sub preprocess_if (@) { #{{{
 
 package IkiWiki::PageSpec;
 
-sub match_enabled ($$) { #{{{
+sub match_enabled ($$;@) { #{{{
        shift;
        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 ($$) { #{{{
+sub match_sourcepage ($$;@) { #{{{
        shift;
        my $glob=shift;
-       
-       return match_glob($IkiWiki::Plugin::conditional::sourcepage, $glob,
-               $IkiWiki::Plugin::conditional::sourcepage);
+       my %params=@_;
+
+       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 ($$) { #{{{
+sub match_destpage ($$;@) { #{{{
        shift;
        my $glob=shift;
+       my %params=@_;
        
-       return match_glob($IkiWiki::Plugin::conditional::destpage, $glob,
-               $IkiWiki::Plugin::conditional::sourcepage);
+       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 ($$) { #{{{
-       return $IkiWiki::Plugin::conditional::sourcepage ne $IkiWiki::Plugin::conditional::destpage;
+sub match_included ($$;$) { #{{{
+       shift;
+       shift;
+       my %params=@_;
+
+       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