X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/ee1ad53c4c2710aa7ded61bdc56f3a8cce514f22..be0c2df6db1e30b4ee4213f402a1414e2e2abd85:/IkiWiki/Plugin/conditional.pm diff --git a/IkiWiki/Plugin/conditional.pm b/IkiWiki/Plugin/conditional.pm index 29223ace2..8a5796149 100644 --- a/IkiWiki/Plugin/conditional.pm +++ b/IkiWiki/Plugin/conditional.pm @@ -3,42 +3,50 @@ package IkiWiki::Plugin::conditional; use warnings; use strict; -use IkiWiki 2.00; +use IkiWiki 3.00; use UNIVERSAL; -sub import { #{{{ +sub import { + hook(type => "getsetup", id => "conditional", call => \&getsetup); hook(type => "preprocess", id => "if", call => \&preprocess_if); -} # }}} +} -sub preprocess_if (@) { #{{{ +sub getsetup { + return + plugin => { + safe => 1, + rebuild => undef, + section => "widget", + }, +} + +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} && ! IkiWiki::yesno($params{all})) || + # An optimisation to avoid needless looping over every page + # for simple uses of some of the tests. + $params{test} =~ /^([\s\!()]*((enabled|sourcepage|destpage|included)\([^)]*\)|(and|or))[\s\!()]*)+$/) { + 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}, - location => $params{page}, - sourcepage => $params{page}, - destpage => $params{destpage})) { - $result=1; - last; - } - } + $result=pagespec_match_list($params{page}, $params{test}, + # stop after first match + num => 1, + sourcepage => $params{page}, + destpage => $params{destpage}, + ); } my $ret; @@ -52,44 +60,68 @@ 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; -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; my %params=@_; + + $glob=derel($glob, $params{location}); - 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 ($$;@) { #{{{ +sub match_destpage ($$;@) { shift; my $glob=shift; my %params=@_; - return unless exists $params{destpage}; - return match_glob($params{destpage}, $glob, @_); -} #}}} + $glob=derel($glob, $params{location}); + + 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