]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
it falls back to using install
[git.ikiwiki.info.git] / IkiWiki.pm
index 4e4da11c5a016daa9d04c0b6ee04df7f786a14a7..e509a7c2f4202cc6016d8b294a02db9c8d34426a 100644 (file)
@@ -12,18 +12,19 @@ use Storable;
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
-           %pagestate %renderedfiles %oldrenderedfiles %pagesources
-           %destsources %depends %hooks %forcerebuild $gettext_obj
-           %loaded_plugins};
+           %pagestate %wikistate %renderedfiles %oldrenderedfiles
+           %pagesources %destsources %depends %hooks %forcerebuild
+           $gettext_obj %loaded_plugins};
 
 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 %pagestate %renderedfiles
+                add_underlay pagetitle titlepage linkpage newpagefile
+                inject
+                 %config %links %pagestate %wikistate %renderedfiles
                  %pagesources %destsources);
-our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
+our $VERSION = 3.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
 
@@ -33,7 +34,7 @@ memoize("abs2rel");
 memoize("pagespec_translate");
 memoize("file_pruned");
 
-sub getsetup () { #{{{
+sub getsetup () {
        wikiname => {
                type => "string",
                default => "wiki",
@@ -99,7 +100,7 @@ sub getsetup () { #{{{
                type => "string",
                default => '',
                example => "/var/www/wiki/ikiwiki.cgi",
-               description => "cgi wrapper to generate",
+               description => "filename of cgi wrapper to generate",
                safe => 0, # file
                rebuild => 0,
        },
@@ -119,7 +120,7 @@ sub getsetup () { #{{{
        },
        default_plugins => {
                type => "internal",
-               default => [qw{mdwn link inline htmlscrubber passwordauth
+               default => [qw{mdwn link inline meta htmlscrubber passwordauth
                                openid signinedit lockedit conditional
                                recentchanges parentlinks editpage}],
                description => "plugins to enable by default",
@@ -193,11 +194,18 @@ sub getsetup () { #{{{
        },
        prefix_directives => {
                type => "boolean",
-               default => 0,
+               default => 1,
                description => "use '!'-prefixed preprocessor directives?",
                safe => 0, # changing requires manual transition
                rebuild => 1,
        },
+       indexpages => {
+               type => "boolean",
+               default => 0,
+               description => "use page/index.mdwn source files",
+               safe => 1,
+               rebuild => 1,
+       },
        discussion => {
                type => "boolean",
                default => 1,
@@ -269,13 +277,20 @@ sub getsetup () { #{{{
        },
        umask => {
                type => "integer",
-               description => "",
                example => "022",
                description => "force ikiwiki to use a particular umask",
                advanced => 1,
                safe => 0, # paranoia
                rebuild => 0,
        },
+       wrappergroup => {
+               type => "string",
+               example => "ikiwiki",
+               description => "group for wrappers to run in",
+               advanced => 1,
+               safe => 0, # paranoia
+               rebuild => 0,
+       },
        libdir => {
                type => "string",
                default => "",
@@ -374,6 +389,13 @@ sub getsetup () { #{{{
                safe => 0,
                rebuild => 0,
        },
+       test_receive => {
+               type => "internal",
+               default => 0,
+               description => "running in receive test mode",
+               safe => 0,
+               rebuild => 0,
+       },
        getctime => {
                type => "internal",
                default => 0,
@@ -388,6 +410,13 @@ sub getsetup () { #{{{
                safe => 0,
                rebuild => 0,
        },
+       wikistatedir => {
+               type => "internal",
+               default => undef,
+               description => "path to the .ikiwiki directory holding ikiwiki state",
+               safe => 0,
+               rebuild => 0,
+       },
        setupfile => {
                type => "internal",
                default => undef,
@@ -396,15 +425,15 @@ sub getsetup () { #{{{
                rebuild => 0,
        },
        allow_symlinks_before_srcdir => {
-               type => "string",
+               type => "boolean",
                default => 0,
                description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
                safe => 0,
                rebuild => 0,
        },
-} #}}}
+}
 
-sub defaultconfig () { #{{{
+sub defaultconfig () {
        my %s=getsetup();
        my @ret;
        foreach my $key (keys %s) {
@@ -412,9 +441,9 @@ sub defaultconfig () { #{{{
        }
        use Data::Dumper;
        return @ret;
-} #}}}
+}
 
-sub checkconfig () { #{{{
+sub checkconfig () {
        # locale stuff; avoid LC_ALL since it overrides everything
        if (defined $ENV{LC_ALL}) {
                $ENV{LANG} = $ENV{LC_ALL};
@@ -452,7 +481,7 @@ sub checkconfig () { #{{{
        }
        
        $config{wikistatedir}="$config{srcdir}/.ikiwiki"
-               unless exists $config{wikistatedir};
+               unless exists $config{wikistatedir} && defined $config{wikistatedir};
 
        if (defined $config{umask}) {
                umask(possibly_foolish_untaint($config{umask}));
@@ -461,9 +490,9 @@ sub checkconfig () { #{{{
        run_hooks(checkconfig => sub { shift->() });
 
        return 1;
-} #}}}
+}
 
-sub listplugins () { #{{{
+sub listplugins () {
        my %ret;
 
        foreach my $dir (@INC, $config{libdir}) {
@@ -481,9 +510,9 @@ sub listplugins () { #{{{
        }
 
        return keys %ret;
-} #}}}
+}
 
-sub loadplugins () { #{{{
+sub loadplugins () {
        if (defined $config{libdir} && length $config{libdir}) {
                unshift @INC, possibly_foolish_untaint($config{libdir});
        }
@@ -510,9 +539,9 @@ sub loadplugins () { #{{{
        }
 
        return 1;
-} #}}}
+}
 
-sub loadplugin ($) { #{{{
+sub loadplugin ($) {
        my $plugin=shift;
 
        return if grep { $_ eq $plugin} @{$config{disable_plugins}};
@@ -538,9 +567,9 @@ sub loadplugin ($) { #{{{
        }
        $loaded_plugins{$plugin}=1;
        return 1;
-} #}}}
+}
 
-sub error ($;$) { #{{{
+sub error ($;$) {
        my $message=shift;
        my $cleaner=shift;
        log_message('err' => $message) if $config{syslog};
@@ -548,15 +577,15 @@ sub error ($;$) { #{{{
                $cleaner->();
        }
        die $message."\n";
-} #}}}
+}
 
-sub debug ($) { #{{{
+sub debug ($) {
        return unless $config{verbose};
        return log_message(debug => @_);
-} #}}}
+}
 
 my $log_open=0;
-sub log_message ($$) { #{{{
+sub log_message ($$) {
        my $type=shift;
 
        if ($config{syslog}) {
@@ -576,70 +605,90 @@ sub log_message ($$) { #{{{
        else {
                return print STDERR "@_\n";
        }
-} #}}}
+}
 
-sub possibly_foolish_untaint ($) { #{{{
+sub possibly_foolish_untaint ($) {
        my $tainted=shift;
        my ($untainted)=$tainted=~/(.*)/s;
        return $untainted;
-} #}}}
+}
 
-sub basename ($) { #{{{
+sub basename ($) {
        my $file=shift;
 
        $file=~s!.*/+!!;
        return $file;
-} #}}}
+}
 
-sub dirname ($) { #{{{
+sub dirname ($) {
        my $file=shift;
 
        $file=~s!/*[^/]+$!!;
        return $file;
-} #}}}
+}
 
-sub pagetype ($) { #{{{
+sub pagetype ($) {
        my $page=shift;
        
        if ($page =~ /\.([^.]+)$/) {
                return $1 if exists $hooks{htmlize}{$1};
        }
        return;
-} #}}}
+}
 
-sub isinternal ($) { #{{{
+sub isinternal ($) {
        my $page=shift;
        return exists $pagesources{$page} &&
                $pagesources{$page} =~ /\._([^.]+)$/;
-} #}}}
+}
 
-sub pagename ($) { #{{{
+sub pagename ($) {
        my $file=shift;
 
        my $type=pagetype($file);
        my $page=$file;
-       $page=~s/\Q.$type\E*$// if defined $type;
+       $page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
+       if ($config{indexpages} && $page=~/(.*)\/index$/) {
+               $page=$1;
+       }
        return $page;
-} #}}}
+}
+
+sub newpagefile ($$) {
+       my $page=shift;
+       my $type=shift;
+
+       if (! $config{indexpages} || $page eq 'index') {
+               return $page.".".$type;
+       }
+       else {
+               return $page."/index.".$type;
+       }
+}
 
-sub targetpage ($$) { #{{{
+sub targetpage ($$;$) {
        my $page=shift;
        my $ext=shift;
+       my $filename=shift;
        
-       if (! $config{usedirs} || $page =~ /^index$/ ) {
+       if (defined $filename) {
+               return $page."/".$filename.".".$ext;
+       }
+       elsif (! $config{usedirs} || $page eq 'index') {
                return $page.".".$ext;
-       } else {
+       }
+       else {
                return $page."/index.".$ext;
        }
-} #}}}
+}
 
-sub htmlpage ($) { #{{{
+sub htmlpage ($) {
        my $page=shift;
        
        return targetpage($page, $config{htmlext});
-} #}}}
+}
 
-sub srcfile_stat { #{{{
+sub srcfile_stat {
        my $file=shift;
        my $nothrow=shift;
 
@@ -649,26 +698,27 @@ sub srcfile_stat { #{{{
        }
        error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
        return;
-} #}}}
+}
 
-sub srcfile ($;$) { #{{{
+sub srcfile ($;$) {
        return (srcfile_stat(@_))[0];
-} #}}}
+}
 
-sub add_underlay ($) { #{{{
+sub add_underlay ($) {
        my $dir=shift;
 
-       if ($dir=~/^\//) {
-               unshift @{$config{underlaydirs}}, $dir;
+       if ($dir !~ /^\//) {
+               $dir="$config{underlaydir}/../$dir";
        }
-       else {
-               unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
+
+       if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
+               unshift @{$config{underlaydirs}}, $dir;
        }
 
        return 1;
-} #}}}
+}
 
-sub readfile ($;$$) { #{{{
+sub readfile ($;$$) {
        my $file=shift;
        my $binary=shift;
        my $wantfd=shift;
@@ -682,11 +732,15 @@ sub readfile ($;$$) { #{{{
        binmode($in) if ($binary);
        return \*$in if $wantfd;
        my $ret=<$in>;
+       # check for invalid utf-8, and toss it back to avoid crashes
+       if (! utf8::valid($ret)) {
+               $ret=encode_utf8($ret);
+       }
        close $in || error("failed to read $file: $!");
        return $ret;
-} #}}}
+}
 
-sub prep_writefile ($$) { #{{{
+sub prep_writefile ($$) {
        my $file=shift;
        my $destdir=shift;
        
@@ -710,9 +764,9 @@ sub prep_writefile ($$) { #{{{
        }
 
        return 1;
-} #}}}
+}
 
-sub writefile ($$$;$$) { #{{{
+sub writefile ($$$;$$) {
        my $file=shift; # can include subdirs
        my $destdir=shift; # directory to put file in
        my $content=shift;
@@ -740,17 +794,17 @@ sub writefile ($$$;$$) { #{{{
                error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
 
        return 1;
-} #}}}
+}
 
 my %cleared;
-sub will_render ($$;$) { #{{{
+sub will_render ($$;$) {
        my $page=shift;
        my $dest=shift;
        my $clear=shift;
 
        # Important security check.
        if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
-           ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
+           ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
                error("$config{destdir}/$dest independently created, not overwriting with version from $page");
        }
 
@@ -767,9 +821,9 @@ sub will_render ($$;$) { #{{{
        $destsources{$dest}=$page;
 
        return 1;
-} #}}}
+}
 
-sub bestlink ($$) { #{{{
+sub bestlink ($$) {
        my $page=shift;
        my $link=shift;
        
@@ -805,15 +859,15 @@ sub bestlink ($$) { #{{{
 
        #print STDERR "warning: page $page, broken link: $link\n";
        return "";
-} #}}}
+}
 
-sub isinlinableimage ($) { #{{{
+sub isinlinableimage ($) {
        my $file=shift;
        
        return $file =~ /\.(png|gif|jpg|jpeg)$/i;
-} #}}}
+}
 
-sub pagetitle ($;$) { #{{{
+sub pagetitle ($;$) {
        my $page=shift;
        my $unescaped=shift;
 
@@ -825,31 +879,31 @@ sub pagetitle ($;$) { #{{{
        }
 
        return $page;
-} #}}}
+}
 
-sub titlepage ($) { #{{{
+sub titlepage ($) {
        my $title=shift;
        # support use w/o %config set
        my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
        $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
        return $title;
-} #}}}
+}
 
-sub linkpage ($) { #{{{
+sub linkpage ($) {
        my $link=shift;
        my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
        $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
        return $link;
-} #}}}
+}
 
-sub cgiurl (@) { #{{{
+sub cgiurl (@) {
        my %params=@_;
 
        return $config{cgiurl}."?".
                join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
-} #}}}
+}
 
-sub baseurl (;$) { #{{{
+sub baseurl (;$) {
        my $page=shift;
 
        return "$config{url}/" if ! defined $page;
@@ -858,9 +912,9 @@ sub baseurl (;$) { #{{{
        $page=~s/[^\/]+$//;
        $page=~s/[^\/]+\//..\//g;
        return $page;
-} #}}}
+}
 
-sub abs2rel ($$) { #{{{
+sub abs2rel ($$) {
        # Work around very innefficient behavior in File::Spec if abs2rel
        # is passed two relative paths. It's much faster if paths are
        # absolute! (Debian bug #376658; fixed in debian unstable now)
@@ -871,9 +925,16 @@ sub abs2rel ($$) { #{{{
        my $ret=File::Spec->abs2rel($path, $base);
        $ret=~s/^// if defined $ret;
        return $ret;
-} #}}}
+}
+
+sub displaytime ($;$) {
+       # Plugins can override this function to mark up the time to
+       # display.
+       return '<span class="date">'.formattime(@_).'</span>';
+}
 
-sub displaytime ($;$) { #{{{
+sub formattime ($;$) {
+       # Plugins can override this function to format the time.
        my $time=shift;
        my $format=shift;
        if (! defined $format) {
@@ -883,25 +944,25 @@ sub displaytime ($;$) { #{{{
        # strftime doesn't know about encodings, so make sure
        # its output is properly treated as utf8
        return decode_utf8(POSIX::strftime($format, localtime($time)));
-} #}}}
+}
 
-sub beautify_urlpath ($) { #{{{
+sub beautify_urlpath ($) {
        my $url=shift;
 
-       if ($config{usedirs}) {
-               $url =~ s!/index.$config{htmlext}$!/!;
+       # Ensure url is not an empty link, and if necessary,
+       # add ./ to avoid colon confusion.
+       if ($url !~ /^\// && $url !~ /^\.\.?\//) {
+               $url="./$url";
        }
 
-       # Ensure url is not an empty link, and
-       # if it's relative, make that explicit to avoid colon confusion.
-       if ($url !~ /^\//) {
-               $url="./$url";
+       if ($config{usedirs}) {
+               $url =~ s!/index.$config{htmlext}$!/!;
        }
 
        return $url;
-} #}}}
+}
 
-sub urlto ($$;$) { #{{{
+sub urlto ($$;$) {
        my $to=shift;
        my $from=shift;
        my $absolute=shift;
@@ -921,9 +982,9 @@ sub urlto ($$;$) { #{{{
        my $link = abs2rel($to, dirname(htmlpage($from)));
 
        return beautify_urlpath($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;
@@ -986,9 +1047,9 @@ sub htmllink ($$$;@) { #{{{
        }
 
        return "<a href=\"$bestlink\"@attrs>$linktext</a>";
-} #}}}
+}
 
-sub userlink ($) { #{{{
+sub userlink ($) {
        my $user=shift;
 
        my $oiduser=eval { openiduser($user) };
@@ -1003,9 +1064,9 @@ sub userlink ($) { #{{{
                        length $config{userdir} ? $config{userdir}."/".$user : $user
                ), noimageinline => 1);
        }
-} #}}}
+}
 
-sub htmlize ($$$$) { #{{{
+sub htmlize ($$$$) {
        my $page=shift;
        my $destpage=shift;
        my $type=shift;
@@ -1040,9 +1101,9 @@ sub htmlize ($$$$) { #{{{
        }
 
        return $content;
-} #}}}
+}
 
-sub linkify ($$$) { #{{{
+sub linkify ($$$) {
        my $page=shift;
        my $destpage=shift;
        my $content=shift;
@@ -1056,11 +1117,11 @@ sub linkify ($$$) { #{{{
        });
        
        return $content;
-} #}}}
+}
 
 our %preprocessing;
 our $preprocess_preview=0;
-sub preprocess ($$$;$$) { #{{{
+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;
@@ -1213,9 +1274,9 @@ sub preprocess ($$$;$$) { #{{{
 
        $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
        return $content;
-} #}}}
+}
 
-sub filter ($$$) { #{{{
+sub filter ($$$) {
        my $page=shift;
        my $destpage=shift;
        my $content=shift;
@@ -1226,16 +1287,15 @@ sub filter ($$$) { #{{{
        });
 
        return $content;
-} #}}}
+}
 
-sub indexlink () { #{{{
+sub indexlink () {
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
-} #}}}
+}
 
 my $wikilock;
 
-sub lockwiki (;$) { #{{{
-       my $wait=@_ ? shift : 1;
+sub lockwiki () {
        # 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}) {
@@ -1243,32 +1303,21 @@ sub lockwiki (;$) { #{{{
        }
        open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
                error ("cannot write to $config{wikistatedir}/lockfile: $!");
-       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;
-               }
+       if (! flock($wikilock, 2)) { # LOCK_EX
+               error("failed to get lock");
        }
        return 1;
-} #}}}
+}
 
-sub unlockwiki () { #{{{
+sub unlockwiki () {
+       POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
        return close($wikilock) if $wikilock;
        return;
-} #}}}
+}
 
 my $commitlock;
 
-sub commit_hook_enabled () { #{{{
+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
@@ -1277,23 +1326,23 @@ sub commit_hook_enabled () { #{{{
        }
        close($commitlock) || error("failed closing commitlock: $!");
        return 1;
-} #}}}
+}
 
-sub disable_commit_hook () { #{{{
+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 () { #{{{
+sub enable_commit_hook () {
        return close($commitlock) if $commitlock;
        return;
-} #}}}
+}
 
-sub loadindex () { #{{{
+sub loadindex () {
        %oldrenderedfiles=%pagectime=();
        if (! $config{rebuild}) {
                %pagesources=%pagemtime=%oldlinks=%links=%depends=
@@ -1309,31 +1358,42 @@ sub loadindex () { #{{{
                        return;
                }
        }
-       my $ret=Storable::fd_retrieve($in);
-       if (! defined $ret) {
+
+       my $index=Storable::fd_retrieve($in);
+       if (! defined $index) {
                return 0;
        }
-       my %index=%$ret;
-       foreach my $src (keys %index) {
-               my %d=%{$index{$src}};
+
+       my $pages;
+       if (exists $index->{version} && ! ref $index->{version}) {
+               $pages=$index->{page};
+               %wikistate=%{$index->{state}};
+       }
+       else {
+               $pages=$index;
+               %wikistate=();
+       }
+
+       foreach my $src (keys %$pages) {
+               my $d=$pages->{$src};
                my $page=pagename($src);
-               $pagectime{$page}=$d{ctime};
+               $pagectime{$page}=$d->{ctime};
                if (! $config{rebuild}) {
                        $pagesources{$page}=$src;
-                       $pagemtime{$page}=$d{mtime};
-                       $renderedfiles{$page}=$d{dest};
-                       if (exists $d{links} && ref $d{links}) {
-                               $links{$page}=$d{links};
-                               $oldlinks{$page}=[@{$d{links}}];
+                       $pagemtime{$page}=$d->{mtime};
+                       $renderedfiles{$page}=$d->{dest};
+                       if (exists $d->{links} && ref $d->{links}) {
+                               $links{$page}=$d->{links};
+                               $oldlinks{$page}=[@{$d->{links}}];
                        }
-                       if (exists $d{depends}) {
-                               $depends{$page}=$d{depends};
+                       if (exists $d->{depends}) {
+                               $depends{$page}=$d->{depends};
                        }
-                       if (exists $d{state}) {
-                               $pagestate{$page}=$d{state};
+                       if (exists $d->{state}) {
+                               $pagestate{$page}=$d->{state};
                        }
                }
-               $oldrenderedfiles{$page}=[@{$d{dest}}];
+               $oldrenderedfiles{$page}=[@{$d->{dest}}];
        }
        foreach my $page (keys %pagesources) {
                $pagecase{lc $page}=$page;
@@ -1342,9 +1402,9 @@ sub loadindex () { #{{{
                $destsources{$_}=$page foreach @{$renderedfiles{$page}};
        }
        return close($in);
-} #}}}
+}
 
-sub saveindex () { #{{{
+sub saveindex () {
        run_hooks(savestate => sub { shift->() });
 
        my %hookids;
@@ -1359,12 +1419,13 @@ sub saveindex () { #{{{
        my $newfile="$config{wikistatedir}/indexdb.new";
        my $cleanup = sub { unlink($newfile) };
        open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
+
        my %index;
        foreach my $page (keys %pagemtime) {
                next unless $pagemtime{$page};
                my $src=$pagesources{$page};
 
-               $index{$src}={
+               $index{page}{$src}={
                        ctime => $pagectime{$page},
                        mtime => $pagemtime{$page},
                        dest => $renderedfiles{$page},
@@ -1372,17 +1433,26 @@ sub saveindex () { #{{{
                };
 
                if (exists $depends{$page}) {
-                       $index{$src}{depends} = $depends{$page};
+                       $index{page}{$src}{depends} = $depends{$page};
                }
 
                if (exists $pagestate{$page}) {
                        foreach my $id (@hookids) {
                                foreach my $key (keys %{$pagestate{$page}{$id}}) {
-                                       $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
+                                       $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
                                }
                        }
                }
        }
+
+       $index{state}={};
+       foreach my $id (@hookids) {
+               foreach my $key (keys %{$wikistate{$id}}) {
+                       $index{state}{$id}{$key}=$wikistate{$id}{$key};
+               }
+       }
+       
+       $index{version}="3";
        my $ret=Storable::nstore_fd(\%index, $out);
        return if ! defined $ret || ! $ret;
        close $out || error("failed saving to $newfile: $!", $cleanup);
@@ -1390,18 +1460,18 @@ sub saveindex () { #{{{
                error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
        
        return 1;
-} #}}}
+}
 
-sub template_file ($) { #{{{
+sub template_file ($) {
        my $template=shift;
 
        foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
                return "$dir/$template" if -e "$dir/$template";
        }
        return;
-} #}}}
+}
 
-sub template_params (@) { #{{{
+sub template_params (@) {
        my $filename=template_file(shift);
 
        if (! defined $filename) {
@@ -1420,14 +1490,14 @@ sub template_params (@) { #{{{
                @_
        );
        return wantarray ? @ret : {@ret};
-} #}}}
+}
 
-sub template ($;@) { #{{{
+sub template ($;@) {
        require HTML::Template;
        return HTML::Template->new(template_params(@_));
-} #}}}
+}
 
-sub misctemplate ($$;@) { #{{{
+sub misctemplate ($$;@) {
        my $title=shift;
        my $pagebody=shift;
        
@@ -1444,9 +1514,9 @@ sub misctemplate ($$;@) { #{{{
                shift->(page => "", destpage => "", template => $template);
        });
        return $template->output;
-}#}}}
+}
 
-sub hook (@) { # {{{
+sub hook (@) {
        my %param=@_;
        
        if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
@@ -1457,109 +1527,86 @@ sub hook (@) { # {{{
        
        $hooks{$param{type}}{$param{id}}=\%param;
        return 1;
-} # }}}
+}
 
-sub run_hooks ($$) { # {{{
+sub run_hooks ($$) {
        # Calls the given sub for each hook of the given type,
        # passing it the hook function to call.
        my $type=shift;
        my $sub=shift;
 
        if (exists $hooks{$type}) {
-               my @deferred;
+               my (@first, @middle, @last);
                foreach my $id (keys %{$hooks{$type}}) {
-                       if ($hooks{$type}{$id}{last}) {
-                               push @deferred, $id;
-                               next;
+                       if ($hooks{$type}{$id}{first}) {
+                               push @first, $id;
+                       }
+                       elsif ($hooks{$type}{$id}{last}) {
+                               push @last, $id;
+                       }
+                       else {
+                               push @middle, $id;
                        }
-                       $sub->($hooks{$type}{$id}{call});
                }
-               foreach my $id (@deferred) {
+               foreach my $id (@first, @middle, @last) {
                        $sub->($hooks{$type}{$id}{call});
                }
        }
 
        return 1;
-} #}}}
+}
 
-sub rcs_update () { #{{{
+sub rcs_update () {
        $hooks{rcs}{rcs_update}{call}->(@_);
-} #}}}
+}
 
-sub rcs_prepedit ($) { #{{{
+sub rcs_prepedit ($) {
        $hooks{rcs}{rcs_prepedit}{call}->(@_);
-} #}}}
+}
 
-sub rcs_commit ($$$;$$) { #{{{
+sub rcs_commit ($$$;$$) {
        $hooks{rcs}{rcs_commit}{call}->(@_);
-} #}}}
+}
 
-sub rcs_commit_staged ($$$) { #{{{
+sub rcs_commit_staged ($$$) {
        $hooks{rcs}{rcs_commit_staged}{call}->(@_);
-} #}}}
+}
 
-sub rcs_add ($) { #{{{
+sub rcs_add ($) {
        $hooks{rcs}{rcs_add}{call}->(@_);
-} #}}}
+}
 
-sub rcs_remove ($) { #{{{
+sub rcs_remove ($) {
        $hooks{rcs}{rcs_remove}{call}->(@_);
-} #}}}
+}
 
-sub rcs_rename ($$) { #{{{
+sub rcs_rename ($$) {
        $hooks{rcs}{rcs_rename}{call}->(@_);
-} #}}}
+}
 
-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {
        $hooks{rcs}{rcs_recentchanges}{call}->(@_);
-} #}}}
+}
 
-sub rcs_diff ($) { #{{{
+sub rcs_diff ($) {
        $hooks{rcs}{rcs_diff}{call}->(@_);
-} #}}}
+}
 
-sub rcs_getctime ($) { #{{{
+sub rcs_getctime ($) {
        $hooks{rcs}{rcs_getctime}{call}->(@_);
-} #}}}
+}
 
-sub globlist_to_pagespec ($) { #{{{
-       my @globlist=split(' ', shift);
+sub rcs_receive () {
+       $hooks{rcs}{rcs_receive}{call}->();
+}
 
-       my (@spec, @skip);
-       foreach my $glob (@globlist) {
-               if ($glob=~/^!(.*)/) {
-                       push @skip, $glob;
-               }
-               else {
-                       push @spec, $glob;
-               }
-       }
-
-       my $spec=join(' or ', @spec);
-       if (@skip) {
-               my $skip=join(' and ', @skip);
-               if (length $spec) {
-                       $spec="$skip and ($spec)";
-               }
-               else {
-                       $spec=$skip;
-               }
-       }
-       return $spec;
-} #}}}
-
-sub is_globlist ($) { #{{{
-       my $s=shift;
-       return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
-} #}}}
-
-sub safequote ($) { #{{{
+sub safequote ($) {
        my $s=shift;
        $s=~s/[{}]//g;
        return "q{$s}";
-} #}}}
+}
 
-sub add_depends ($$) { #{{{
+sub add_depends ($$) {
        my $page=shift;
        my $pagespec=shift;
        
@@ -1573,9 +1620,9 @@ sub add_depends ($$) { #{{{
        }
 
        return 1;
-} # }}}
+}
 
-sub file_pruned ($$) { #{{{
+sub file_pruned ($$) {
        require File::Spec;
        my $file=File::Spec->canonpath(shift);
        my $base=File::Spec->canonpath(shift);
@@ -1583,9 +1630,9 @@ sub file_pruned ($$) { #{{{
 
        my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
        return $file =~ m/$regexp/ && $file ne $base;
-} #}}}
+}
 
-sub gettext { #{{{
+sub gettext {
        # Only use gettext in the rare cases it's needed.
        if ((exists $ENV{LANG} && length $ENV{LANG}) ||
            (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
@@ -1606,39 +1653,50 @@ sub gettext { #{{{
        else {
                return shift;
        }
-} #}}}
+}
 
-sub yesno ($) { #{{{
+sub yesno ($) {
        my $val=shift;
 
        return (defined $val && lc($val) eq gettext("yes"));
-} #}}}
+}
+
+sub inject {
+       # Injects a new function into the symbol table to replace an
+       # exported function.
+       my %params=@_;
 
-sub pagespec_merge ($$) { #{{{
+       # This is deep ugly perl foo, beware.
+       no strict;
+       no warnings;
+       if (! defined $params{parent}) {
+               $params{parent}='::';
+               $params{old}=\&{$params{name}};
+               $params{name}=~s/.*:://;
+       }
+       my $parent=$params{parent};
+       foreach my $ns (grep /^\w+::/, keys %{$parent}) {
+               $ns = $params{parent} . $ns;
+               inject(%params, parent => $ns) unless $ns eq '::main::';
+               *{$ns . $params{name}} = $params{call}
+                       if exists ${$ns}{$params{name}} &&
+                          \&{${$ns}{$params{name}}} == $params{old};
+       }
+       use strict;
+       use warnings;
+}
+
+sub pagespec_merge ($$) {
        my $a=shift;
        my $b=shift;
 
        return $a if $a eq $b;
-
-        # Support for old-style GlobLists.
-        if (is_globlist($a)) {
-                $a=globlist_to_pagespec($a);
-        }
-        if (is_globlist($b)) {
-                $b=globlist_to_pagespec($b);
-        }
-
        return "($a) or ($b)";
-} #}}}
+}
 
-sub pagespec_translate ($) { #{{{
+sub pagespec_translate ($) {
        my $spec=shift;
 
-       # Support for old-style GlobLists.
-       if (is_globlist($spec)) {
-               $spec=globlist_to_pagespec($spec);
-       }
-
        # Convert spec to perl code.
        my $code="";
        while ($spec=~m{
@@ -1685,9 +1743,9 @@ sub pagespec_translate ($) { #{{{
 
        no warnings;
        return eval 'sub { my $page=shift; '.$code.' }';
-} #}}}
+}
 
-sub pagespec_match ($$;@) { #{{{
+sub pagespec_match ($$;@) {
        my $page=shift;
        my $spec=shift;
        my @params=@_;
@@ -1698,57 +1756,58 @@ sub pagespec_match ($$;@) { #{{{
        }
 
        my $sub=pagespec_translate($spec);
-       return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
+       return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"")
+               if $@ || ! defined $sub;
        return $sub->($page, @params);
-} #}}}
+}
 
-sub pagespec_valid ($) { #{{{
+sub pagespec_valid ($) {
        my $spec=shift;
 
        my $sub=pagespec_translate($spec);
        return ! $@;
-} #}}}
-       
-sub glob2re ($) { #{{{
+}
+
+sub glob2re ($) {
        my $re=quotemeta(shift);
        $re=~s/\\\*/.*/g;
        $re=~s/\\\?/./g;
        return $re;
-} #}}}
+}
 
 package IkiWiki::FailReason;
 
-use overload ( #{{{
+use overload (
        '""'    => sub { ${$_[0]} },
        '0+'    => sub { 0 },
        '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
        fallback => 1,
-); #}}}
+);
 
-sub new { #{{{
+sub new {
        my $class = shift;
        my $value = shift;
        return bless \$value, $class;
-} #}}}
+}
 
 package IkiWiki::SuccessReason;
 
-use overload ( #{{{
+use overload (
        '""'    => sub { ${$_[0]} },
        '0+'    => sub { 1 },
        '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
        fallback => 1,
-); #}}}
+);
 
-sub new { #{{{
+sub new {
        my $class = shift;
        my $value = shift;
        return bless \$value, $class;
-}; #}}}
+};
 
 package IkiWiki::PageSpec;
 
-sub match_glob ($$;@) { #{{{
+sub match_glob ($$;@) {
        my $page=shift;
        my $glob=shift;
        my %params=@_;
@@ -1774,13 +1833,13 @@ sub match_glob ($$;@) { #{{{
        else {
                return IkiWiki::FailReason->new("$glob does not match $page");
        }
-} #}}}
+}
 
-sub match_internal ($$;@) { #{{{
+sub match_internal ($$;@) {
        return match_glob($_[0], $_[1], @_, internal => 1)
-} #}}}
+}
 
-sub match_link ($$;@) { #{{{
+sub match_link ($$;@) {
        my $page=shift;
        my $link=lc(shift);
        my %params=@_;
@@ -1805,16 +1864,20 @@ sub match_link ($$;@) { #{{{
                else {
                        return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
                                if match_glob($p, $link, %params);
+                       $p=~s/^\///;
+                       $link=~s/^\///;
+                       return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
+                               if match_glob($p, $link, %params);
                }
        }
        return IkiWiki::FailReason->new("$page does not link to $link");
-} #}}}
+}
 
-sub match_backlink ($$;@) { #{{{
+sub match_backlink ($$;@) {
        return match_link($_[1], $_[0], @_);
-} #}}}
+}
 
-sub match_created_before ($$;@) { #{{{
+sub match_created_before ($$;@) {
        my $page=shift;
        my $testpage=shift;
 
@@ -1829,9 +1892,9 @@ sub match_created_before ($$;@) { #{{{
        else {
                return IkiWiki::FailReason->new("$testpage has no ctime");
        }
-} #}}}
+}
 
-sub match_created_after ($$;@) { #{{{
+sub match_created_after ($$;@) {
        my $page=shift;
        my $testpage=shift;
 
@@ -1846,33 +1909,90 @@ sub match_created_after ($$;@) { #{{{
        else {
                return IkiWiki::FailReason->new("$testpage has no ctime");
        }
-} #}}}
+}
 
-sub match_creation_day ($$;@) { #{{{
+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 ($$;@) { #{{{
+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 ($$;@) { #{{{
+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_user ($$;@) {
+       shift;
+       my $user=shift;
+       my %params=@_;
+       
+       if (! exists $params{user}) {
+               return IkiWiki::FailReason->new("no user specified");
+       }
+
+       if (defined $params{user} && lc $params{user} eq lc $user) {
+               return IkiWiki::SuccessReason->new("user is $user");
+       }
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");
+       }
+       else {
+               return IkiWiki::FailReason->new("user is $params{user}, not $user");
+       }
+}
+
+sub match_admin ($$;@) {
+       shift;
+       shift;
+       my %params=@_;
+       
+       if (! exists $params{user}) {
+               return IkiWiki::FailReason->new("no user specified");
+       }
+
+       if (defined $params{user} && IkiWiki::is_admin($params{user})) {
+               return IkiWiki::SuccessReason->new("user is an admin");
+       }
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");
+       }
+       else {
+               return IkiWiki::FailReason->new("user is not an admin");
+       }
+}
+
+sub match_ip ($$;@) {
+       shift;
+       my $ip=shift;
+       my %params=@_;
+       
+       if (! exists $params{ip}) {
+               return IkiWiki::FailReason->new("no IP specified");
+       }
+
+       if (defined $params{ip} && lc $params{ip} eq lc $ip) {
+               return IkiWiki::SuccessReason->new("IP is $ip");
+       }
+       else {
+               return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
+       }
+}
 
 1