]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
the 100% correct way is to add it to %links on scan
[git.ikiwiki.info.git] / IkiWiki.pm
index 7c910a53dfe62b6a88c5c7c85714318739c91663..1cfa419b6f614762a580f1e5aa702b4f4ae0d08f 100644 (file)
@@ -69,15 +69,16 @@ 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,
+       account_creation_password => "",
 } #}}}
    
 sub checkconfig () { #{{{
@@ -178,7 +179,7 @@ sub log_message ($$) { #{{{
                        $log_open=1;
                }
                eval {
-                       Sys::Syslog::syslog($type, "%s", join(" ", @_));
+                       Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
                };
        }
        elsif (! $config{cgi}) {
@@ -362,8 +363,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";
@@ -644,12 +651,14 @@ sub preprocess ($$$;$$) { #{{{
        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;
@@ -659,7 +668,8 @@ sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
 
-sub lockwiki () { #{{{
+sub lockwiki (;$) { #{{{
+       my $wait=@_ ? shift : 1;
        # Take an exclusive lock on the wiki to prevent multiple concurrent
        # run issues. The lock will be dropped on program exit.
        if (! -d $config{wikistatedir}) {
@@ -668,15 +678,21 @@ sub lockwiki () { #{{{
        open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
                error ("cannot write to $config{wikistatedir}/lockfile: $!");
        if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB
-               debug("wiki seems to be locked, waiting for lock");
-               my $wait=600; # arbitrary, but don't hang forever to 
-                             # prevent process pileup
-               for (1..$wait) {
-                       return if flock(WIKILOCK, 2 | 4);
-                       sleep 1;
+               if ($wait) {
+                       debug("wiki seems to be locked, waiting for lock");
+                       my $wait=600; # arbitrary, but don't hang forever to 
+                                     # prevent process pileup
+                       for (1..$wait) {
+                               return if flock(WIKILOCK, 2 | 4);
+                               sleep 1;
+                       }
+                       error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
+               }
+               else {
+                       return 0;
                }
-               error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
        }
+       return 1;
 } #}}}
 
 sub unlockwiki () { #{{{
@@ -998,9 +1014,37 @@ sub pagespec_match ($$;@) { #{{{
                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 ($$;@) { #{{{
@@ -1022,7 +1066,12 @@ 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 ($$;@) { #{{{
@@ -1040,13 +1089,14 @@ 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 ($$;@) { #{{{
@@ -1058,10 +1108,15 @@ sub match_created_before ($$;@) { #{{{
        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");
        }
 } #}}}
 
@@ -1070,23 +1125,43 @@ sub match_created_after ($$;@) { #{{{
        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 ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
+       if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+               return IkiWiki::SuccessReason->new("creation_day matched");
+       }
+       else {
+               return IkiWiki::FailReason->new("creation_day did not match");
+       }
 } #}}}
 
 sub match_creation_month ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
+       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 ($$;@) { #{{{
-       return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);
+       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 ($$;@) { #{{{
@@ -1094,8 +1169,13 @@ sub match_user ($$;@) { #{{{
        my $user=shift;
        my %params=@_;
 
-       return unless exists $params{user};
-       return $user eq $params{user};
+       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