]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
* Make testpagespec more robust, including checking for missing/bad
[git.ikiwiki.info.git] / IkiWiki.pm
index 52ae60d403dd2aecbe278e439f6165802880f8c9..1d764bae268896aac2dfc8d0c88fb75ec5c1165b 100644 (file)
@@ -6,19 +6,22 @@ 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 %pagemtime %pagectime %pagecase
-            %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
-           %forcerebuild $gettext_obj};
+            %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 urlto targetpage
-                 %config %links %renderedfiles %pagesources);
-our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
-our $version="1.45";my $installdir="/usr";
+                 %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");
@@ -28,7 +31,8 @@ memoize("file_pruned");
 sub defaultconfig () { #{{{
        wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
                qr/\.x?html?$/, qr/\.ikiwiki-new$/,
-               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
+               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
+               qr/\.dpkg-tmp$/],
        wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/,
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
@@ -65,14 +69,14 @@ sub defaultconfig () { #{{{
        setup => undef,
        adminuser => undef,
        adminemail => undef,
-       plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
+       plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit
                      lockedit conditional}],
        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
        httpauth => 0,
        userdir => "",
-       usedirs => 0,
+       usedirs => 1,
        numbacklinks => 10,
 } #}}}
    
@@ -83,8 +87,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;
@@ -152,7 +154,7 @@ sub error ($;$) { #{{{
                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->();
        }
@@ -176,8 +178,8 @@ sub log_message ($$) { #{{{
                        $log_open=1;
                }
                eval {
-                       Sys::Syslog::syslog($type, "%s", join(" ", @_));
-               }
+                       Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
+               };
        }
        elsif (! $config{cgi}) {
                print "@_\n";
@@ -247,7 +249,7 @@ sub srcfile ($) { #{{{
 
        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 ($;$$) { #{{{
@@ -328,9 +330,13 @@ 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;
 } #}}}
 
 sub bestlink ($$) { #{{{
@@ -356,8 +362,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";
@@ -430,8 +442,6 @@ sub abs2rel ($$) { #{{{
 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(
@@ -455,7 +465,7 @@ sub urlto ($$) { #{{{
                return beautify_url(baseurl($from));
        }
 
-       if (! grep { $_ eq $to } map { @{$_} } values %renderedfiles) {
+       if (! $destsources{$to}) {
                $to=htmlpage($to);
        }
 
@@ -489,18 +499,19 @@ sub htmllink ($$$;@) { #{{{
        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);
-       }
-       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 => $lpage
-                       ).
-                       "\">?</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(htmlpage($page)));
@@ -723,6 +734,7 @@ sub loadindex () { #{{{
                        $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;
@@ -968,38 +980,70 @@ sub pagespec_translate ($) { #{{{
                }
                elsif ($word =~ /^(\w+)\((.*)\)$/) {
                        if (exists $IkiWiki::PageSpec::{"match_$1"}) {
-                               $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \$from)";
+                               $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
                        }
                        else {
                                $code.=" 0";
                        }
                }
                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";
+       }
 
-       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;
 
-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!/?[^/]+$!!;
@@ -1012,16 +1056,20 @@ sub match_glob ($$$) { #{{{
        $glob=~s/\\\*/.*/g;
        $glob=~s/\\\?/./g;
 
-       return $page=~/^$glob$/i;
+       if ($page=~/^$glob$/i) {
+               return IkiWiki::SuccessReason->new("$glob matches $page");
+       }
+       else {
+               return IkiWiki::FailReason->new("$glob does not match $page");
+       }
 } #}}}
 
-sub match_link ($$$) { #{{{
+sub match_link ($$;@) { #{{{
        my $page=shift;
        my $link=lc(shift);
-       my $from=shift;
-       if (! defined $from){
-               $from = "";
-       }
+       my %params=@_;
+
+       my $from=exists $params{location} ? $params{location} : "";
 
        # relative matching
        if ($link =~ m!^\.! && defined $from) {
@@ -1031,53 +1079,93 @@ sub match_link ($$$) { #{{{
        }
 
        my $links = $IkiWiki::links{$page} or return undef;
-       return 0 unless @$links;
+       return IkiWiki::FailReason->new("$page has no links") unless @$links;
        my $bestlink = IkiWiki::bestlink($from, $link);
-       return 0 unless length $bestlink;
+       return IkiWiki::FailReason->new("no such link") unless length $bestlink;
        foreach my $p (@$links) {
-               return 1 if $bestlink eq IkiWiki::bestlink($page, $p);
+               return IkiWiki::SuccessReason->new("$page links to $link")
+                       if $bestlink eq IkiWiki::bestlink($page, $p);
        }
-       return 0;
+       return IkiWiki::FailReason->new("$page does not link to $link");
 } #}}}
 
-sub match_backlink ($$$) { #{{{
-       match_link($_[1], $_[0], $_[3]);
+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}) {
-               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 {
-               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}) {
+                       IkiWiki::SuccessReason->new("$page created after $testpage");
+               }
+               else {
+                       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