web commit by NicolasLimare: explanations

[git.ikiwiki.info.git] / IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 85710c5ff3f0f2e025fdae391f5402d523a36508..88dcdcb5b89993857cd61ffc64ce8d41f0957459 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -5,20 +5,23 @@ use warnings;
 use strict;
 use Encode;
 use HTML::Entities;
 use strict;
 use Encode;
 use HTML::Entities;

-use URI::Escape;
+use URI::Escape q{uri_escape_utf8};
+use POSIX;

 use open qw{:utf8 :std};
 
 use open qw{:utf8 :std};
 

-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
-            %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
-           %forcerebuild $gettext_obj};
+use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
+            %renderedfiles %oldrenderedfiles %pagesources %destsources
+           %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
 
 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
-                 %config %links %renderedfiles %pagesources);
-our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
-our $version="1.45";my $installdir="/usr";
+                 displaytime will_render gettext urlto targetpage
+                 %config %links %renderedfiles %pagesources %destsources);
+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
+

 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 # Optimisation.
 use Memoize;
 memoize("abs2rel");


@@ -28,14 +31,30 @@ memoize("file_pruned");
 sub defaultconfig () { #{{{
        wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
                qr/\.x?html?$/, qr/\.ikiwiki-new$/,
 sub defaultconfig () { #{{{
        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/\.dpkg-tmp$/],
+       wiki_link_regexp => qr{
+               \[\[                    # beginning of link
+               (?:
+                       ([^\]\|]+)      # 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",
        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 => '',
        cgi => 0,
        post_commit => 0,
        rcs => '',


@@ -65,13 +84,17 @@ sub defaultconfig () { #{{{
        setup => undef,
        adminuser => undef,
        adminemail => undef,
        setup => undef,
        adminuser => undef,
        adminemail => undef,

-       plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
+       plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit

                      lockedit conditional}],
                      lockedit conditional}],

+       libdir => undef,

        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
        httpauth => 0,
        userdir => "",
        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
        httpauth => 0,
        userdir => "",

+       usedirs => 1,
+       numbacklinks => 10,
+       account_creation_password => "",

 } #}}}
    
 sub checkconfig () { #{{{
 } #}}}
    
 sub checkconfig () { #{{{


@@ -81,8 +104,6 @@ sub checkconfig () { #{{{
                delete $ENV{LC_ALL};
        }
        if (defined $config{locale}) {
                delete $ENV{LC_ALL};
        }
        if (defined $config{locale}) {

-               eval q{use POSIX};
-               error($@) if $@;

                if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
                        $ENV{LANG}=$config{locale};
                        $gettext_obj=undef;
                if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
                        $ENV{LANG}=$config{locale};
                        $gettext_obj=undef;


@@ -107,7 +128,7 @@ sub checkconfig () { #{{{
                unless exists $config{wikistatedir};
        
        if ($config{rcs}) {
                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}: $@");
                }
                if ($@) {
                        error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
                }


@@ -120,8 +141,12 @@ sub checkconfig () { #{{{
 } #}}}
 
 sub loadplugins () { #{{{
 } #}}}
 
 sub loadplugins () { #{{{

+       if (defined $config{libdir}) {
+               unshift @INC, $config{libdir};
+       }
+

        loadplugin($_) foreach @{$config{plugin}};
        loadplugin($_) foreach @{$config{plugin}};

-       
+

        run_hooks(getopt => sub { shift->() });
        if (grep /^-/, @ARGV) {
                print STDERR "Unknown option: $_\n"
        run_hooks(getopt => sub { shift->() });
        if (grep /^-/, @ARGV) {
                print STDERR "Unknown option: $_\n"


@@ -150,7 +175,7 @@ sub error ($;$) { #{{{
                print misctemplate(gettext("Error"),
                        "<p>".gettext("Error").": $message</p>");
        }
                print misctemplate(gettext("Error"),
                        "<p>".gettext("Error").": $message</p>");
        }

-       log_message(debug => $message) if $config{syslog};
+       log_message('err' => $message) if $config{syslog};

        if (defined $cleaner) {
                $cleaner->();
        }
        if (defined $cleaner) {
                $cleaner->();
        }


@@ -174,8 +199,8 @@ sub log_message ($$) { #{{{
                        $log_open=1;
                }
                eval {
                        $log_open=1;
                }
                eval {

-                       Sys::Syslog::syslog($type, "%s", join(" ", @_));
-               }
+                       Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
+               };

        }
        elsif (! $config{cgi}) {
                print "@_\n";
        }
        elsif (! $config{cgi}) {
                print "@_\n";


@@ -187,7 +212,7 @@ sub log_message ($$) { #{{{
 
 sub possibly_foolish_untaint ($) { #{{{
        my $tainted=shift;
 
 sub possibly_foolish_untaint ($) { #{{{
        my $tainted=shift;

-       my ($untainted)=$tainted=~/(.*)/;
+       my ($untainted)=$tainted=~/(.*)/s;

        return $untainted;
 } #}}}
 
        return $untainted;
 } #}}}
 


@@ -223,10 +248,21 @@ sub pagename ($) { #{{{
        return $page;
 } #}}}
 
        return $page;
 } #}}}
 

-sub htmlpage ($) { #{{{
+sub targetpage ($$) { #{{{

        my $page=shift;
        my $page=shift;

+       my $ext=shift;
+       
+       if (! $config{usedirs} || $page =~ /^index$/ ) {
+               return $page.".".$ext;
+       } else {
+               return $page."/index.".$ext;
+       }
+} #}}}

 
 

-       return $page.".html";
+sub htmlpage ($) { #{{{
+       my $page=shift;
+       
+       return targetpage($page, $config{htmlext});

 } #}}}
 
 sub srcfile ($) { #{{{
 } #}}}
 
 sub srcfile ($) { #{{{


@@ -234,7 +270,7 @@ sub srcfile ($) { #{{{
 
        return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
        return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
 
        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");
+       error("internal error: $file cannot be found in $config{srcdir} or $config{underlaydir}");

 } #}}}
 
 sub readfile ($;$$) { #{{{
 } #}}}
 
 sub readfile ($;$$) { #{{{


@@ -315,9 +351,13 @@ sub will_render ($$;$) { #{{{
                $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
        }
        else {
                $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
        }
        else {

+               foreach my $old (@{$renderedfiles{$page}}) {
+                       delete $destsources{$old};
+               }

                $renderedfiles{$page}=[$dest];
                $cleared{$page}=1;
        }
                $renderedfiles{$page}=[$dest];
                $cleared{$page}=1;
        }

+       $destsources{$dest}=$page;

 } #}}}
 
 sub bestlink ($$) { #{{{
 } #}}}
 
 sub bestlink ($$) { #{{{


@@ -343,8 +383,14 @@ sub bestlink ($$) { #{{{
                }
        } while $cwd=~s!/?[^/]+$!!;
 
                }
        } 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";
        }
 
        #print STDERR "warning: page $page, broken link: $link\n";


@@ -387,7 +433,7 @@ sub cgiurl (@) { #{{{
        my %params=@_;
 
        return $config{cgiurl}."?".
        my %params=@_;
 
        return $config{cgiurl}."?".

-               join("&amp;", map $_."=".uri_escape($params{$_}), keys %params);
+               join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);

 } #}}}
 
 sub baseurl (;$) { #{{{
 } #}}}
 
 sub baseurl (;$) { #{{{


@@ -395,6 +441,7 @@ sub baseurl (;$) { #{{{
 
        return "$config{url}/" if ! defined $page;
        
 
        return "$config{url}/" if ! defined $page;
        

+       $page=htmlpage($page);

        $page=~s/[^\/]+$//;
        $page=~s/[^\/]+\//..\//g;
        return $page;
        $page=~s/[^\/]+$//;
        $page=~s/[^\/]+\//..\//g;
        return $page;


@@ -416,14 +463,38 @@ sub abs2rel ($$) { #{{{
 sub displaytime ($) { #{{{
        my $time=shift;
 
 sub displaytime ($) { #{{{
        my $time=shift;
 

-       eval q{use POSIX};
-       error($@) if $@;

        # strftime doesn't know about encodings, so make sure
        # its output is properly treated as utf8
        return decode_utf8(POSIX::strftime(
                        $config{timeformat}, localtime($time)));
 } #}}}
 
        # strftime doesn't know about encodings, so make sure
        # its output is properly treated as utf8
        return decode_utf8(POSIX::strftime(
                        $config{timeformat}, localtime($time)));
 } #}}}
 

+sub beautify_url ($) { #{{{
+       my $url=shift;
+
+       $url =~ s!/index.$config{htmlext}$!/!;
+       $url =~ s!^$!./!; # Browsers don't like empty links...
+
+       return $url;
+} #}}}
+
+sub urlto ($$) { #{{{
+       my $to=shift;
+       my $from=shift;
+
+       if (! length $to) {
+               return beautify_url(baseurl($from));
+       }
+
+       if (! $destsources{$to}) {
+               $to=htmlpage($to);
+       }
+
+       my $link = abs2rel($to, dirname(htmlpage($from)));
+
+       return beautify_url($link);
+} #}}}
+

 sub htmllink ($$$;@) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
 sub htmllink ($$$;@) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)


@@ -449,21 +520,23 @@ sub htmllink ($$$;@) { #{{{
        return "<span class=\"selflink\">$linktext</span>"
                if length $bestlink && $page eq $bestlink;
        
        return "<span class=\"selflink\">$linktext</span>"
                if length $bestlink && $page eq $bestlink;
        

-       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
+       if (! $destsources{$bestlink}) {

                $bestlink=htmlpage($bestlink);
                $bestlink=htmlpage($bestlink);

-       }
-       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
-               return $linktext unless length $config{cgiurl};
-               return "<span><a href=\"".
-                       cgiurl(
-                               do => "create",
-                               page => pagetitle(lc($link), 1),
-                               from => $page
-                       ).
-                       "\">?</a>$linktext</span>"
+
+               if (! $destsources{$bestlink}) {
+                       return $linktext unless length $config{cgiurl};
+                       return "<span><a href=\"".
+                               cgiurl(
+                                       do => "create",
+                                       page => pagetitle(lc($link), 1),
+                                       from => $lpage
+                               ).
+                               "\">?</a>$linktext</span>"
+               }

        }
        
        }
        

-       $bestlink=abs2rel($bestlink, dirname($page));
+       $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
+       $bestlink=beautify_url($bestlink);

        
        if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";
        
        if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";


@@ -508,8 +581,14 @@ sub linkify ($$$) { #{{{
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
                defined $2
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
                defined $2

-                       ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, linkpage($3), anchor => $4, linktext => pagetitle($2)))
-                       : ( $1 ? "[[$3]]"    : htmllink($lpage, $page, linkpage($3), anchor => $4))
+                       ? ( $1 
+                               ? "[[$2|$3".($4 ? "#$4" : "")."]]" 
+                               : htmllink($lpage, $page, linkpage($3),
+                                       anchor => $4, linktext => pagetitle($2)))
+                       : ( $1 
+                               ? "[[$3".($4 ? "#$4" : "")."]]"
+                               : htmllink($lpage, $page, linkpage($3),
+                                       anchor => $4))

        }eg;
        
        return $content;
        }eg;
        
        return $content;


@@ -533,14 +612,24 @@ sub preprocess ($$$;$$) { #{{{
                my $command=shift;
                my $params=shift;
                if (length $escape) {
                my $command=shift;
                my $params=shift;
                if (length $escape) {

-                       return "[[$command $params]]";
+                       return "\\[[$command $params]]";

                }
                elsif (exists $hooks{preprocess}{$command}) {
                        return "" if $scan && ! $hooks{preprocess}{$command}{scan};
                        # Note: preserve order of params, some plugins may
                        # consider it significant.
                        my @params;
                }
                elsif (exists $hooks{preprocess}{$command}) {
                        return "" if $scan && ! $hooks{preprocess}{$command}{scan};
                        # 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) {
                                my $key=$1;
                                my $val;
                                if (defined $2) {


@@ -584,20 +673,42 @@ sub preprocess ($$$;$$) { #{{{
                        return $ret;
                }
                else {
                        return $ret;
                }
                else {

-                       return "[[$command $params]]";
+                       return "\\[[$command $params]]";

                }
        };
        
                }
        };
        

-       $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;
 } #}}}
 
        return $content;
 } #}}}
 

-sub filter ($$) { #{{{
+sub filter ($$$) { #{{{

        my $page=shift;
        my $page=shift;

+       my $destpage=shift;

        my $content=shift;
 
        run_hooks(filter => sub {
        my $content=shift;
 
        run_hooks(filter => sub {

-               $content=shift->(page => $page, content => $content);
+               $content=shift->(page => $page, destpage => $destpage, 
+                       content => $content);

        });
 
        return $content;
        });
 
        return $content;


@@ -607,7 +718,8 @@ sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
 
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
 

-sub lockwiki () { #{{{
+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}) {
        # 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}) {


@@ -616,15 +728,21 @@ sub lockwiki () { #{{{
        open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
                error ("cannot write to $config{wikistatedir}/lockfile: $!");
        if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB
        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 ($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 () { #{{{
 } #}}}
 
 sub unlockwiki () { #{{{


@@ -672,14 +790,15 @@ sub loadindex () { #{{{
                my $page=pagename($items{src}[0]);
                if (! $config{rebuild}) {
                        $pagesources{$page}=$items{src}[0];
                my $page=pagename($items{src}[0]);
                if (! $config{rebuild}) {
                        $pagesources{$page}=$items{src}[0];

-                       $oldpagemtime{$page}=$items{mtime}[0];
+                       $pagemtime{$page}=$items{mtime}[0];

                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
                        $depends{$page}=$items{depends}[0] if exists $items{depends};
                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
                        $depends{$page}=$items{depends}[0] if exists $items{depends};

+                       $destsources{$_}=$page foreach @{$items{dest}};

                        $renderedfiles{$page}=[@{$items{dest}}];
                        $renderedfiles{$page}=[@{$items{dest}}];

-                       $oldrenderedfiles{$page}=[@{$items{dest}}];

                        $pagecase{lc $page}=$page;
                }
                        $pagecase{lc $page}=$page;
                }

+               $oldrenderedfiles{$page}=[@{$items{dest}}];

                $pagectime{$page}=$items{ctime}[0];
        }
        close IN;
                $pagectime{$page}=$items{ctime}[0];
        }
        close IN;


@@ -694,9 +813,9 @@ sub saveindex () { #{{{
        my $newfile="$config{wikistatedir}/index.new";
        my $cleanup = sub { unlink($newfile) };
        open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup);
        my $newfile="$config{wikistatedir}/index.new";
        my $cleanup = sub { unlink($newfile) };
        open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup);

-       foreach my $page (keys %oldpagemtime) {
-               next unless $oldpagemtime{$page};
-               my $line="mtime=$oldpagemtime{$page} ".
+       foreach my $page (keys %pagemtime) {
+               next unless $pagemtime{$page};
+               my $line="mtime=$pagemtime{$page} ".

                        "ctime=$pagectime{$page} ".
                        "src=$pagesources{$page}";
                $line.=" dest=$_" foreach @{$renderedfiles{$page}};
                        "ctime=$pagectime{$page} ".
                        "src=$pagesources{$page}";
                $line.=" dest=$_" foreach @{$renderedfiles{$page}};


@@ -729,7 +848,6 @@ sub template_params (@) { #{{{
                return "";
        }
 
                return "";
        }
 

-       require HTML::Template;

        my @ret=(
                filter => sub {
                        my $text_ref = shift;
        my @ret=(
                filter => sub {
                        my $text_ref = shift;


@@ -744,6 +862,7 @@ sub template_params (@) { #{{{
 } #}}}
 
 sub template ($;@) { #{{{
 } #}}}
 
 sub template ($;@) { #{{{

+       require HTML::Template;

        HTML::Template->new(template_params(@_));
 } #}}}
 
        HTML::Template->new(template_params(@_));
 } #}}}
 


@@ -908,7 +1027,21 @@ sub pagespec_translate ($) { #{{{
 
        # Convert spec to perl code.
        my $code="";
 
        # 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.=" &&";
                my $word=$1;
                if (lc $word eq "and") {
                        $code.=" &&";


@@ -921,42 +1054,74 @@ sub pagespec_translate ($) { #{{{
                }
                elsif ($word =~ /^(\w+)\((.*)\)$/) {
                        if (exists $IkiWiki::PageSpec::{"match_$1"}) {
                }
                elsif ($word =~ /^(\w+)\((.*)\)$/) {
                        if (exists $IkiWiki::PageSpec::{"match_$1"}) {

-                               $code.=" IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).")";
+                               $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";

                        }
                        else {
                                $code.=" 0";
                        }
                }
                else {
                        }
                        else {
                                $code.=" 0";
                        }
                }
                else {

-                       $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";
+                       $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)";

                }
        }
 
        return $code;
 } #}}}
 
                }
        }
 
        return $code;
 } #}}}
 

-sub pagespec_match ($$;$) { #{{{
+sub pagespec_match ($$;@) { #{{{

        my $page=shift;
        my $spec=shift;
        my $page=shift;
        my $spec=shift;

-       my $from=shift;
+       my @params=@_;
+
+       # Backwards compatability with old calling convention.
+       if (@params == 1) {
+               unshift @params, "location";
+       }

 
 

-       return eval pagespec_translate($spec);
+       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 { #{{{
+       bless \$_[1], $_[0];
+} #}}}
+
+package IkiWiki::SuccessReason;
+
+use overload ( #{{{
+       '""'    => sub { ${$_[0]} },
+       '0+'    => sub { 1 },
+       '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
+       fallback => 1,
+); #}}}
+
+sub new { #{{{
+       bless \$_[1], $_[0];
+}; #}}}
+

 package IkiWiki::PageSpec;
 
 package IkiWiki::PageSpec;
 

-sub match_glob ($$$) { #{{{
+sub match_glob ($$;@) { #{{{

        my $page=shift;
        my $glob=shift;
        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!^\./!) {
        # relative matching
        if ($glob =~ m!^\./!) {

-               $from=~s!/?[^/]+$!!;
-               $glob=~s!^\./!!;
+               $from=~s#/?[^/]+$##;
+               $glob=~s#^\./##;

                $glob="$from/$glob" if length $from;
        }
 
                $glob="$from/$glob" if length $from;
        }
 


@@ -965,58 +1130,121 @@ sub match_glob ($$$) { #{{{
        $glob=~s/\\\*/.*/g;
        $glob=~s/\\\?/./g;
 
        $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 $page=shift;
        my $link=lc(shift);

+       my %params=@_;
+
+       my $from=exists $params{location} ? $params{location} : "";
+
+       # relative matching
+       if ($link =~ m!^\.! && defined $from) {
+               $from=~s#/?[^/]+$##;
+               $link=~s#^\./##;
+               $link="$from/$link" if length $from;
+       }

 
        my $links = $IkiWiki::links{$page} or return undef;
 
        my $links = $IkiWiki::links{$page} or return undef;

+       return IkiWiki::FailReason->new("$page has no links") unless @$links;
+       my $bestlink = IkiWiki::bestlink($from, $link);

        foreach my $p (@$links) {
        foreach my $p (@$links) {

-               return 1 if lc $p eq $link;
+               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(pop, pop);
+sub match_backlink ($$;@) { #{{{
+       match_link($_[1], $_[0], @_);

 } #}}}
 
 } #}}}
 

-sub match_created_before ($$) { #{{{
+sub match_created_before ($$;@) { #{{{

        my $page=shift;
        my $testpage=shift;
 
        if (exists $IkiWiki::pagectime{$testpage}) {
        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}) {
+                       IkiWiki::SuccessReason->new("$page created before $testpage");
+               }
+               else {
+                       IkiWiki::FailReason->new("$page not created before $testpage");
+               }

        }
        else {
        }
        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}) {
        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}) {
+                       IkiWiki::SuccessReason->new("$page created after $testpage");
+               }
+               else {
+                       IkiWiki::FailReason->new("$page not created after $testpage");
+               }

        }
        else {
        }
        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
 } #}}}
 
 1