X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/40af2fc96ce82eaa9b72d2a61cbfa1e4df33e673..0b977fa22cabf8e1050857412123015c07c30c19:/IkiWiki.pm diff --git a/IkiWiki.pm b/IkiWiki.pm index 679ca716e..0c1df8b47 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -11,14 +11,15 @@ use open qw{:utf8 :std}; use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase %renderedfiles %oldrenderedfiles %pagesources %destsources - %depends %hooks %forcerebuild $gettext_obj}; + %depends %hooks %forcerebuild $gettext_obj}; use Exporter q{import}; our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match bestlink htmllink readfile writefile pagetype srcfile pagename displaytime will_render gettext urlto targetpage + add_underlay %config %links %renderedfiles %pagesources %destsources); -our $VERSION = 1.02; # plugin interface version, next is ikiwiki version +our $VERSION = 2.00; # plugin interface version, next is ikiwiki version our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE @@ -29,16 +30,34 @@ memoize("pagespec_translate"); memoize("file_pruned"); sub defaultconfig () { #{{{ + return wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/, qr/\.ikiwiki-new$/, - qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//], - wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/, + qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//, + qr/(^|\/)_MTN\//, + qr/\.dpkg-tmp$/], + wiki_link_regexp => qr{ + \[\[ # beginning of link + (?: + ([^\]\|\n]+) # 1: link text + \| # followed by '|' + )? # optional + + ([^\s\]#]+) # 2: page to link to + (?: + \# # '#', beginning of anchor + ([^\s\]]+) # 3: anchor text + )? # optional + + \]\] # end of link + }x, wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/, verbose => 0, syslog => 0, wikiname => "wiki", default_pageext => "mdwn", + htmlext => "html", cgi => 0, post_commit => 0, rcs => '', @@ -65,20 +84,23 @@ sub defaultconfig () { #{{{ pingurl => [], templatedir => "$installdir/share/ikiwiki/templates", underlaydir => "$installdir/share/ikiwiki/basewiki", + underlaydirs => [], setup => undef, adminuser => undef, adminemail => undef, - plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit + plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit lockedit conditional}], + libdir => undef, timeformat => '%c', locale => undef, sslcookie => 0, httpauth => 0, userdir => "", - usedirs => 0, + usedirs => 1, numbacklinks => 10, + account_creation_password => "", } #}}} - + sub checkconfig () { #{{{ # locale stuff; avoid LC_ALL since it overrides everything if (defined $ENV{LC_ALL}) { @@ -110,7 +132,7 @@ sub checkconfig () { #{{{ unless exists $config{wikistatedir}; if ($config{rcs}) { - eval qq{require IkiWiki::Rcs::$config{rcs}}; + eval qq{use IkiWiki::Rcs::$config{rcs}}; if ($@) { error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@"); } @@ -120,17 +142,25 @@ sub checkconfig () { #{{{ } run_hooks(checkconfig => sub { shift->() }); + + return 1; } #}}} sub loadplugins () { #{{{ + if (defined $config{libdir}) { + unshift @INC, possibly_foolish_untaint($config{libdir}); + } + loadplugin($_) foreach @{$config{plugin}}; - + run_hooks(getopt => sub { shift->() }); if (grep /^-/, @ARGV) { print STDERR "Unknown option: $_\n" foreach grep /^-/, @ARGV; usage(); } + + return 1; } #}}} sub loadplugin ($) { #{{{ @@ -138,11 +168,21 @@ sub loadplugin ($) { #{{{ return if grep { $_ eq $plugin} @{$config{disable_plugins}}; + foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef, + "$installdir/lib/ikiwiki") { + if (defined $dir && -x "$dir/plugins/$plugin") { + require IkiWiki::Plugin::external; + import IkiWiki::Plugin::external "$dir/plugins/$plugin"; + return 1; + } + } + my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin); eval qq{use $mod}; if ($@) { error("Failed to load plugin $mod: $@"); } + return 1; } #}}} sub error ($;$) { #{{{ @@ -162,7 +202,7 @@ sub error ($;$) { #{{{ sub debug ($) { #{{{ return unless $config{verbose}; - log_message(debug => @_); + return log_message(debug => @_); } #}}} my $log_open=0; @@ -171,26 +211,26 @@ sub log_message ($$) { #{{{ if ($config{syslog}) { require Sys::Syslog; - unless ($log_open) { + if (! $log_open) { Sys::Syslog::setlogsock('unix'); Sys::Syslog::openlog('ikiwiki', '', 'user'); $log_open=1; } - eval { - Sys::Syslog::syslog($type, "%s", join(" ", @_)); + return eval { + Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_)); }; } elsif (! $config{cgi}) { - print "@_\n"; + return print "@_\n"; } else { - print STDERR "@_\n"; + return print STDERR "@_\n"; } } #}}} sub possibly_foolish_untaint ($) { #{{{ my $tainted=shift; - my ($untainted)=$tainted=~/(.*)/; + my ($untainted)=$tainted=~/(.*)/s; return $untainted; } #}}} @@ -214,7 +254,7 @@ sub pagetype ($) { #{{{ if ($page =~ /\.([^.]+)$/) { return $1 if exists $hooks{htmlize}{$1}; } - return undef; + return; } #}}} sub pagename ($) { #{{{ @@ -240,15 +280,31 @@ sub targetpage ($$) { #{{{ sub htmlpage ($) { #{{{ my $page=shift; - return targetpage($page, "html"); + return targetpage($page, $config{htmlext}); } #}}} sub srcfile ($) { #{{{ my $file=shift; return "$config{srcdir}/$file" if -e "$config{srcdir}/$file"; - return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file"; - error("internal error: $file cannot be found in $config{srcdir} or $config{underlaydir}"); + foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) { + return "$dir/$file" if -e "$dir/$file"; + } + error("internal error: $file cannot be found in $config{srcdir} or underlay"); + return; +} #}}} + +sub add_underlay ($) { #{{{ + my $dir=shift; + + if ($dir=~/^\//) { + unshift @{$config{underlaydirs}}, $dir; + } + else { + unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir"; + } + + return 1; } #}}} sub readfile ($;$$) { #{{{ @@ -261,11 +317,11 @@ sub readfile ($;$$) { #{{{ } local $/=undef; - open (IN, $file) || error("failed to read $file: $!"); - binmode(IN) if ($binary); - return \*IN if $wantfd; - my $ret=; - close IN || error("failed to read $file: $!"); + open (my $in, "<", $file) || error("failed to read $file: $!"); + binmode($in) if ($binary); + return \*$in if $wantfd; + my $ret=<$in>; + close $in || error("failed to read $file: $!"); return $ret; } #}}} @@ -300,17 +356,19 @@ sub writefile ($$$;$$) { #{{{ } my $cleanup = sub { unlink($newfile) }; - open (OUT, ">$newfile") || error("failed to write $newfile: $!", $cleanup); - binmode(OUT) if ($binary); + open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup); + binmode($out) if ($binary); if ($writer) { - $writer->(\*OUT, $cleanup); + $writer->(\*$out, $cleanup); } else { - print OUT $content or error("failed writing to $newfile: $!", $cleanup); + print $out $content or error("failed writing to $newfile: $!", $cleanup); } - close OUT || error("failed saving $newfile: $!", $cleanup); + close $out || error("failed saving $newfile: $!", $cleanup); rename($newfile, "$destdir/$file") || error("failed renaming $newfile to $destdir/$file: $!", $cleanup); + + return 1; } #}}} my %cleared; @@ -336,6 +394,8 @@ sub will_render ($$;$) { #{{{ $cleared{$page}=1; } $destsources{$dest}=$page; + + return 1; } #}}} sub bestlink ($$) { #{{{ @@ -361,8 +421,14 @@ sub bestlink ($$) { #{{{ } } while $cwd=~s!/?[^/]+$!!; - if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) { - return "$config{userdir}/".lc($link); + if (length $config{userdir}) { + my $l = "$config{userdir}/".lc($link); + if (exists $links{$l}) { + return $l; + } + elsif (exists $pagecase{lc $l}) { + return $pagecase{lc $l}; + } } #print STDERR "warning: page $page, broken link: $link\n"; @@ -372,7 +438,7 @@ sub bestlink ($$) { #{{{ sub isinlinableimage ($) { #{{{ my $file=shift; - $file=~/\.(png|gif|jpg|jpeg)$/i; + return $file =~ /\.(png|gif|jpg|jpeg)$/i; } #}}} sub pagetitle ($;$) { #{{{ @@ -444,7 +510,7 @@ sub displaytime ($) { #{{{ sub beautify_url ($) { #{{{ my $url=shift; - $url =~ s!/index.html$!/!; + $url =~ s!/index.$config{htmlext}$!/!; $url =~ s!^$!./!; # Browsers don't like empty links... return $url; @@ -518,7 +584,12 @@ sub htmllink ($$$;@) { #{{{ $bestlink.="#".$opts{anchor}; } - return "$linktext"; + my @attrs; + if (defined $opts{rel}) { + push @attrs, ' rel="'.$opts{rel}.'"'; + } + + return "$linktext"; } #}}} sub htmlize ($$$) { #{{{ @@ -591,7 +662,17 @@ sub preprocess ($$$;$$) { #{{{ # Note: preserve order of params, some plugins may # consider it significant. my @params; - while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) { + while ($params =~ m{ + (?:(\w+)=)? # 1: named parameter key? + (?: + """(.*?)""" # 2: triple-quoted value + | + "([^"]+)" # 3: single-quoted value + | + (\S+) # 4: unquoted value + ) + (?:\s+|$) # delimiter to next param + }sgx) { my $key=$1; my $val; if (defined $2) { @@ -639,16 +720,38 @@ sub preprocess ($$$;$$) { #{{{ } }; - $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg; + $content =~ s{ + (\\?) # 1: escape? + \[\[ # directive open + (\w+) # 2: command + \s+ + ( # 3: the parameters.. + (?: + (?:\w+=)? # named parameter key? + (?: + """.*?""" # triple-quoted value + | + "[^"]+" # single-quoted value + | + [^\s\]]+ # unquoted value + ) + \s* # whitespace or end + # of directive + ) + *) # 0 or more parameters + \]\] # directive closed + }{$handle->($1, $2, $3)}sexg; return $content; } #}}} -sub filter ($$) { #{{{ +sub filter ($$$) { #{{{ my $page=shift; + my $destpage=shift; my $content=shift; run_hooks(filter => sub { - $content=shift->(page => $page, content => $content); + $content=shift->(page => $page, destpage => $destpage, + content => $content); }); return $content; @@ -658,56 +761,70 @@ sub indexlink () { #{{{ return "$config{wikiname}"; } #}}} -sub lockwiki () { #{{{ +my $wikilock; + +sub lockwiki (;$) { #{{{ + my $wait=@_ ? shift : 1; # Take an exclusive lock on the wiki to prevent multiple concurrent # run issues. The lock will be dropped on program exit. if (! -d $config{wikistatedir}) { mkdir($config{wikistatedir}); } - open(WIKILOCK, ">$config{wikistatedir}/lockfile") || + open($wikilock, '>', "$config{wikistatedir}/lockfile") || error ("cannot write to $config{wikistatedir}/lockfile: $!"); - if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB - debug("wiki seems to be locked, waiting for lock"); - my $wait=600; # arbitrary, but don't hang forever to - # prevent process pileup - for (1..$wait) { - return if flock(WIKILOCK, 2 | 4); - sleep 1; + if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB + if ($wait) { + debug("wiki seems to be locked, waiting for lock"); + my $wait=600; # arbitrary, but don't hang forever to + # prevent process pileup + for (1..$wait) { + return if flock($wikilock, 2 | 4); + sleep 1; + } + error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)"); + } + else { + return 0; } - error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)"); } + return 1; } #}}} sub unlockwiki () { #{{{ - close WIKILOCK; + return close($wikilock) if $wikilock; + return; } #}}} +my $commitlock; + sub commit_hook_enabled () { #{{{ - open(COMMITLOCK, "+>$config{wikistatedir}/commitlock") || - error ("cannot write to $config{wikistatedir}/commitlock: $!"); - if (! flock(COMMITLOCK, 1 | 4)) { # LOCK_SH | LOCK_NB to test - close COMMITLOCK; + open($commitlock, '+>', "$config{wikistatedir}/commitlock") || + error("cannot write to $config{wikistatedir}/commitlock: $!"); + if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test + close($commitlock) || error("failed closing commitlock: $!"); return 0; } - close COMMITLOCK; + close($commitlock) || error("failed closing commitlock: $!"); return 1; } #}}} sub disable_commit_hook () { #{{{ - open(COMMITLOCK, ">$config{wikistatedir}/commitlock") || - error ("cannot write to $config{wikistatedir}/commitlock: $!"); - if (! flock(COMMITLOCK, 2)) { # LOCK_EX + open($commitlock, '>', "$config{wikistatedir}/commitlock") || + error("cannot write to $config{wikistatedir}/commitlock: $!"); + if (! flock($commitlock, 2)) { # LOCK_EX error("failed to get commit lock"); } + return 1; } #}}} sub enable_commit_hook () { #{{{ - close COMMITLOCK; + return close($commitlock) if $commitlock; + return; } #}}} sub loadindex () { #{{{ - open (IN, "$config{wikistatedir}/index") || return; - while () { + open (my $in, "<", "$config{wikistatedir}/index") || return; + while (<$in>) { $_=possibly_foolish_untaint($_); chomp; my %items; @@ -729,12 +846,12 @@ sub loadindex () { #{{{ $depends{$page}=$items{depends}[0] if exists $items{depends}; $destsources{$_}=$page foreach @{$items{dest}}; $renderedfiles{$page}=[@{$items{dest}}]; - $oldrenderedfiles{$page}=[@{$items{dest}}]; $pagecase{lc $page}=$page; } + $oldrenderedfiles{$page}=[@{$items{dest}}]; $pagectime{$page}=$items{ctime}[0]; } - close IN; + return close($in); } #}}} sub saveindex () { #{{{ @@ -745,7 +862,7 @@ sub saveindex () { #{{{ } my $newfile="$config{wikistatedir}/index.new"; my $cleanup = sub { unlink($newfile) }; - open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup); + open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup); foreach my $page (keys %pagemtime) { next unless $pagemtime{$page}; my $line="mtime=$pagemtime{$page} ". @@ -757,11 +874,13 @@ sub saveindex () { #{{{ if (exists $depends{$page}) { $line.=" depends=".encode_entities($depends{$page}, " \t\n"); } - print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup); + print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup); } - close OUT || error("failed saving to $newfile: $!", $cleanup); + close $out || error("failed saving to $newfile: $!", $cleanup); rename($newfile, "$config{wikistatedir}/index") || error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup); + + return 1; } #}}} sub template_file ($) { #{{{ @@ -770,7 +889,7 @@ sub template_file ($) { #{{{ foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") { return "$dir/$template" if -e "$dir/$template"; } - return undef; + return; } #}}} sub template_params (@) { #{{{ @@ -781,11 +900,10 @@ sub template_params (@) { #{{{ return ""; } - require HTML::Template; my @ret=( filter => sub { my $text_ref = shift; - $$text_ref=&Encode::decode_utf8($$text_ref); + ${$text_ref} = Encode::decode_utf8(${$text_ref}); }, filename => $filename, loop_context_vars => 1, @@ -796,7 +914,8 @@ sub template_params (@) { #{{{ } #}}} sub template ($;@) { #{{{ - HTML::Template->new(template_params(@_)); + require HTML::Template; + return HTML::Template->new(template_params(@_)); } #}}} sub misctemplate ($$;@) { #{{{ @@ -822,12 +941,13 @@ sub hook (@) { # {{{ my %param=@_; if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) { - error "hook requires type, call, and id parameters"; + error 'hook requires type, call, and id parameters'; } return if $param{no_override} && exists $hooks{$param{type}}{$param{id}}; $hooks{$param{type}}{$param{id}}=\%param; + return 1; } # }}} sub run_hooks ($$) { # {{{ @@ -849,6 +969,8 @@ sub run_hooks ($$) { # {{{ $sub->($hooks{$type}{$id}{call}); } } + + return 1; } #}}} sub globlist_to_pagespec ($) { #{{{ @@ -864,9 +986,9 @@ sub globlist_to_pagespec ($) { #{{{ } } - my $spec=join(" or ", @spec); + my $spec=join(' or ', @spec); if (@skip) { - my $skip=join(" and ", @skip); + my $skip=join(' and ', @skip); if (length $spec) { $spec="$skip and ($spec)"; } @@ -879,7 +1001,7 @@ sub globlist_to_pagespec ($) { #{{{ sub is_globlist ($) { #{{{ my $s=shift; - $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or"; + return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" ); } #}}} sub safequote ($) { #{{{ @@ -898,21 +1020,25 @@ sub add_depends ($$) { #{{{ else { $depends{$page}=pagespec_merge($depends{$page}, $pagespec); } + + return 1; } # }}} sub file_pruned ($$) { #{{{ require File::Spec; my $file=File::Spec->canonpath(shift); my $base=File::Spec->canonpath(shift); - $file=~s#^\Q$base\E/*##; + $file =~ s#^\Q$base\E/*##; my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')'; - $file =~ m/$regexp/; + return $file =~ m/$regexp/; } #}}} sub gettext { #{{{ # Only use gettext in the rare cases it's needed. - if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) { + if ((exists $ENV{LANG} && length $ENV{LANG}) || + (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) || + (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) { if (! $gettext_obj) { $gettext_obj=eval q{ use Locale::gettext q{textdomain}; @@ -960,55 +1086,101 @@ sub pagespec_translate ($) { #{{{ # Convert spec to perl code. my $code=""; - while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) { + while ($spec=~m{ + \s* # ignore whitespace + ( # 1: match a single word + \! # ! + | + \( # ( + | + \) # ) + | + \w+\([^\)]*\) # command(params) + | + [^\s()]+ # any other text + ) + \s* # ignore whitespace + }igx) { my $word=$1; - if (lc $word eq "and") { - $code.=" &&"; + if (lc $word eq 'and') { + $code.=' &&'; } - elsif (lc $word eq "or") { - $code.=" ||"; + elsif (lc $word eq 'or') { + $code.=' ||'; } elsif ($word eq "(" || $word eq ")" || $word eq "!") { - $code.=" ".$word; + $code.=' '.$word; } elsif ($word =~ /^(\w+)\((.*)\)$/) { if (exists $IkiWiki::PageSpec::{"match_$1"}) { - $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \$from)"; + $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)"; } else { - $code.=" 0"; + $code.=' 0'; } } else { - $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)"; + $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)"; } } return $code; } #}}} -sub pagespec_match ($$;$) { #{{{ +sub pagespec_match ($$;@) { #{{{ my $page=shift; my $spec=shift; - my $from=shift; + my @params=@_; - return eval pagespec_translate($spec); + # Backwards compatability with old calling convention. + if (@params == 1) { + unshift @params, 'location'; + } + + my $ret=eval pagespec_translate($spec); + return IkiWiki::FailReason->new('syntax error') if $@; + return $ret; +} #}}} + +package IkiWiki::FailReason; + +use overload ( #{{{ + '""' => sub { ${$_[0]} }, + '0+' => sub { 0 }, + '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'}, + fallback => 1, +); #}}} + +sub new { #{{{ + return bless \$_[1], $_[0]; } #}}} +package IkiWiki::SuccessReason; + +use overload ( #{{{ + '""' => sub { ${$_[0]} }, + '0+' => sub { 1 }, + '!' => sub { bless $_[0], 'IkiWiki::FailReason'}, + fallback => 1, +); #}}} + +sub new { #{{{ + return bless \$_[1], $_[0]; +}; #}}} + package IkiWiki::PageSpec; -sub match_glob ($$$) { #{{{ +sub match_glob ($$;@) { #{{{ my $page=shift; my $glob=shift; - my $from=shift; - if (! defined $from){ - $from = ""; - } - + my %params=@_; + + my $from=exists $params{location} ? $params{location} : ''; + # relative matching if ($glob =~ m!^\./!) { - $from=~s!/?[^/]+$!!; - $glob=~s!^\./!!; + $from=~s#/?[^/]+$##; + $glob=~s#^\./##; $glob="$from/$glob" if length $from; } @@ -1017,72 +1189,122 @@ sub match_glob ($$$) { #{{{ $glob=~s/\\\*/.*/g; $glob=~s/\\\?/./g; - return $page=~/^$glob$/i; + if ($page=~/^$glob$/i) { + return IkiWiki::SuccessReason->new("$glob matches $page"); + } + else { + return IkiWiki::FailReason->new("$glob does not match $page"); + } } #}}} -sub match_link ($$$) { #{{{ +sub match_link ($$;@) { #{{{ my $page=shift; my $link=lc(shift); - my $from=shift; - if (! defined $from){ - $from = ""; - } + my %params=@_; + + my $from=exists $params{location} ? $params{location} : ''; # relative matching if ($link =~ m!^\.! && defined $from) { - $from=~s!/?[^/]+$!!; - $link=~s!^\./!!; + $from=~s#/?[^/]+$##; + $link=~s#^\./##; $link="$from/$link" if length $from; } - my $links = $IkiWiki::links{$page} or return undef; - return 0 unless @$links; + my $links = $IkiWiki::links{$page}; + return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links}; my $bestlink = IkiWiki::bestlink($from, $link); - return 0 unless length $bestlink; - foreach my $p (@$links) { - return 1 if $bestlink eq IkiWiki::bestlink($page, $p); + foreach my $p (@{$links}) { + if (length $bestlink) { + return IkiWiki::SuccessReason->new("$page links to $link") + if $bestlink eq IkiWiki::bestlink($page, $p); + } + else { + return IkiWiki::SuccessReason->new("$page links to page matching $link") + if match_glob($p, $link, %params); + } } - return 0; + return IkiWiki::FailReason->new("$page does not link to $link"); } #}}} -sub match_backlink ($$$) { #{{{ - match_link($_[1], $_[0], $_[3]); +sub match_backlink ($$;@) { #{{{ + return match_link($_[1], $_[0], @_); } #}}} -sub match_created_before ($$$) { #{{{ +sub match_created_before ($$;@) { #{{{ my $page=shift; my $testpage=shift; if (exists $IkiWiki::pagectime{$testpage}) { - return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}; + if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) { + return IkiWiki::SuccessReason->new("$page created before $testpage"); + } + else { + return IkiWiki::FailReason->new("$page not created before $testpage"); + } } else { - return 0; + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} -sub match_created_after ($$$) { #{{{ +sub match_created_after ($$;@) { #{{{ my $page=shift; my $testpage=shift; if (exists $IkiWiki::pagectime{$testpage}) { - return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}; + if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) { + return IkiWiki::SuccessReason->new("$page created after $testpage"); + } + else { + return IkiWiki::FailReason->new("$page not created after $testpage"); + } } else { - return 0; + return IkiWiki::FailReason->new("$testpage has no ctime"); } } #}}} -sub match_creation_day ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift); +sub match_creation_day ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) { + return IkiWiki::SuccessReason->new('creation_day matched'); + } + else { + return IkiWiki::FailReason->new('creation_day did not match'); + } } #}}} -sub match_creation_month ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift); +sub match_creation_month ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) { + return IkiWiki::SuccessReason->new('creation_month matched'); + } + else { + return IkiWiki::FailReason->new('creation_month did not match'); + } +} #}}} + +sub match_creation_year ($$;@) { #{{{ + if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) { + return IkiWiki::SuccessReason->new('creation_year matched'); + } + else { + return IkiWiki::FailReason->new('creation_year did not match'); + } } #}}} -sub match_creation_year ($$$) { #{{{ - return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift); +sub match_user ($$;@) { #{{{ + shift; + my $user=shift; + my %params=@_; + + return IkiWiki::FailReason->new('cannot match user') + unless exists $params{user}; + if ($user eq $params{user}) { + return IkiWiki::SuccessReason->new("user is $user") + } + else { + return IkiWiki::FailReason->new("user is not $user"); + } } #}}} 1