]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
formatting
[git.ikiwiki.info.git] / IkiWiki.pm
index b605ac370ba6a84623887bf8e9087358ee40a0d5..b0ac8bbb4a1457496294f0d9644f3399044af1ec 100644 (file)
@@ -5,18 +5,24 @@ use warnings;
 use strict;
 use Encode;
 use HTML::Entities;
+use URI::Escape q{uri_escape_utf8};
+use POSIX;
 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
+           %pagestate %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
-                 displaytime will_render gettext
-                 %config %links %renderedfiles %pagesources);
-our $VERSION = 1.01; # plugin interface version
+                 displaytime will_render gettext urlto targetpage
+                add_underlay
+                 %config %links %pagestate %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;
@@ -24,20 +30,37 @@ memoize("abs2rel");
 memoize("pagespec_translate");
 memoize("file_pruned");
 
-my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
-our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
-
 sub defaultconfig () { #{{{
-       wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/,
-               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
-       wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
+       return
+       wiki_file_prune_regexps => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
+               qr/\.x?html?$/, qr/\.ikiwiki-new$/,
+               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
+               qr/(^|\/)_MTN\//,
+               qr/\.dpkg-tmp$/],
+       wiki_link_regexp => qr{
+               \[\[                    # beginning of link
+               (?:
+                       ([^\]\|\n\s]+)  # 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 => '',
        notify => 0,
        url => '',
@@ -62,18 +85,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 => 1,
+       numbacklinks => 10,
+       account_creation_password => "",
 } #}}}
-   
+
 sub checkconfig () { #{{{
        # locale stuff; avoid LC_ALL since it overrides everything
        if (defined $ENV{LC_ALL}) {
@@ -81,8 +109,6 @@ sub checkconfig () { #{{{
                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;
@@ -107,7 +133,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}: $@");
                }
@@ -116,18 +142,30 @@ sub checkconfig () { #{{{
                require IkiWiki::Rcs::Stub;
        }
 
+       if (exists $config{umask}) {
+               umask(possibly_foolish_untaint($config{umask}));
+       }
+
        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 ($) { #{{{
@@ -135,26 +173,41 @@ 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 ($) { #{{{
+sub error ($;$) { #{{{
+       my $message=shift;
+       my $cleaner=shift;
        if ($config{cgi}) {
                print "Content-type: text/html\n\n";
                print misctemplate(gettext("Error"),
-                       "<p>".gettext("Error").": @_</p>");
+                       "<p>".gettext("Error").": $message</p>");
+       }
+       log_message('err' => $message) if $config{syslog};
+       if (defined $cleaner) {
+               $cleaner->();
        }
-       log_message(error => @_);
-       exit(1);
+       die $message."\n";
 } #}}}
 
 sub debug ($) { #{{{
        return unless $config{verbose};
-       log_message(debug => @_);
+       return log_message(debug => @_);
 } #}}}
 
 my $log_open=0;
@@ -163,26 +216,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, 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;
 } #}}}
 
@@ -206,7 +259,7 @@ sub pagetype ($) { #{{{
        if ($page =~ /\.([^.]+)$/) {
                return $1 if exists $hooks{htmlize}{$1};
        }
-       return undef;
+       return;
 } #}}}
 
 sub pagename ($) { #{{{
@@ -218,18 +271,45 @@ sub pagename ($) { #{{{
        return $page;
 } #}}}
 
-sub htmlpage ($) { #{{{
+sub targetpage ($$) { #{{{
        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 ($) { #{{{
        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");
+       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 ($;$$) { #{{{
@@ -242,11 +322,11 @@ sub readfile ($;$$) { #{{{
        }
        
        local $/=undef;
-       open (IN, $file) || error("failed to read $file: $!");
-       binmode(IN) if ($binary);
-       return \*IN if $wantfd;
-       my $ret=<IN>;
-       close IN;
+       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;
 } #}}}
 
@@ -255,7 +335,7 @@ sub writefile ($$$;$$) { #{{{
        my $destdir=shift; # directory to put file in
        my $content=shift;
        my $binary=shift;
-       my $wantfd=shift;
+       my $writer=shift;
        
        my $test=$file;
        while (length $test) {
@@ -264,8 +344,12 @@ sub writefile ($$$;$$) { #{{{
                }
                $test=dirname($test);
        }
+       my $newfile="$destdir/$file.ikiwiki-new";
+       if (-l $newfile) {
+               error("cannot write to a symlink ($newfile)");
+       }
 
-       my $dir=dirname("$destdir/$file");
+       my $dir=dirname($newfile);
        if (! -d $dir) {
                my $d="";
                foreach my $s (split(m!/+!, $dir)) {
@@ -275,12 +359,21 @@ sub writefile ($$$;$$) { #{{{
                        }
                }
        }
-       
-       open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
-       binmode(OUT) if ($binary);
-       return \*OUT if $wantfd;
-       print OUT $content;
-       close OUT;
+
+       my $cleanup = sub { unlink($newfile) };
+       open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
+       binmode($out) if ($binary);
+       if ($writer) {
+               $writer->(\*$out, $cleanup);
+       }
+       else {
+               print $out $content or error("failed writing to $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;
@@ -299,9 +392,15 @@ sub will_render ($$;$) { #{{{
                $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
        }
        else {
+               foreach my $old (@{$renderedfiles{$page}}) {
+                       delete $destsources{$old};
+               }
                $renderedfiles{$page}=[$dest];
                $cleared{$page}=1;
        }
+       $destsources{$dest}=$page;
+
+       return 1;
 } #}}}
 
 sub bestlink ($$) { #{{{
@@ -313,6 +412,7 @@ sub bestlink ($$) { #{{{
                # absolute links
                $cwd="";
        }
+       $link=~s/\/$//;
 
        do {
                my $l=$cwd;
@@ -327,8 +427,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";
@@ -338,7 +444,7 @@ sub bestlink ($$) { #{{{
 sub isinlinableimage ($) { #{{{
        my $file=shift;
        
-       $file=~/\.(png|gif|jpg|jpeg)$/i;
+       return $file =~ /\.(png|gif|jpg|jpeg)$/i;
 } #}}}
 
 sub pagetitle ($;$) { #{{{
@@ -346,27 +452,32 @@ sub pagetitle ($;$) { #{{{
        my $unescaped=shift;
 
        if ($unescaped) {
-               $page=~s/__(\d+)__/chr($1)/eg;
+               $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
        }
        else {
-               $page=~s/__(\d+)__/&#$1;/g;
+               $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
        }
-       $page=~y/_/ /;
 
        return $page;
 } #}}}
 
 sub titlepage ($) { #{{{
        my $title=shift;
-       $title=~y/ /_/;
-       $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
+       $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
        return $title;
 } #}}}
 
+sub linkpage ($) { #{{{
+       my $link=shift;
+       $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
+       return $link;
+} #}}}
+
 sub cgiurl (@) { #{{{
        my %params=@_;
 
-       return $config{cgiurl}."?".join("&amp;", map "$_=$params{$_}", keys %params);
+       return $config{cgiurl}."?".
+               join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
 } #}}}
 
 sub baseurl (;$) { #{{{
@@ -374,6 +485,7 @@ sub baseurl (;$) { #{{{
 
        return "$config{url}/" if ! defined $page;
        
+       $page=htmlpage($page);
        $page=~s/[^\/]+$//;
        $page=~s/[^\/]+\//..\//g;
        return $page;
@@ -392,54 +504,109 @@ sub abs2rel ($$) { #{{{
        return $ret;
 } #}}}
 
-sub displaytime ($) { #{{{
+sub displaytime ($;$) { #{{{
        my $time=shift;
+       my $format=shift;
+       if (! defined $format) {
+               $format=$config{timeformat};
+       }
 
-       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)));
+       return decode_utf8(POSIX::strftime($format, localtime($time)));
+} #}}}
+
+sub beautify_url ($) { #{{{
+       my $url=shift;
+
+       if ($config{usedirs}) {
+               $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 ($$$;$$$) { #{{{
+sub htmllink ($$$;@) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
        my $link=shift;
-       my $noimageinline=shift; # don't turn links into inline html images
-       my $forcesubpage=shift; # force a link to a subpage
-       my $linktext=shift; # set to force the link text to something
+       my %opts=@_;
+
+       $link=~s/\/$//;
 
        my $bestlink;
-       if (! $forcesubpage) {
+       if (! $opts{forcesubpage}) {
                $bestlink=bestlink($lpage, $link);
        }
        else {
                $bestlink="$lpage/".lc($link);
        }
 
-       $linktext=pagetitle(basename($link)) unless defined $linktext;
+       my $linktext;
+       if (defined $opts{linktext}) {
+               $linktext=$opts{linktext};
+       }
+       else {
+               $linktext=pagetitle(basename($link));
+       }
        
        return "<span class=\"selflink\">$linktext</span>"
-               if length $bestlink && $page eq $bestlink;
+               if length $bestlink && $page eq $bestlink &&
+                  ! defined $opts{anchor};
        
-       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
+       if (! $destsources{$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 => lc($link), from => $page).
-                       "\">?</a>$linktext</span>"
+
+               if (! $destsources{$bestlink}) {
+                       return $linktext unless length $config{cgiurl};
+                       return "<span class=\"createlink\"><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 (! $noimageinline && isinlinableimage($bestlink)) {
+       if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";
        }
-       return "<a href=\"$bestlink\">$linktext</a>";
+
+       if (defined $opts{anchor}) {
+               $bestlink.="#".$opts{anchor};
+       }
+
+       my @attrs;
+       if (defined $opts{rel}) {
+               push @attrs, ' rel="'.$opts{rel}.'"';
+       }
+       if (defined $opts{class}) {
+               push @attrs, ' class="'.$opts{class}.'"';
+       }
+
+       return "<a href=\"$bestlink\"@attrs>$linktext</a>";
 } #}}}
 
 sub htmlize ($$$) { #{{{
@@ -473,19 +640,32 @@ sub linkify ($$$) { #{{{
        my $content=shift;
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
-               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
-                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
+               defined $2
+                       ? ( $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;
 } #}}}
 
 my %preprocessing;
-sub preprocess ($$$;$) { #{{{
+our $preprocess_preview=0;
+sub preprocess ($$$;$$) { #{{{
        my $page=shift; # the page the data comes from
        my $destpage=shift; # the page the data will appear in (different for inline)
        my $content=shift;
        my $scan=shift;
+       my $preview=shift;
+
+       # Using local because it needs to be set within any nested calls
+       # of this function.
+       local $preprocess_preview=$preview if defined $preview;
 
        my $handle=sub {
                my $escape=shift;
@@ -499,7 +679,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) {
@@ -537,6 +727,7 @@ sub preprocess ($$$;$) { #{{{
                                @params,
                                page => $page,
                                destpage => $destpage,
+                               preview => $preprocess_preview,
                        );
                        $preprocessing{$page}--;
                        return $ret;
@@ -546,16 +737,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;
@@ -565,33 +778,75 @@ sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
 
-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)) {
-               debug("wiki seems to be locked, waiting for lock");
-               my $wait=600; # arbitrary, but don't hang forever to 
-                             # prevent process pileup
-               for (1..600) {
-                       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) || error("failed closing commitlock: $!");
+               return 0;
+       }
+       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
+               error("failed to get commit lock");
+       }
+       return 1;
+} #}}}
+
+sub enable_commit_hook () { #{{{
+       return close($commitlock) if $commitlock;
+       return;
 } #}}}
 
 sub loadindex () { #{{{
-       open (IN, "$config{wikistatedir}/index") || return;
-       while (<IN>) {
+       %oldrenderedfiles=%pagectime=();
+       if (! $config{rebuild}) {
+               %pagesources=%pagemtime=%oldlinks=%links=%depends=
+                       %destsources=%renderedfiles=%pagecase=();
+       }
+       open (my $in, "<", "$config{wikistatedir}/index") || return;
+       while (<$in>) {
                $_=possibly_foolish_untaint($_);
                chomp;
                my %items;
@@ -607,30 +862,42 @@ sub loadindex () { #{{{
                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};
+                       $destsources{$_}=$page foreach @{$items{dest}};
                        $renderedfiles{$page}=[@{$items{dest}}];
-                       $oldrenderedfiles{$page}=[@{$items{dest}}];
                        $pagecase{lc $page}=$page;
+                       foreach my $k (grep /_/, keys %items) {
+                               my ($id, $key)=split(/_/, $k, 2);
+                               $pagestate{$page}{decode_entities($id)}{decode_entities($key)}=$items{$k}[0];
+                       }
                }
+               $oldrenderedfiles{$page}=[@{$items{dest}}];
                $pagectime{$page}=$items{ctime}[0];
        }
-       close IN;
+       return close($in);
 } #}}}
 
 sub saveindex () { #{{{
        run_hooks(savestate => sub { shift->() });
 
+       my %hookids;
+       foreach my $type (keys %hooks) {
+               $hookids{encode_entities($_)}=1 foreach keys %{$hooks{$type}};
+       }
+       my @hookids=sort keys %hookids;
+
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }
-       open (OUT, ">$config{wikistatedir}/index") || 
-               error("cannot write to $config{wikistatedir}/index: $!");
-       foreach my $page (keys %oldpagemtime) {
-               next unless $oldpagemtime{$page};
-               my $line="mtime=$oldpagemtime{$page} ".
+       my $newfile="$config{wikistatedir}/index.new";
+       my $cleanup = sub { unlink($newfile) };
+       open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
+       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}};
@@ -639,9 +906,20 @@ sub saveindex () { #{{{
                if (exists $depends{$page}) {
                        $line.=" depends=".encode_entities($depends{$page}, " \t\n");
                }
-               print OUT $line."\n";
+               if (exists $pagestate{$page}) {
+                       foreach my $id (@hookids) {
+                               foreach my $key (keys %{$pagestate{$page}{$id}}) {
+                                       $line.=' '.$id.'_'.encode_entities($key)."=".encode_entities($pagestate{$page}{$id}{$key});
+                               }
+                       }
+               }
+               print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup);
        }
-       close OUT;
+       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 ($) { #{{{
@@ -650,7 +928,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 (@) { #{{{
@@ -661,11 +939,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} = decode_utf8(${$text_ref});
                },
                filename => $filename,
                loop_context_vars => 1,
@@ -676,7 +953,8 @@ sub template_params (@) { #{{{
 } #}}}
 
 sub template ($;@) { #{{{
-       HTML::Template->new(template_params(@_));
+       require HTML::Template;
+       return HTML::Template->new(template_params(@_));
 } #}}}
 
 sub misctemplate ($$;@) { #{{{
@@ -702,12 +980,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 ($$) { # {{{
@@ -729,6 +1008,8 @@ sub run_hooks ($$) { # {{{
                        $sub->($hooks{$type}{$id}{call});
                }
        }
+
+       return 1;
 } #}}}
 
 sub globlist_to_pagespec ($) { #{{{
@@ -744,9 +1025,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)";
                }
@@ -759,7 +1040,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 ($) { #{{{
@@ -778,21 +1059,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/ && $file ne $base;
 } #}}}
 
 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};
@@ -840,55 +1125,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).")";
+                               $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=@_;
+
+       # 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;
 
-       return eval pagespec_translate($spec);
+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;
        }
 
@@ -897,58 +1228,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 %params=@_;
+
+       my $from=exists $params{location} ? $params{location} : '';
 
-       my $links = $IkiWiki::links{$page} or return undef;
-       foreach my $p (@$links) {
-               return 1 if lc $p eq $link;
+       # relative matching
+       if ($link =~ m!^\.! && defined $from) {
+               $from=~s#/?[^/]+$##;
+               $link=~s#^\./##;
+               $link="$from/$link" if length $from;
+       }
+
+       my $links = $IkiWiki::links{$page};
+       return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
+       my $bestlink = IkiWiki::bestlink($from, $link);
+       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 $p 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 ($$;@) { #{{{
+       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 ($$;@) { #{{{
+       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_day ($$) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[3] == 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_month ($$) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
+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